如何为每个 WCF 调用添加自定义 HTTP 标头？

Question

我有一个托管在 Windows 服务中的 WCF 服务。使用此服务的客户端每次调用服务方法时都必须传递一个标识符（因为该标识符对于调用的方法应该做什么很重要）。我认为以某种方式将此标识符放在 WCF 标头信息中是个好主意。

如果这是个好主意，如何将标识符自动添加到标题信息中。换句话说，每当用户调用 WCF 方法时，必须将标识符自动添加到标头中。

更新： 使用 WCF 服务的客户端是 Windows 应用程序和 Windows Mobile 应用程序（使用 Compact Framework）。

Answer 1

这样做的好处是它适用于每个调用。

创建一个实现IClientMessageInspector 的类。在 BeforeSendRequest 方法中，将您的自定义标头添加到传出消息中。它可能看起来像这样：

public object BeforeSendRequest(ref System.ServiceModel.Channels.Message request, System.ServiceModel.IClientChannel channel)
{
    HttpRequestMessageProperty httpRequestMessage;
    object httpRequestMessageObject;
    if (request.Properties.TryGetValue(HttpRequestMessageProperty.Name, out httpRequestMessageObject))
    {
        httpRequestMessage = httpRequestMessageObject as HttpRequestMessageProperty;
        if (string.IsNullOrEmpty(httpRequestMessage.Headers[USER_AGENT_HTTP_HEADER]))
        {
            httpRequestMessage.Headers[USER_AGENT_HTTP_HEADER] = this.m_userAgent;
        }
    }
    else
    {
        httpRequestMessage = new HttpRequestMessageProperty();
        httpRequestMessage.Headers.Add(USER_AGENT_HTTP_HEADER, this.m_userAgent);
        request.Properties.Add(HttpRequestMessageProperty.Name, httpRequestMessage);
    }
    return null;
}

然后创建一个端点行为，将消息检查器应用于客户端运行时。您可以通过属性或使用行为扩展元素的配置来应用行为。

这是一个很棒的example，介绍了如何将 HTTP 用户代理标头添加到所有请求消息中。我在我的一些客户中使用它。您也可以通过实现IDispatchMessageInspector 在服务端执行相同的操作。

这是你的想法吗？

更新：我发现了这个紧凑框架支持的 WCF 功能list。我相信归类为“通道可扩展性”的消息检查器，根据这篇文章， 受到紧凑框架的支持。

Answer 2

您将其添加到调用中：

using (OperationContextScope scope = new OperationContextScope((IContextChannel)channel))
{
    MessageHeader<string> header = new MessageHeader<string>("secret message");
    var untyped = header.GetUntypedHeader("Identity", "http://www.my-website.com");
    OperationContext.Current.OutgoingMessageHeaders.Add(untyped);

    // now make the WCF call within this using block
}

然后，你在服务器端使用：

MessageHeaders headers = OperationContext.Current.IncomingMessageHeaders;
string identity = headers.GetHeader<string>("Identity", "http://www.my-website.com");

Answer 3

如果您只想为服务的所有请求添加相同的标头，则无需任何编码即可完成！
只需在客户端配置文件的端点节点下添加带有所需标头的标头节点

<client>  
  <endpoint address="http://localhost/..." >  
    <headers>  
      <HeaderName>Value</HeaderName>  
    </headers>   
 </endpoint>  

Answer 4

这是使用ChannelFactory 作为代理手动将自定义 HTTP 标头添加到客户端 WCF 请求的另一个有用的解决方案。这必须为每个请求完成，但如果您只需要对代理进行单元测试以准备用于非 .NET 平台，这足以作为一个简单的演示。

// create channel factory / proxy ...
using (OperationContextScope scope = new OperationContextScope(proxy))
{
    OperationContext.Current.OutgoingMessageProperties[HttpRequestMessageProperty.Name] = new HttpRequestMessageProperty()
    {
        Headers = 
        { 
            { "MyCustomHeader", Environment.UserName },
            { HttpRequestHeader.UserAgent, "My Custom Agent"}
        }
    };    
    // perform proxy operations... 
}

Answer 5

这类似于 NimsDotNet 答案，但显示了如何以编程方式进行。

只需将标题添加到绑定中

var cl = new MyServiceClient();

var eab = new EndpointAddressBuilder(cl.Endpoint.Address);

eab.Headers.Add( 
      AddressHeader.CreateAddressHeader("ClientIdentification",  // Header Name
                                         string.Empty,           // Namespace
                                         "JabberwockyClient"));  // Header Value

cl.Endpoint.Address = eab.ToEndpointAddress();

Answer 6

如果您想以面向对象的方式向每个 WCF 调用添加自定义 HTTP 标头，请不要再犹豫了。

就像 Mark Good 和 paulwhit 的回答一样，我们需要继承 IClientMessageInspector 以将自定义 HTTP 标头注入 WCF 请求。但是，让我们通过接受包含我们要添加的标题的字典来使检查器更通用：

public class HttpHeaderMessageInspector : IClientMessageInspector
{
    private Dictionary<string, string> Headers;

    public HttpHeaderMessageInspector(Dictionary<string, string> headers)
    {
        Headers = headers;
    }

    public object BeforeSendRequest(ref Message request, IClientChannel channel)
    {
        // ensure the request header collection exists
        if (request.Properties.Count == 0 || request.Properties[HttpRequestMessageProperty.Name] == null)
        {
            request.Properties.Add(HttpRequestMessageProperty.Name, new HttpRequestMessageProperty());
        }

        // get the request header collection from the request
        var HeadersCollection = ((HttpRequestMessageProperty)request.Properties[HttpRequestMessageProperty.Name]).Headers;

        // add our headers
        foreach (var header in Headers) HeadersCollection[header.Key] = header.Value;

        return null;
    }

    // ... other unused interface methods removed for brevity ...
}

就像 Mark Good 和 paulwhit 的回答一样，我们需要继承 IEndpointBehavior 以将 HttpHeaderMessageInspector 注入我们的 WCF 客户端。

public class AddHttpHeaderMessageEndpointBehavior : IEndpointBehavior
{
    private IClientMessageInspector HttpHeaderMessageInspector;

    public AddHttpHeaderMessageEndpointBehavior(Dictionary<string, string> headers)
    {
        HttpHeaderMessageInspector = new HttpHeaderMessageInspector(headers);
    }

    public void ApplyClientBehavior(ServiceEndpoint endpoint, ClientRuntime clientRuntime)
    {
        clientRuntime.ClientMessageInspectors.Add(HttpHeaderMessageInspector);
    }

    // ... other unused interface methods removed for brevity ...
}

完成面向对象方法的最后一部分是创建 WCF 自动生成客户端的子类（我使用 Microsoft 的 WCF Web Service Reference Guide 生成 WCF 客户端）。

就我而言，我需要将 API 密钥附加到 x-api-key HTML 标头。

子类执行以下操作：

• 使用所需参数调用基类的构造函数（在我的例子中，生成了一个 EndpointConfiguration 枚举以传递给构造函数 - 也许你的实现不会有这个）
• 定义应附加到每个请求的标头
• 将AddHttpHeaderMessageEndpointBehavior 附加到客户端的Endpoint 行为

public class Client : MySoapClient
{
    public Client(string apiKey) : base(EndpointConfiguration.SomeConfiguration)
    {
        var headers = new Dictionary<string, string>
        {
            ["x-api-key"] = apiKey
        };

        var behaviour = new AddHttpHeaderMessageEndpointBehavior(headers);
        Endpoint.EndpointBehaviors.Add(behaviour);
    }
}

最后，使用你的客户端！

var apiKey = 'XXXXXXXXXXXXXXXXXXXXXXXXX';
var client = new Client (apiKey);
var result = client.SomeRequest()

生成的 HTTP 请求应包含您的 HTTP 标头，如下所示：

POST http://localhost:8888/api/soap HTTP/1.1
Cache-Control: no-cache, max-age=0
Connection: Keep-Alive
Content-Type: text/xml; charset=utf-8
Accept-Encoding: gzip, deflate
x-api-key: XXXXXXXXXXXXXXXXXXXXXXXXX
SOAPAction: "http://localhost:8888/api/ISoapService/SomeRequest"
Content-Length: 144
Host: localhost:8888

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <SomeRequestxmlns="http://localhost:8888/api/"/>
  </s:Body>
</s:Envelope>

Answer 7

这对我有用，改编自Adding HTTP Headers to WCF Calls

// Message inspector used to add the User-Agent HTTP Header to the WCF calls for Server
public class AddUserAgentClientMessageInspector : IClientMessageInspector
{
    public object BeforeSendRequest(ref System.ServiceModel.Channels.Message request, IClientChannel channel)
    {
        HttpRequestMessageProperty property = new HttpRequestMessageProperty();

        var userAgent = "MyUserAgent/1.0.0.0";

        if (request.Properties.Count == 0 || request.Properties[HttpRequestMessageProperty.Name] == null)
        {
            var property = new HttpRequestMessageProperty();
            property.Headers["User-Agent"] = userAgent;
            request.Properties.Add(HttpRequestMessageProperty.Name, property);
        }
        else
        {
            ((HttpRequestMessageProperty)request.Properties[HttpRequestMessageProperty.Name]).Headers["User-Agent"] = userAgent;
        }
        return null;
    }

    public void AfterReceiveReply(ref System.ServiceModel.Channels.Message reply, object correlationState)
    {
    }
}

// Endpoint behavior used to add the User-Agent HTTP Header to WCF calls for Server
public class AddUserAgentEndpointBehavior : IEndpointBehavior
{
    public void ApplyClientBehavior(ServiceEndpoint endpoint, ClientRuntime clientRuntime)
    {
        clientRuntime.MessageInspectors.Add(new AddUserAgentClientMessageInspector());
    }

    public void AddBindingParameters(ServiceEndpoint endpoint, BindingParameterCollection bindingParameters)
    {
    }

    public void ApplyDispatchBehavior(ServiceEndpoint endpoint, EndpointDispatcher endpointDispatcher)
    {
    }

    public void Validate(ServiceEndpoint endpoint)
    {
    }
}

声明这些类后，您可以将新行为添加到您的 WCF 客户端，如下所示：

client.Endpoint.Behaviors.Add(new AddUserAgentEndpointBehavior());

Answer 8

var endpoint = new EndpointAddress(new Uri(RemoteAddress),
               new[] { AddressHeader.CreateAddressHeader(
                       "APIKey", 
                       "",
                       "bda11d91-7ade-4da1-855d-24adfe39d174") 
                     });

Answer 9

这对我有用

TestService.ReconstitutionClient _serv = new TestService.TestClient();

using (OperationContextScope contextScope = new OperationContextScope(_serv.InnerChannel))
{
   HttpRequestMessageProperty requestMessage = new HttpRequestMessageProperty();

   requestMessage.Headers["apiKey"] = ConfigurationManager.AppSettings["apikey"]; 
   OperationContext.Current.OutgoingMessageProperties[HttpRequestMessageProperty.Name] = 
      requestMessage;
   _serv.Method(Testarg);
}

Answer 10

.NET 3.5 中的上下文bindings 可能正是您正在寻找的。有三个开箱即用：BasicHttpContextBinding、NetTcpContextBinding 和 WSHttpContextBinding。上下文协议基本上在消息头中传递键值对。查看 MSDN 杂志上的 Managing State With Durable Services 文章。

Answer 11

如果我正确理解您的要求，简单的答案是：您不能。

这是因为 WCF 服务的客户端可能由使用您的服务的任何第三方生成。

如果您可以控制服务的客户端，则可以创建一个基客户端类，添加所需的标头并继承工作类的行为。

Answer 12

您可以在MessageContract 中指定自定义标头。

您也可以使用< endpoint> headers，它们存储在配置文件中，并将被复制到客户端/服务发送的所有消息的标头中。这对于轻松添加一些静态标题很有用。

Answer 13

找到另一种方法here：

SoapServiceClient client = new SoapServiceClient();
using(new OperationContextScope(client.InnerChannel)) 
{
    HttpRequestMessageProperty requestMessage = new HttpRequestMessageProperty();
    requestMessage.Headers["MyHttpHeader"] = "MyHttpHeaderValue";
    OperationContext.Current.OutgoingMessageProperties[HttpRequestMessageProperty.Name] = requestMessage;    
    var result = client.MyClientMethod();
}

Answer 14

聚会有点晚了，但 Juval Lowy 在他的 book 和相关的 ServiceModelEx 库中解决了这个确切的场景。

基本上，他定义了允许指定类型安全标头值的 ClientBase 和 ChannelFactory 特化。我建议下载源代码并查看 HeaderClientBase 和 HeaderChannelFactory 类。

约翰