在C＃中是否有更好的自定义SOAP标头的方法

Question

过去，我需要在使用导入的WSDL Web参考的C＃项目中创建自定义SOAP标头。 我找到了一种方法来做，但是我从不满意，我想知道是否有更好的方法。 我所做的是创建一个从SoapHeader派生的头文件：

[System.Xml.Serialization.XmlTypeAttribute(Namespace = "http://model.test.net")]
[System.Xml.Serialization.XmlRootAttribute("securitytoken", Namespace = "http://model.test.net", IsNullable = false)]
public class SpecialHeader : SoapHeader
{ 
  [System.Xml.Serialization.XmlTextAttribute()]
  public string aheadervalue;
}

然后，我不得不修改从WSDL生成的代码，并在每个要包含自定义标头的Web调用之前，将引用添加到新标头的实例以及以下内容：

[System.Web.Services.Protocols.SoapHeaderAttribute("instancename", Direction=System.Web.Services.Protocols.SoapHeaderDirection.InOut)]

其中“ instancename”是生成的类中的自定义标头的实例变量名称。

除WSDL中的任何更改都需要重新进行所有操作（因为它重新生成了类）外，此方法工作正常。 在其他语言中，标头可以添加到生成的代码之外，因此也许我错过了在C＃中完成的方式。 有更好的方法吗？

Answer 1

看来您正在使用.Net 2.0和asmx Web服务。 您是否知道.Net 3.0中有一个称为WCF（Windows通信框架）的框架。 我知道迁移到新框架并不容易，但是有了WCF，您将收获很多。 此外，WCf可以用于WebServices之外（远程处理，msmq等）。 这是Microsoft未来所寄望的框架。 就是 使用MessageContracts完成soap标头的操作。

因此答案是，在WCF中，您可以使用MessageContracts进行此操作。

Answer 2

因为生成的类是局部类。 您可以在另一个具有相同名称空间和类名称的文件（再次是部分类）上定义它。 然后，您可以覆盖其虚拟方法并对其进行一次定义。

这样可以防止对重新生成的类进行进一步的更改不会影响您编写的类。

在新的类文件上，可以使用“ GetWriterForMessage”覆盖并向其中添加新的SOAP标头。

public partial class SampleService
{
    public string MessageID { get; set; }

    protected override System.Xml.XmlWriter GetWriterForMessage(System.Web.Services.Protocols.SoapClientMessage message, int bufferSize)
    {
        message.Headers.Add(new UsernameSoapHeader("Username"));
        message.Headers.Add(new PasswordSoapHeader("Password"));
        message.Headers.Add(new MessageIDSoapHeader(MessageID));
        return base.GetWriterForMessage(message, bufferSize);
    }
}

Answer 3

有一种方法可以做到； 它不一定很漂亮，并且在非常简单的Web服务上可能不值得付出努力，但是至少可以避免重新生成代码时必须重新添加属性的麻烦。

由于生成器生成部分类，因此您可以：

1. 将一个文件添加到您的项目，该文件使用另一个“部分”部分（即，使用与生成的类相同的名称空间和名称，并将其标记为“部分”）来扩展Web服务类（从SoapHttpClientProtocol派生的类）。

2. 从生成的代码中复制要添加标头的方法（即，您已经向其添加属性的相同方法），然后将其粘贴到扩展部分中。

3. 稍微重命名这些方法，以免它们与生成的代码中的方法发生冲突，然后更改传递给Invoke的名称以进行匹配。 （您可能还必须调整方法上的其他属性，以确保它们仍然映射到WSDL中的正确调用。）

4. 将自定义标头属性添加到重命名的方法中，并将标头实例字段添加到扩展部分中。

5. 从您的代码而不是原始版本中调用重命名的版本。

只要WSDL中的方法签名不变，即使重新生成代码，也无需更改代码中的任何内容。 （由于您仅复制了相对较短的方法实现，因此WSDL中的任何其他结构仍然会从生成的代码中出现，因此，如果它们更改，您将在重新生成时自动获得更新的版本。具有任何其他结构，其实用性可能会受到限制。）

它仍然不是理想的，但是缺少尝试截取原始XML消息并将标头直接放入（您可能会这样做，但这很讨厌），我实际上没有其他任何选择（无需移动）转到WCF）。

Answer 4

我今天遇到了这个问题。 我结束了创建一个从自动生成的类派生的类，并重写GetWriterForMessage方法以确保我的标头始终存在。 我将在每次调用该方法时更新标头值。