[WCF]設置攔截器捕捉到request和reply消息

WCF進階學習ing...

在熟練掌握了ABC的使用以后，就開始想着去了解WCF是怎么通信的了。首先是服務描述語言wsdl，它定義了服務的描述等等，用於讓外界知道這個服務的ABC是什么。另外一個比較重要的就是消息。

WCF是通過消息進行通訊的，一般是使用SOAP形式。服務端的信道監聽器接收到消息之后，對消息進行反序列化，解碼，然后通過激活對象，再去invoke相應的操作，操作的結果（返回值）再通過編碼，序列化，傳送給調用者，調用者再對消息進行反序列化，解碼，最后拿到結果。所以在這個過程中，對消息的理解和熟悉對於我們理解WCF的操作流程是很大的幫助的。

然后我們就開始攔截這個消息來看看這個消息到底是什么。。。廢話不多說，上code。。

首先創建一個提供復數計算的服務，使用共享C的方式，項目結構如下，服務端和客戶端都是一個控制台程序

 

服務契約代碼 IComplexCalculate.cs：

namespace Cookiezhi.WcfStudy.Contracts.ServiceContracts
{
    [ServiceContract(Namespace="http://www.cookiezhi.com/service/complex")]
    public interface IComplexCalculate
    {
        /// <summary>
        /// 加
        /// </summary>
        [OperationContract]
        Complex Add(Complex a, Complex b);

        /// <summary>
        /// 減
        /// </summary>
        [OperationContract]
        Complex Subtract(Complex a, Complex b);

        /// <summary>
        /// 乘
        /// </summary>
        [OperationContract]
        Complex Multiply(Complex a, Complex b);

        /// <summary>
        /// 取模
        /// </summary>
        [OperationContract]
        double Modulus(Complex a);
    }
}

數據契約 Complex.cs：

namespace Cookiezhi.WcfStudy.Contracts.DataContracts
{
    [DataContract(Namespace = "http://www.cookiezhi.com/data/complex")]
    public class Complex
    {
        /// <summary>
        /// 實數
        /// </summary>
        [DataMember]
        public double A { get; set; }

        /// <summary>
        /// 虛數
        /// </summary>
        [DataMember]
        public double B { get; set; }
    }
}

服務契約實現 ComplexCalculateService：

namespace Cookiezhi.WcfStudy.Services
{
    public class ComplexCalculateService : IComplexCalculate
    {
        public Complex Add(Complex a, Complex b)
        {
            return new Complex()
            {
                A = a.A + b.A,
                B = a.B + b.B
            };
        }

        public Complex Subtract(Complex a, Complex b)
        {
            return new Complex()
            {
                A = a.A - b.A,
                B = a.B - b.B
            };
        }

        public Complex Multiply(Complex a, Complex b)
        {
            return new Complex()
            {
                A = a.A * b.A - a.B * b.B,
                B = a.A * b.B + a.B * b.A
            };
        }

        public double Modulus(Complex a)
        {
            return Math.Sqrt(a.A * a.A + a.B * a.B);
        }
    }
}

采用配置文件方式去設置服務 app.config：

<system.serviceModel>
    <behaviors>
      <serviceBehaviors>
        <behavior name="mexBehavior">
          <serviceMetadata httpGetEnabled="true"/>
        </behavior>
      </serviceBehaviors>
    </behaviors>
    
    <services>
      <service name="Cookiezhi.WcfStudy.Services.ComplexCalculateService" behaviorConfiguration="mexBehavior">
        <endpoint address="" binding="basicHttpBinding" contract="Cookiezhi.WcfStudy.Contracts.ServiceContracts.IComplexCalculate" />
        <endpoint address="mex" binding="mexHttpBinding" contract="IMetadataExchange" />
        <host>
          <baseAddresses>
            <add baseAddress="http://127.0.0.1:9999/complexcalcservice"/>
          </baseAddresses>
        </host>
      </service>
    </services>
    
  </system.serviceModel>

然后服務端的main方法里啟動服務：

namespace Cookiezhi.WcfStudy.Hosting
{
    class Program
    {
        static void Main(string[] args)
        {
            using(ServiceHost host = new ServiceHost(typeof(ComplexCalculateService)))
            {
                host.Opened += delegate
                {
                    Console.WriteLine("Service {0} started", host.Description.Name);
                };

                host.Open();

                Console.ReadKey();
            }
        }
    }
}

OK， 服務端好了，我們啟動一下

再看一下WSDL

 

OK是好的，這些對於做過WCF相關的朋友們都是輕車熟路了，下面是客戶端，通過配置文件加ChannelFactory方式來創建並調用

App.config

<system.serviceModel>
    <client>
      <endpoint name="ComplexCalculateService" address="http://127.0.0.1:9999/complexcalcservice" binding="basicHttpBinding" contract="Cookiezhi.WcfStudy.Contracts.ServiceContracts.IComplexCalculate" />
    </client>
  </system.serviceModel>

Main方法

namespace Cookiezhi.WcfStudy.Client
{
    class Program
    {
        static void Main(string[] args)
        {
            using(ChannelFactory<IComplexCalculate> factory = new ChannelFactory<IComplexCalculate>("ComplexCalculateService"))
            {
                IComplexCalculate proxy = factory.CreateChannel();

                Complex a = new Complex() { A = 1, B = 2 };
                Complex b = new Complex() { A = 2, B = 1 };
                Complex result = null;

                result = proxy.Add(a, b);
                Console.WriteLine("Add result is {0} + {1}i", result.A, result.B);

                Console.ReadKey();
            }
        }
    }
}

調用服務：

 

前戲做完了，我們開始進入主題：

我們需要攔截消息，並把消息打印出來，那么我們就需要一個攔截器，叫做MessageInspector，WCF為我們提供了兩種攔截器：

客戶端攔截器 IClientMessageInspector

提供兩個接口

BeforeSendRequest：向服務器發送請求前執行

AfterReceiveReply：接收到服務器的回復消息后執行

服務端攔截器 IDispatchMessageInspector

他也提供兩個接口

AfterReceiveRequest：invoke操作之前執行

BeforeSendReply：發送reply給客戶端之前執行

 

在這里我們在服務端設置個攔截器，然后打印出請求和回復的消息，所以我們使用IDispatchMessageInspector這個接口

實現接口 MessageInspector.cs

namespace Cookiezhi.WcfStudy.Hosting.MessageInspect
{
    public class MessageInspector : IDispatchMessageInspector
    {
        public object AfterReceiveRequest(ref Message request, IClientChannel channel, InstanceContext instanceContext)
        {
            Console.WriteLine(request.ToString());
            return DateTime.Now;
        }

        public void BeforeSendReply(ref Message reply, object correlationState)
        {
            Console.WriteLine(reply.ToString());
            DateTime requestTime = (DateTime)correlationState;

            var duration = DateTime.Now - requestTime;
            Console.WriteLine(duration);
        }
    }
}

其中AfterReceiveRequest先執行，然后去執行遠程方法，然后再執行BeforeSendReply,所以在這里加了一個操作計時的功能(可選)。

然后我們要將這個攔截器給寄宿在我們的終結點上，所以需要定義一個終結點行為(EndpointBehavior)，並寄宿在服務上。

MessageInspectorBehavior.cs，在ApplyDispatchBehavior方法實現中將我們新建的Inspector實例加到dispatcher的MessageInspectors中

namespace Cookiezhi.WcfStudy.Hosting.MessageInspect
{
    public class MessageInspectorBehavior : IEndpointBehavior
    {
        public void AddBindingParameters(ServiceEndpoint endpoint, BindingParameterCollection bindingParameters)
        {
        }

        public void ApplyClientBehavior(ServiceEndpoint endpoint, ClientRuntime clientRuntime)
        {
        }

        public void ApplyDispatchBehavior(ServiceEndpoint endpoint, EndpointDispatcher endpointDispatcher)
        {
            endpointDispatcher.DispatchRuntime.MessageInspectors.Add(new MessageInspector());16         }

        public void Validate(ServiceEndpoint endpoint)
        {
        }
    }
}

最后創建一個配置元素用於在配置文件中給終結點配置這個行為.

namespace Cookiezhi.WcfStudy.Hosting.MessageInspect
{
    public class MessageInspectorExtensionElement : BehaviorExtensionElement
    {
        public override Type BehaviorType
        {
            get { return typeof(MessageInspectorBehavior); }
        }

        protected override object CreateBehavior()
        {
            return new MessageInspectorBehavior();
        }
    }
}

下面就是配置這個行為了

App.config

<?xml version="1.0" encoding="utf-8" ?>
<configuration>

  <system.serviceModel>
    <extensions>
      <behaviorExtensions>
        <add name="messageInspector" type="Cookiezhi.WcfStudy.Hosting.MessageInspect.MessageInspectorExtensionElement, Cookiezhi.WcfStudy.Hosting"/>
      </behaviorExtensions>
    </extensions>
    
    <behaviors>
      <serviceBehaviors>
        <behavior name="mexBehavior">
          <serviceMetadata httpGetEnabled="true"/>
        </behavior>
      </serviceBehaviors>
      <endpointBehaviors>
        <behavior name="messageInspector">
          <messageInspector />
        </behavior>
      </endpointBehaviors>
    </behaviors>
    
    <services>
      <service name="Cookiezhi.WcfStudy.Services.ComplexCalculateService" behaviorConfiguration="mexBehavior">
        <endpoint address="" binding="basicHttpBinding" contract="Cookiezhi.WcfStudy.Contracts.ServiceContracts.IComplexCalculate" behaviorConfiguration="messageInspector" />
        <endpoint address="mex" binding="mexHttpBinding" contract="IMetadataExchange" />
        <host>
          <baseAddresses>
            <add baseAddress="http://127.0.0.1:9999/complexcalcservice"/>
          </baseAddresses>
        </host>
      </service>
    </services>
    
  </system.serviceModel>
  
    <startup> 
        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5" />
    </startup>
</configuration>

客戶端的代碼不要做出任何的改變，

然后我們嘗試一下

 

Great! 我們成功的攔截了請求，並將請求信息打印了出來。

 

總結，有了這個攔截器，我們可以做很多的事情，比如修改消息頭和消息體，計算消息的大小（流量統計），統計服務調用的次數和平均時間，客戶端情況，等等。