首页 文章

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

提问于
浏览 次
146

我有一个托管在Windows服务中的WCF服务 . 使用此服务的客户端必须在每次调用服务方法时传递标识符（因为该标识符对于被调用方法应该执行的操作非常重要） . 我认为以某种方式将此标识符放入WCF头信息是个好主意 .

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

UPDATE: 使用WCF服务的客户端是Windows应用程序和Windows Mobile应用程序（使用Compact Framework） .

wcf

12 回答

  • 75

    The advantage to this is that it is applied to every call.

    创建一个实现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;
}

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

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

    这是你的想法吗？

    Update: 我发现了紧凑框架支持的这个list WCF功能 . 我相信消息检查员被归类为'Channel Extensibility'，根据这篇文章，紧凑框架支持 are .

    回复于
  • 0

    您可以使用以下方法将其添加到呼叫

    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");
    回复于
  • 33

    如果您只想为服务的所有请求添加相同的标头，您可以不使用任何编码！
    只需在客户端配置文件的 endpoints 节点下添加头部节点和必需的头

    <client>  
  <endpoint address="http://localhost/..." >  
    <headers>  
      <HeaderName>Value</HeaderName>  
    </headers>   
 </endpoint>
    回复于
  • 1

    这是另一个有用的解决方案，使用 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... 
}
    回复于
  • 11

    这类似于NimsDotNet的答案，但显示了如何以编程方式执行此操作 .

    只需将 Headers 添加到绑定即可

    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();
    回复于
  • 8
    var endpoint = new EndpointAddress(new Uri(RemoteAddress),
                                               new[]
                                                   {
                                                       AddressHeader.CreateAddressHeader("APIKey", "",
                                                                                         "bda11d91-7ade-4da1-855d-24adfe39d174")
                                                   });
    回复于
  • 5

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

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

    回复于
  • 2

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

    回复于
  • 1

    如果我理解你的要求，那么简单的答案就是：你做不到 .

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

    IF 您可以控制服务的客户端，您可以创建一个基本客户端类，添加所需的头并继承工作类的行为 .

    回复于
  • 3

    这对我有用，改编自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());
    回复于
  • 2

    这对我有用

    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);
                }
    回复于
  • 163

    派对有点晚，但Juval Lowy在他的book以及相关的ServiceModelEx库中解决了这个问题 .

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

    约翰

    回复于

相关问题