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

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

UPDATE：
使用WCF服务的客户端既是Windows应用程序，也是Windows Mobile。应用程序（使用Compact Framework）。

评论

您最终使它在Compact Framework上起作用了吗？
请参阅：blogs.msdn.microsoft.com/wsdevsol/2014/02/07/…

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

然后创建一个端点行为，将消息检查器应用于客户端运行时。您可以通过属性或使用行为扩展元素的配置来应用行为。
这是一个如何向所有请求消息添加HTTP用户代理标头的好例子。我在一些客户中使用它。您还可以通过实现IDispatchMessageInspector在服务端执行相同的操作。
这是您要记住的吗？
更新：我发现了紧凑框架支持的WCF功能列表。我相信消息检查器归类为“通道扩展性”，根据这篇文章，该检查器受紧凑框架的支持。

评论

谢谢。这正是我想要的，但是它可以在紧凑的框架中工作吗？

– mrtaikandi
09年9月12日在8:25
@Mark，这是一个非常好的答案。谢谢。我已经在net.tcp上尝试过此方法，但是直接使用Headers集合（Http Headers无效）。我在ServiceHost AfterReceiveRequest事件中获得带有标头（Name）的标头，但没有值（甚至似乎不是值的属性吗？）。我有什么想念的吗？我希望有一个名称/值对，因为当我创建请求我的标题时：request.Headers.Add（MessageHeader.CreateHeader（name，ns，value））;

– Program.X
09年12月16日在15:13
+1 OutgoingMessageProperties是访问HTTP标头所需的-而不是作为SOAP标头的OutgoingMessageHeaders。

– SliverNinja-MSFT
2012年1月25日16:30
这仅允许使用硬编码的用户代理，根据给定的示例，该代理在web.config中是硬编码的！

– KristianB
2012年10月10日7:47
这是一个很好的答案。它还处理消息属性中HttpRequestMessageProperty.Name尚不可用的情况。由于某种原因，调试我的代码后，我意识到根据某些时序问题，此值并不总是存在的。谢谢马克！

–carlos357
18年4月13日在7:42

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


评论

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

– mrtaikandi
09年6月8日在11:36
这是一个很好的MSDN链接，并带有示例以扩展此答案中提供的建议：msdn.microsoft.com/en-us/library/…

– atconway
2012年11月2日在20:22
谢谢，如果您使用的是自定义客户端库，那么这是一段很棒的代码。这样，您无需实现messageinspector。只需创建一个通用的包装方法即可将每个客户端调用包装在OperationContextScope中。

– JustAMartin
13年2月18日在17:27
需要注意的是，如果您要在调用中进行任何形式的异步处理，这是有问题的，因为OperationContextScope（和OperationContext）是ThreadStatic-Mark Good的答案可以在不依赖ThreadStatic项的情况下工作。

– Zimdanen
2014年4月11日，下午1:27
这不会添加HTTP标头！它将标头添加到SOAP信封。

–br3nt
3月16日22:33

#3 楼

如果仅要将相同的标头添加到对服务的所有请求中，则无需任何编码即可做到！
只需在客户端配置文件中的端点节点下添加标头节点和必需的标头

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


评论

这些是SOAP标头（ala MessageHeader）-不是HTTP标头。

– SliverNinja-MSFT
2012年1月25日在16:28

#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... 
}


评论

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

–JohnOpincar
19年8月6日在21:10
实际上，这会添加HTTP标头，谢谢！ :)但是，它看起来很丑陋。

–br3nt
3月16日22:34


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


评论

我将此代码添加到当前调用中（客户端）..如何在System.ServiceModel.OperationContext中获得此头值？ （服务器端）（我指责这将对我有帮助）

– granadaCoder
16年7月18日在20:30
得到它了 ！ System.ServiceModel.Channels.MessageHeaders标头= operationContext.RequestContext.RequestMessage.Headers; int headerIndex = headers.FindHeader（“ ClientIdentification”，string.Empty）; var requestName =（headerIndex <0）？ “ UNKNOWN”：headers.GetHeader <字符串>（headerIndex）;

– granadaCoder
16年7月18日在21:45
这会将标头添加到SOAP信封，而不是HTTP标头

–br3nt
3月16日22:37

#6 楼

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


评论

这是SOAP消息标头，而不是HTTP标头。

–René
2012年5月30日上午10:15

#7 楼

这对我有用

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


#8 楼

这是对我有用的方法，从将HTTP标头添加到WCF调用

// 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客户端： br /> 
client.Endpoint.Behaviors.Add(new AddUserAgentEndpointBehavior());


评论

无法编译：错误CS0136无法在此范围内声明名为“属性”的本地或参数，因为该名称在封闭的本地范围内用于定义本地或参数。

–Leszek P
17年4月25日在15:29
只是删除一个不使用的

–科森科夫
19/12/2在7:22

#9 楼

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

评论

还要注意，在与服务器建立会话之前，只设置一次上下文。然后，上下文变为只读。如果您希望上下文设置在客户端是透明的，则可以派生自客户端proxt类，在构造函数中，您可以添加构成上下文的信息。然后，每次客户端创建客户端代理的实例时，都会自动创建上下文并将其添加到客户端代理实例。

–穆罕默德·阿拉斯（Mehmet Aras）
09年6月8日在11:45

#10 楼

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

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

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

评论

同意，如果您真正在构建SOA，则不能假定所有客户端都基于.NET。等到您的业务被收购。

– SliverNinja-MSFT
2012年1月25日在16:27
这是真的吗？ Java Web服务客户端不能将名称/值添加到SOAP标头中吗？我觉得很难相信。当然，这将是一个不同的实现，但这是一个可互操作的解决方案

–亚当
2012年8月9日在20:33

#11 楼

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

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

评论

这些是SOAP标头（ala MessageHeader）-不是HTTP标头。

– SliverNinja-MSFT
2012年1月25日在16:28

#12 楼

如果要以面向对象的方式向每个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客户端）。

我需要附加一个x-api-key HTML标头的API密钥。

子类执行以下操作：


用必需的参数调用基类的构造函数（在我的情况下为EndpointConfiguration枚举已生成并传递到构造函数中-可能您的实现中没有这个）
定义应附加到每个请求的标头
将AddHttpHeaderMessageEndpointBehavior附加到客户端的q4312079 q行为

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>


#13 楼

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

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

约翰

评论

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

–莫妮卡基金的诉讼
15年4月28日在12:30


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

–BrizzleOwl
2015年4月29日14:37


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

–莫妮卡基金的诉讼
2015年4月29日14:39


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

–BrizzleOwl
15年4月29日在14:42
我并不是说这是一个坏指针。我的意思是，这不是一个好答案。这可能很好地帮助了人们，这是一件好事，但是如果您可以描述他使用的方法，而不是对所涉及的类进行非常简短的描述，那么答案会更好。这样，在由于某种原因而无法访问该站点的情况下，您的答案仍然会有所帮助。

–莫妮卡基金的诉讼
2015年4月29日14:44