我有Windows服务中托管的WCF服务。使用此服务的客户每次调用服务方法时都必须传递一个标识符(因为该标识符对于被调用方法应该做什么很重要)。我认为以某种方式将此标识符放入WCF标头信息中是一个好主意。
如果是个好主意,如何将标识符自动添加到标题信息中。换句话说,每当用户调用WCF方法时,都必须将标识符自动添加到标头中。
更新: 使用WCF服务的客户端是Windows应用程序和Windows Mobile应用程序(使用Compact Framework)。
我有Windows服务中托管的WCF服务。使用此服务的客户每次调用服务方法时都必须传递一个标识符(因为该标识符对于被调用方法应该做什么很重要)。我认为以某种方式将此标识符放入WCF标头信息中是一个好主意。
如果是个好主意,如何将标识符自动添加到标题信息中。换句话说,每当用户调用WCF方法时,都必须将标识符自动添加到标头中。
更新: 使用WCF服务的客户端是Windows应用程序和Windows Mobile应用程序(使用Compact Framework)。
Answers:
这样做的好处是它适用于每个呼叫。
创建一个实现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功能列表。我相信消息检查器被归类为“通道可扩展性”,根据这篇文章,它由紧凑框架支持。
OutgoingMessageProperties
是访问HTTP OutgoingMessageHeaders
标头所需要的-而不是SOAP标头。
您可以使用以下方法将其添加到呼叫中:
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");
OperationContextScope
(和OperationContext
)是ThreadStatic
- 马克良好的答案,而不依赖于工作ThreadStatic
的项目。
如果您只想向服务的所有请求添加相同的标头,则无需任何编码即可完成!
只需在客户端配置文件中的终结点节点下添加带有必需标头的标头节点
<client>
<endpoint address="http://localhost/..." >
<headers>
<HeaderName>Value</HeaderName>
</headers>
</endpoint>
MessageHeader
)-不是HTTP标头。
这是另一个有用的解决方案,用于使用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...
}
这类似于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();
这是对我有用的方法,改编自向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());
这对我有用
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);
}
.NET 3.5中的上下文绑定可能正是您想要的。现成的有三种:BasicHttpContextBinding,NetTcpContextBinding和WSHttpContextBinding。上下文协议基本上在消息头中传递键值对。在MSDN杂志上查阅“ 使用耐用服务管理状态 ”一文。
如果我正确理解了您的要求,那么简单的答案就是:您不能。
这是因为WCF服务的客户端可能由使用您的服务的任何第三方生成。
如果您可以控制服务的客户端,则可以创建基本客户端类,以添加所需的标头并继承工作类的行为。
您可以在MessageContract中指定自定义标头。
您还可以使用存储在配置文件中的<endpoint>标头,并将这些标头复制到客户端/服务发送的所有消息的标头中。这对于轻松添加一些静态标头很有用。
MessageHeader
)-不是HTTP标头。
如果要以面向对象的方式向每个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-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>
晚会晚了一点,但是Juval Lowy在他的书和相关的ServiceModelEx库中解决了这个确切的情况。
基本上,他定义了ClientBase和ChannelFactory专业化,可以指定类型安全的标头值。我建议下载源代码并查看HeaderClientBase和HeaderChannelFactory类。
约翰