Bagaimana cara menambahkan header HTTP khusus untuk setiap panggilan WCF?

Saya memiliki layanan WCF yang di-host di Layanan Windows. Klien yang menggunakan layanan ini harus melewati pengidentifikasi setiap kali mereka memanggil metode layanan (karena pengenal itu penting untuk apa yang harus dilakukan metode yang dipanggil). Saya pikir itu ide yang baik untuk meletakkan pengidentifikasi ini ke informasi header WCF.

Jika itu ide yang bagus, bagaimana saya bisa menambahkan pengenal secara otomatis ke informasi header. Dengan kata lain, setiap kali pengguna memanggil metode WCF, pengidentifikasi harus ditambahkan secara otomatis ke header.

UPDATE: Klien yang menggunakan layanan WCF adalah aplikasi Windows dan aplikasi Windows Mobile (menggunakan Compact Framework).

Keuntungannya adalah ini diterapkan untuk setiap panggilan.

Buat kelas yang mengimplementasikan IClientMessageInspector . Dalam metode BeforeSendRequest, tambahkan tajuk khusus Anda ke pesan keluar. Mungkin terlihat seperti ini:

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

Kemudian buat perilaku titik akhir yang menerapkan inspektur pesan ke runtime klien. Anda bisa menerapkan perilaku melalui atribut atau melalui konfigurasi menggunakan elemen ekstensi perilaku.

Berikut adalah contoh yang bagus tentang cara menambahkan header agen-pengguna HTTP ke semua pesan permintaan. Saya menggunakan ini di beberapa klien saya. Anda juga dapat melakukan hal yang sama di sisi layanan dengan menerapkan IDispatchMessageInspector .

Apakah ini yang ada dalam pikiran Anda?

Pembaruan: Saya menemukan daftar fitur WCF yang didukung oleh kerangka kerja yang ringkas. Saya percaya inspektur pesan diklasifikasikan sebagai 'Channel Perluasan' yang menurut posting ini, yang didukung oleh kerangka kompak.

Anda menambahkannya ke panggilan menggunakan:

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
}

Dan kemudian, sisi server Anda ambil menggunakan:

MessageHeaders headers = OperationContext.Current.IncomingMessageHeaders;
string identity = headers.GetHeader<string>("Identity", "http://www.my-website.com");

Jika Anda hanya ingin menambahkan tajuk yang sama ke semua permintaan ke layanan, Anda dapat melakukannya tanpa kode apa pun!
Cukup tambahkan node header dengan header yang diperlukan di bawah node titik akhir di file konfigurasi klien Anda

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

Berikut ini adalah solusi lain yang bermanfaat untuk menambahkan Header HTTP khusus ke permintaan WCF klien Anda menggunakan ChannelFactorysebagai proxy. Ini harus dilakukan untuk setiap permintaan, tetapi cukup sebagai demo sederhana jika Anda hanya perlu menguji unit proxy Anda dalam persiapan untuk platform non-.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... 
}

Ini mirip dengan jawaban NimsDotNet tetapi menunjukkan cara melakukannya secara terprogram.

Cukup tambahkan header ke penjilidan

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

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

Inilah yang berhasil bagi saya, diadaptasi dari Menambahkan HTTP Header ke Panggilan 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)
    {
    }
}

Setelah mendeklarasikan kelas-kelas ini, Anda dapat menambahkan perilaku baru ke klien WCF Anda seperti ini:

client.Endpoint.Behaviors.Add(new AddUserAgentEndpointBehavior());

Ini bekerja untuk saya

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

Binding konteks di .NET 3.5 mungkin hanya apa yang Anda cari. Ada tiga dari kotak: BasicHttpContextBinding, NetTcpContextBinding, dan WSHttpContextBinding. Protokol konteks pada dasarnya melewati pasangan nilai kunci di header pesan. Lihat artikel Mengelola Status Layanan Tahan Lama di majalah MSDN.

Jika saya memahami kebutuhan Anda dengan benar, jawaban sederhana adalah: Anda tidak bisa.

Itu karena klien layanan WCF dapat dihasilkan oleh pihak ketiga mana pun yang menggunakan layanan Anda.

JIKA Anda memiliki kendali atas klien layanan Anda, Anda bisa membuat kelas klien dasar yang menambahkan header yang diinginkan dan mewarisi perilaku di kelas pekerja.

Anda dapat menentukan header khusus di MessageContract .

Anda juga dapat menggunakan tajuk <endpoint> yang disimpan dalam file konfigurasi dan akan disalin di tajuk semua pesan yang dikirim oleh klien / layanan. Ini berguna untuk menambahkan beberapa tajuk statis dengan mudah.

Jika Anda ingin menambahkan header HTTP khusus ke setiap panggilan WCF dengan cara yang berorientasi objek, tidak perlu mencari lagi.

Sama seperti dalam jawaban Mark Good dan paulwhit, kita perlu subkelas IClientMessageInspectoruntuk menyuntikkan header HTTP khusus ke dalam permintaan WCF. Namun, mari buat inspektur lebih umum dengan menerima kamus yang berisi tajuk yang ingin kita tambahkan:

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

Sama seperti dalam jawaban Mark Good dan paulwhit, kita perlu subkelas IEndpointBehavioruntuk menyuntikkan HttpHeaderMessageInspectorklien kami ke WCF kami.

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

Bagian terakhir yang diperlukan untuk menyelesaikan pendekatan berorientasi objek kami, adalah membuat subkelas dari klien yang dibuat secara otomatis WCF kami (saya menggunakan Panduan Referensi Layanan Web WCF Microsoft untuk menghasilkan klien WCF).

Dalam kasus saya, saya perlu melampirkan kunci API ke x-api-keyheader HTML.

Subclass melakukan hal berikut:

• memanggil konstruktor dari kelas dasar dengan parameter yang diperlukan (dalam kasus saya EndpointConfigurationenum dihasilkan untuk masuk ke konstruktor - mungkin implementasi Anda tidak akan memiliki ini)
• Menentukan header yang harus dilampirkan ke setiap permintaan
• Menempel perilaku AddHttpHeaderMessageEndpointBehaviorklienEndpoint

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

Akhirnya, gunakan klien Anda!

var apiKey = 'XXXXXXXXXXXXXXXXXXXXXXXXX';
var client = new Client (apiKey);
var result = client.SomeRequest()

Permintaan HTTP yang dihasilkan harus berisi tajuk HTTP Anda dan terlihat seperti ini:

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>

Agak terlambat ke pesta tetapi Juval Lowy membahas skenario yang tepat ini dalam bukunya dan perpustakaan ServiceModelEx terkait .

Pada dasarnya ia mendefinisikan spesialisasi ClientBase dan ChannelFactory yang memungkinkan menentukan nilai header jenis-aman. Saya suggesst mengunduh sumber dan melihat kelas HeaderClientBase dan HeaderChannelFactory.

John