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


162

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

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

更新: 使用WCF服务的客户端是Windows应用程序和Windows Mobile应用程序(使用Compact Framework)。


1
您能解决您的问题吗?
Mark Good

您最终使它在Compact Framework上起作用了吗?
瓦卡诺

Answers:


185

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

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

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

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

这就是您的想法吗?

更新: 我找到了紧凑框架支持的WCF功能列表。我相信消息检查器被归类为“通道可扩展性”,根据这篇文章,由紧凑框架支持。


2
@Mark,这是一个非常好的答案。谢谢。我已经在net.tcp上尝试过此方法,但是直接使用Headers集合(Http Headers无效)。我在ServiceHost AfterReceiveRequest事件中获得带有标头(Name)的标头,但没有值(似乎还没有值的属性?)。我有什么想念的吗?我希望有一个名称/值对,因为当我创建请求我的标题时:request.Headers.Add(MessageHeader.CreateHeader(name,ns,value));
Program.X

13
+1 OutgoingMessageProperties是访问HTTP OutgoingMessageHeaders标头所需要的-而不是SOAP标头。
SliverNinja-MSFT 2012年

1
简单来说,很棒的代码!:)
abhilashca 2012年

3
这仅允许使用硬编码的用户代理,根据给定的示例,该代理在web.config中是硬编码的!
KristianB

1
这是一个很好的答案。当消息属性中HttpRequestMessageProperty.Name尚不可用时,它也可以处理这种情况。由于某种原因,调试我的代码后,我意识到根据某些时序问题,此值并不总是存在的。谢谢马克!
carlos357 '18

80

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

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");

5
感谢您的代码段。但是与此相关的是,每次我要调用方法时,都必须添加标头。我想使此过程透明。我的意思是实现一次,每次用户创建服务客户端并使用一种方法时,客户标头都会自动添加到消息中。
mrtaikandi

这是一个例子一个很好的MSDN链接,在这个答案中的建议扩大:msdn.microsoft.com/en-us/library/...
atconway

1
谢谢,如果您使用的是自定义客户端库,那么这是一段很棒的代码。这样,您无需实现messageinspector。只需创建一个通用的包装方法即可将每个客户端调用包装在OperationContextScope中。
JustAMartin

3
作为一个说明,如果你做任何形式的异步东西与你的电话,因为这是有问题的OperationContextScope(和OperationContext)是ThreadStatic- 马克良好的答案,而不依赖于工作ThreadStatic的项目。
zimdanen 2014年

2
这不会添加HTTP标头!它将标头添加到SOAP信封。
br3nt

32

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

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

18
这些是SOAP标头(alaMessageHeader)-不是HTTP标头。
SliverNinja-MSFT 2012年

18

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

1
我尝试了其他4个外观相似的建议,这是唯一对我有用的建议。
-JohnOpincar,

实际上,这会添加HTTP标头,谢谢!:)但是,它看起来很丑陋。
br3nt

11

这类似于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();

我将此代码添加到当前调用中(客户端)..如何在System.ServiceModel.OperationContext中获得此头值?(服务器端)(我用手指
指望

1
得到它了 !System.ServiceModel.Channels.MessageHeaders标头= operationContext.RequestContext.RequestMessage.Headers; int headerIndex = headers.FindHeader(“ ClientIdentification”,string.Empty); var requestName =(headerIndex <0)?“ UNKNOWN”:headers.GetHeader <字符串>(headerIndex);
granadaCoder

1
@granadaCoder我喜欢那个网站!;-)
ΩmegaMan

这会将标头添加到SOAP信封中,而不是HTTP标头中
-br3nt

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

12
这是SOAP消息标头,而不是HTTP标头。
勒内2012年

3

这是对我有用的方法,改编自向WCF调用添加HTTP标头

// 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());

这将无法编译:错误CS0136无法在此范围中声明名为“属性”的本地或参数,因为该名称在封闭的本地范围中用于定义本地或参数。
Leszek P

只需删除一个不使用的
kosnkov

3

这对我有用

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);
}

2

.NET 3.5中的上下文绑定可能正是您想要的。现成的有三种:BasicHttpContextBinding,NetTcpContextBinding和WSHttpContextBinding。上下文协议基本上在消息头中传递键值对。在MSDN杂志上查阅“ 使用耐用服务管理状态 ”一文。


还要注意,在与服务器建立会话之前,只设置一次上下文。然后,上下文变为只读。如果希望上下文设置在客户端是透明的,则可以从客户端proxt类派生,并且可以在构造函数中添加组成上下文的信息。然后,每次客户端创建客户端代理的实例时,都会自动创建上下文并将其添加到客户端代理实例。
穆罕默德·阿拉斯(Mohmet Aras)”

2

如果我正确理解了您的要求,那么简单的答案就是:您不能。

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

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


1
同意,如果您真正在构建SOA,则不能假定所有客户端都基于.NET。等待您的业务被收购。
SliverNinja-MSFT 2012年

2
这是真的吗?Java Web服务客户端不能将名称/值添加到SOAP标头中吗?我觉得很难相信。当然,这将是一个不同的实现,但这是一个可互操作的解决方案
Adam


0

如果要以面向对象的方式向每个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服务参考指南》来生成WCF客户端)。

就我而言,我需要将API密钥附加到x-api-keyHTML标头。

子类执行以下操作:

  • 使用所需的参数调用基类的构造函数(在我的情况下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>

-1

晚会晚了一点,但是Juval Lowy在他的和相关的ServiceModelEx库中解决了这个确切的情况。

基本上,他定义了ClientBase和ChannelFactory专业化,可以指定类型安全的标头值。我建议下载源代码并查看HeaderClientBase和HeaderChannelFactory类。

约翰


1
除了促进某人的工作外,这几乎不算什么。您能否添加相关的摘录/算法-即回答问题-或透露您的任何隶属关系?否则,这只是垃圾邮件。
基金莫妮卡的诉讼

我要说的是,它通过某人可能不知道的方法的指针来给出答案。我已经给出了相关链接,为什么我需要添加更多链接?全部在参考文献中。而且我确信Juval Lowy可以比我做得更好的描述:-)至于我的从属关系-我买了这本书!而已。我从未见过Lowy先生,但我确信他是个很棒的家伙。显然对WCF知道很多;-)
BrizzleOwl

您应该添加更多内容,因为大概您在回答之前已经阅读了“ 如何回答”,并且您注意到了“始终引用重要链接中最相关的部分,以防目标站点无法访问或永久脱机的情况”这一节。您的隶属关系并不重要。只有答案的质量是。
基金莫妮卡的诉讼

精细。我的分数不高-从我的分数中可以看出来!只是认为这可能是有用的指针。
BrizzleOwl 2015年

1
我并不是说这是一个坏指针。我是说,这不是一个好答案。这可能对人们很有帮助,这是一件好事,但是如果您可以描述他使用的方法,而不是对所涉及的类进行非常简短的描述,那么答案会更好。这样,在由于某种原因而无法访问该站点的情况下,您的答案仍然会有所帮助。
Fund Monica的诉讼
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.