Как добавить собственный заголовок HTTP для каждого вызова WCF?
У меня есть служба WCF, которая размещена в службе Windows. Клиенты, которые используют эту службу, должны передавать идентификатор каждый раз, когда они вызывают методы службы (потому что этот идентификатор важен для того, что должен делать вызываемый метод). Я подумал, что это хорошая идея - как-то поместить этот идентификатор в информацию заголовка WCF.
Если это хорошая идея, как я могу автоматически добавить идентификатор к информации заголовка. Другими словами, всякий раз, когда пользователь вызывает метод WCF, идентификатор должен автоматически добавляться в заголовок.
ОБНОВЛЕНИЕ. Клиентами, которые используют службу WCF, являются как приложения Windows, так и приложения Windows Mobile (с использованием Compact Framework).
14 ответов
Преимущество этого заключается в том, что он применяется к каждому вызову.
Создайте класс, который реализует 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, которые поддерживаются компактной структурой. Я считаю, что инспекторы сообщений классифицируются как "Расширяемость каналов", которые, согласно этому посту, поддерживаются компактной структурой.
Вы добавляете это к звонку используя:
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");
Если вы просто хотите добавить один и тот же заголовок ко всем запросам к сервису, вы можете сделать это без любой кодировки!
Просто добавьте узел заголовков с необходимыми заголовками под узлом конечной точки в файле конфигурации клиента
<client>
<endpoint address="http://localhost/..." >
<headers>
<HeaderName>Value</HeaderName>
</headers>
</endpoint>
Вот еще одно полезное решение для добавления пользовательских заголовков HTTP в ваш клиентский запрос WCF вручную с помощью ChannelFactory в качестве прокси. Это должно быть сделано для каждого запроса, но достаточно просто для демонстрации, если вам просто нужно выполнить модульное тестирование прокси-сервера при подготовке к платформам, отличным от.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...
}
Если вы хотите добавлять пользовательские заголовки HTTP к каждому вызову WCF объектно-ориентированным способом, не смотрите дальше.
Как и в ответах Марка Гуда и Полвита, нам нужно создать подкласс 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 ...
}
Как и в ответах Марка Гуда и Полвита, нам нужно создать подкласс 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 (для создания клиента WCF я использовал Справочное руководство по веб-сервисам Microsoft WCF).
В моем случае мне нужно прикрепить ключ API к x-api-key Заголовок HTML.
Подкласс делает следующее:
- вызывает конструктор базового класса с необходимыми параметрами (в моем случае
EndpointConfigurationenum был сгенерирован для передачи в конструктор - возможно, в вашей реализации этого не будет) - Определяет заголовки, которые должны быть прикреплены к каждому запросу
- Прикрепляет
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>
Это похоже на ответ 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();
Это работает для меня
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);
}
Это то, что сработало для меня, адаптировано от добавления заголовков 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 следующим образом:
client.Endpoint.Behaviors.Add(new AddUserAgentEndpointBehavior());
var endpoint = new EndpointAddress(new Uri(RemoteAddress),
new[]
{
AddressHeader.CreateAddressHeader("APIKey", "",
"bda11d91-7ade-4da1-855d-24adfe39d174")
});
Вы можете указать пользовательские заголовки в MessageContract.
Вы также можете использовать заголовки
Если я правильно понимаю ваше требование, простой ответ: вы не можете.
Это связано с тем, что клиент службы WCF может быть создан любой третьей стороной, которая использует вашу службу.
ЕСЛИ у вас есть контроль над клиентами вашего сервиса, вы можете создать базовый клиентский класс, который добавляет желаемый заголовок и наследует поведение рабочих классов.
Контекстные привязки в.NET 3.5 могут быть именно тем, что вы ищете. Есть три из коробки: BasicHttpContextBinding, NetTcpContextBinding и WSHttpContextBinding. Протокол контекста в основном передает пары ключ-значение в заголовок сообщения. Ознакомьтесь со статьей " Управление состоянием с помощью Durable Services" в журнале MSDN.
Нашел здесь другой подход :
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();
}
Немного опоздал на вечеринку, но Джувал Лоуи подробно описывает этот сценарий в своей книге и связанной библиотеке ServiceModelEx.
В основном он определяет специализации ClientBase и ChannelFactory, которые позволяют указывать безопасные для типов значения заголовков. Я предлагаю загрузить исходный код и посмотреть на классы HeaderClientBase и HeaderChannelFactory.
Джон