Wenn Sie jedem WCF-Aufruf objektorientiert benutzerdefinierte HTTP-Header hinzufügen möchten, suchen Sie nicht weiter.
Genau wie in der Antwort von Mark Good und Paulwhit müssen wir eine Unterklasse erstellen IClientMessageInspector
, um die benutzerdefinierten HTTP-Header in die WCF-Anforderung einzufügen. Lassen Sie uns den Inspektor jedoch allgemeiner gestalten, indem Sie ein Wörterbuch akzeptieren, das die Header enthält, die wir hinzufügen möchten:
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)
{
if (request.Properties.Count == 0 || request.Properties[HttpRequestMessageProperty.Name] == null)
{
request.Properties.Add(HttpRequestMessageProperty.Name, new HttpRequestMessageProperty());
}
var HeadersCollection = ((HttpRequestMessageProperty)request.Properties[HttpRequestMessageProperty.Name]).Headers;
foreach (var header in Headers) HeadersCollection[header.Key] = header.Value;
return null;
}
}
Genau wie in der Antwort von Mark Good und Paulwhit müssen wir eine Unterklasse erstellen IEndpointBehavior
, um unsere HttpHeaderMessageInspector
in unseren WCF-Client zu injizieren .
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);
}
}
Der letzte Teil, der zum Abschluss unseres objektorientierten Ansatzes erforderlich ist, besteht darin, eine Unterklasse unseres automatisch generierten WCF-Clients zu erstellen (ich habe das WCF-Webdienst-Referenzhandbuch von Microsoft zum Generieren eines WCF-Clients verwendet).
In meinem Fall muss ich einen API-Schlüssel an den x-api-key
HTML-Header anhängen .
Die Unterklasse führt Folgendes aus:
- Ruft den Konstruktor der Basisklasse mit den erforderlichen Parametern auf (in meinem Fall wurde eine
EndpointConfiguration
Aufzählung generiert, die an den Konstruktor übergeben wird - möglicherweise hat Ihre Implementierung dies nicht).
- Definiert die Header, die an jede Anforderung angehängt werden sollen
- Wird
AddHttpHeaderMessageEndpointBehavior
an das Endpoint
Verhalten des Kunden angehängt
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);
}
}
Verwenden Sie zum Schluss Ihren Client!
var apiKey = 'XXXXXXXXXXXXXXXXXXXXXXXXX';
var client = new Client (apiKey);
var result = client.SomeRequest()
Die resultierende HTTP-Anforderung sollte Ihre HTTP-Header enthalten und ungefähr so aussehen:
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>