通过“四大行为”对WCF的扩展[实例篇]

为了让读者对如何利用相应的行为对WCF进行扩展有个深刻的认识，在这里我提供一个简单的实例演示。本实例模拟的场景是这样的：我们创建一个支持多语言的资源服务，该服务旨在为调用者提供基于某种语言的文本型资源。但是，我们不希望客户端在每次调用服务的时候都显式地制定具体的语言，而是根据客户端服务调用线程表示语言文化的上下文来自动识别所需的语言。[源代码从这里下载]

要让资源服务具有识别语言文化的能够，我们必须将客户端服务调用线程当前的语言文化信息（具体来说就是Thread的两个属性：CurrentUICulture和CurrentCulture）自动传递到服务端。我们具体的实现原理是这样的：我们将客户端服务调用线程的CurrentUICulture和CurrentCulture的语言文化代码保存在出栈消息的SOAP报头中，并为它们起一个预定义的名称和命名空间；在服务操作在服务端执行之前，我们根据这个预定义SOAP报头名称和命名空间将这两个语言文化代码从入栈消息中获取出来，创建相应的CultureInfo对象并作为服务操作执行线程的CurrentUICulture和CurrentCulture。那么服务操作在执行的时候，只需要根据当前线程的语言文化上下文提供相应资源就可以了。接下来，我们就来一步一步地实现这样一个简单的扩展。

步骤一、创建自定义CallContextInitializer：CultureReceiver

所谓客户端当前语言文化信息的传递，无外乎是客户端将当前线程的CurrentUICulture和CurrentCulture放到出栈消息中；而服务端将其从入栈消息中取出，并对当前线程的CurrentUICulture和CurrentCulture进行相应的设置。我们先来实现在服务端用于进行语言文化信息获取的组件，我将其命名为CultureReceiver。

由于CultureReceiver在从入栈消息中获取表示客户端线程的CurrentUICulture和CurrentCulture信息的时，需要预先知道相应报头的名称和命名空间（命名空间仅仅用于SOAP报头），为此我们将这些定义成如下一个名称为CultureMessageHeaderInfo的类。属性CurrentCultureName，CurrentUICultureName和Namespace分别表示代码客户端线程CurrentCulture和CurrentUICulture的报头名称。

[code]      namespace Artech.WcfExtensions.CulturePropagation

     {

         internal class CultureMessageHeaderInfo

         {

             public string     Namespace{ get; set; }

             public string     CurrentCultureName{ get; set; }

             public string     CurrentUICultureName { get; set; }

         }

     }

[/code]

而我们进行语言文化报头接收以及对服务操作执行线程当前语言文化的设置的CultureReceiver组件被定义成一个实现了接口ICallContextInitializer的CallContextInitializer对象。在介绍WCF服务端运行时框架的时候，我们已经对CallContextInitializer进行了说明。我们说CallContextInitializer的两个方法BeforeInvoke和AfterInvoke方法分别在操作方法执行前后被调用。

而我们恰好可以通过实现BeforeInvoke方法将存放在入栈消息报头的表示客户端线程CurrentCulture和CurrentUICulture的内容取出，并以此创建相应的CultureInfo作为当前线程的CurrentCulture和CurrentUICulture。由于WCF服务端采用线程池的机制处理客户端请求，线程会被重用，所以我们有必要在操作方法执行之后将当前线程的语言文化设置恢复到之前的状态，而这恰好可以实现在AfterInvoke方法中。下面的代码片断表示CultureReceiver的全部定义。

[code]
     using System.Globalization;

     using System.ServiceModel;

     using System.ServiceModel.Channels;

     using System.ServiceModel.Dispatcher;

     using System.Threading;

     namespace Artech.WcfExtensions.CulturePropagation

     {

         internal class CultureReceiver : ICallContextInitializer

         {

             public CultureMessageHeaderInfo messageHeaderInfo;

             public CultureReceiver(CultureMessageHeaderInfo messageHeaderInfo)

             {

                 this.messageHeaderInfo = messageHeaderInfo;

             }

      

             public void AfterInvoke(object correlationState)

             {

                 CultureInfo[] cultureInfos = correlationState as CultureInfo[];

                 if (null != cultureInfos)

                 {

                     Thread.CurrentThread.CurrentCulture = cultureInfos[0];

                     Thread.CurrentThread.CurrentUICulture = cultureInfos[1];

                 }

             }

      

             public object BeforeInvoke(InstanceContext instanceContext, IClientChannel channel, Message message)

             {

                 CultureInfo[] originalCulture = new CultureInfo[] { CultureInfo.CurrentCulture, CultureInfo.CurrentUICulture };

                 CultureInfo currentCulture = null;

                 CultureInfo currentUICulture = null;

                 if (message.Headers.FindHeader(this.messageHeaderInfo.CurrentCultureName, this.messageHeaderInfo.Namespace) > -1)

                 {

                     currentCulture = new CultureInfo(message.Headers.GetHeader<string>(this.messageHeaderInfo.CurrentCultureName, 

                         this.messageHeaderInfo.Namespace));

                     Thread.CurrentThread.CurrentCulture = currentCulture;

                 }

                 if (message.Headers.FindHeader(this.messageHeaderInfo.CurrentUICultureName, this.messageHeaderInfo.Namespace) > -1)

                 {

                     currentUICulture = new CultureInfo(message.Headers.GetHeader<string>(this.messageHeaderInfo.CurrentUICultureName, 

                        this.messageHeaderInfo.Namespace));

                     Thread.CurrentThread.CurrentUICulture = currentUICulture;

                 }

                 return originalCulture;

             }

         }

     }

[/code]

步骤二、自定义ClientMessageInspector：CultureSender

对于客户端，我们通过自定义一个ClientMessageInspector利用“消息检验”机制将代表当前线程CurrentCulture和CurrentUICulture的语言文化代码以SOAP报头的形式植入请求消息中。我们将改自定义的ClientMessageInspector称为CultureSender。如下面的代码所示，上述的关于客户端线程当前语言文化信息的发送实现在BeforeSendRequest方法中。

[code]
     using System.Globalization;

     using System.ServiceModel;

     using System.ServiceModel.Channels;

     using System.ServiceModel.Dispatcher;

     namespace Artech.WcfExtensions.CulturePropagation

     {

         internal class CultureSender: IClientMessageInspector

         {

             private CultureMessageHeaderInfo messageHeaderInfo;

      

             public CultureSender(CultureMessageHeaderInfo messageHeaderInfo)

             {

                 this.messageHeaderInfo = messageHeaderInfo;

             }

      

             public void AfterReceiveReply(ref Message reply, object correlationState) { }

             public object BeforeSendRequest(ref Message request, IClientChannel channel)

             {

                 request.Headers.Add(MessageHeader.CreateHeader(this.messageHeaderInfo.CurrentCultureName, this.messageHeaderInfo.Namespace, CultureInfo.CurrentCulture.Name));

                 request.Headers.Add(MessageHeader.CreateHeader(this.messageHeaderInfo.CurrentUICultureName, this.messageHeaderInfo.Namespace, CultureInfo.CurrentUICulture.Name));          

                 return null;

             }

         }

     }

[/code]

步骤三、创建行为：CulturePropagationBehaviorAttribute

到目前为止，真正实现语言文化信息从客户端到服务端传播的自定义CallContextInitialier（CultureReceiver）和ClientMessageInspector（CultureSender）都已经创建好了。我们目前需要做的是通过定义相应的行为将这两个自定义组件分别应用到WCF的服务端和客户端运行时框架中去。具体来说，我们需要创建CultureReceiver对象并将其添加到相应DispatchOperation的CallContextInitializer列表之中，创建CultureSender对象并将其添加到ClientRuntime的MessageInspector列表之中。

以下定义的CulturePropagationBehaviorAttribute就是这样一个行为。从下面给出的代码中我们可以看到，CulturePropagationBehaviorAttribute实现了三个行为接口（IServiceBehavior, IEndpointBehavior, IContractBehavior），所以它既是一个服务行为，同时也是一个终结点行为和契约行为。我们自定义的CultureReceiver和CultureSender分别通过ApplyDispatchBehavior和ApplyClientBehavior方法被应用到服务端和客户端运行时框架。

[code]
     using System;

     using System.Collections.ObjectModel;

     using System.ServiceModel;

     using System.ServiceModel.Channels;

     using System.ServiceModel.Description;

     using System.ServiceModel.Dispatcher;

     namespace Artech.WcfExtensions.CulturePropagation

     {

         public class CulturePropagationBehaviorAttribute: Attribute, IServiceBehavior, 

            IEndpointBehavior,  IContractBehavior

         {

             private CultureMessageHeaderInfo messageHeaderInfo;

      

             public const string DefaultNamespace            = "http://www.artech.com/culturepropagation";

             public const string DefaultCurrentCultureName   = "CurrentCultureName";

             public const string DefaultCurrentUICultureName = "CurrentUICultureName";

      

             public string Namespace 

             { 

                 get{return messageHeaderInfo.Namespace;} 

                 set{messageHeaderInfo.Namespace = value;} 

             }

             public string CurrentCultureName

             {

                 get { return messageHeaderInfo.CurrentCultureName; }

                 set { messageHeaderInfo.CurrentCultureName = value; }

             }

             public string CurrentUICultureName

             {

                 get { return messageHeaderInfo.CurrentUICultureName; }

                 set { messageHeaderInfo.CurrentUICultureName = value; }

             }

      

             public CulturePropagationBehaviorAttribute()

             {

                 messageHeaderInfo = new CultureMessageHeaderInfo 

                     { 

                         Namespace               = DefaultNamespace, 

                         CurrentCultureName      = DefaultCurrentCultureName, 

                         CurrentUICultureName    = DefaultCurrentUICultureName 

                     };

             }

      

             //IServiceBehavior

             public void AddBindingParameters(ServiceDescription serviceDescription, ServiceHostBase serviceHostBase, 

                  Collection<ServiceEndpoint> endpoints, BindingParameterCollection bindingParameters) {}

             public void ApplyDispatchBehavior(ServiceDescription serviceDescription, ServiceHostBase serviceHostBase)

             {

                 foreach (ChannelDispatcher channelDispatcher in serviceHostBase.ChannelDispatchers)

                 {

                     foreach (EndpointDispatcher endpoint in channelDispatcher.Endpoints)

                     {

                         foreach (DispatchOperation operation in endpoint.DispatchRuntime.Operations)

                         {

                             operation.CallContextInitializers.Add(new CultureReceiver(messageHeaderInfo));

                         }

                     }

                 }

             }

             public void Validate(ServiceDescription serviceDescription, ServiceHostBase serviceHostBase) { }

      

             //IEndpointBehavior

             public void AddBindingParameters(ServiceEndpoint endpoint, BindingParameterCollection bindingParameters) { }

             public void ApplyClientBehavior(ServiceEndpoint endpoint, ClientRuntime clientRuntime)

             {

                 clientRuntime.MessageInspectors.Add(new CultureSender(messageHeaderInfo));

             }

             public void ApplyDispatchBehavior(ServiceEndpoint endpoint, EndpointDispatcher endpointDispatcher)

             {

                 foreach (DispatchOperation operation in endpointDispatcher.DispatchRuntime.Operations)

                 {

                     operation.CallContextInitializers.Add(new CultureReceiver(messageHeaderInfo));

                 }

             }

             public void Validate(ServiceEndpoint endpoint) { }

      

             //IContractBehavior

             public void AddBindingParameters(ContractDescription contractDescription, 

               ServiceEndpoint endpoint, BindingParameterCollection bindingParameters) { }

             public void ApplyClientBehavior(ContractDescription contractDescription, 

               ServiceEndpoint endpoint, ClientRuntime clientRuntime)

             {

                 clientRuntime.MessageInspectors.Add(new CultureSender(messageHeaderInfo));

             }

             public void ApplyDispatchBehavior(ContractDescription contractDescription, ServiceEndpoint endpoint, 

               DispatchRuntime dispatchRuntime)

             {

                 foreach (DispatchOperation operation in dispatchRuntime.Operations)

                 {

                     operation.CallContextInitializers.Add(new CultureReceiver(messageHeaderInfo));

                 }

             }

             public void Validate(ContractDescription contractDescription, ServiceEndpoint endpoint) { }

         }

     }

[/code]

由于作为服务行为和契约行为的CulturePropagationBehaviorAttribute又是一个自定义特性，所以我们可以直接将其应用到服务契约接口（作为契约行为）或者服务类型（作为服务行为）上。在应用该行为特性时，你可以设置CurrentCultureName、CurrentUICultureName和Namespace属性改变封装客户端线程CurrentCulture和CurrentUICulture的SOAP报头的名称和命名空间。如果此三个属性没有经过显式设置，它们具有默认值。

作为契约行为：

[code]
     [ServiceContract]

     [CulturePropagationBehavior(CurrentCultureName = "culture", CurrentUICultureName = "uiCulture")]

     public interface IResourceService

     {

         [OperationContract]

         string GetString(string key);

     }

[/code]

作为服务行为：

[code]
     [CulturePropagationBehavior(CurrentCultureName = "culture", CurrentUICultureName = "uiCulture")]

     public class ResourceService : IResourceService

     {

         public string GetString(string key)

         {

             //省略实现

         }

     }

[/code]

步骤四、为CulturePropagationBehaviorAttribute定义配置元素

除了通过编程的方式应用行为之外，对于WCF四种类型的行为，契约行为和操作行为只能通过以自定义特性的方式以声明的方式分别应用到服务契约接口（或者类）和操作契约方法或者操作实现方法上。终结点行为只能通过配置的方式应用到对应的终结点。而服务行为，则可以同时采用声明和配置的方式应用到目标服务上面。

由于我们定义的CulturePropagationBehaviorAttribute既是服务行为，也是终结点行为，为了实现以配置的方式来使用该行为，我们需要为之创建一个配置元素的类。作为服务行为或者终结点行为的配置元素类均继承自抽象类BehaviorExtensionElement。

在这里我们创建了如下一个CulturePropagationBehaviorElement类来定义CulturePropagationBehaviorAttribute的配置元素。在BehaviorExtensionElement中，我们定义了三个可选（IsRequired = false）的配置属性CurrentCultureName、CurrentUICultureName和Namespace分别代表用于封装客户端线程CurrentCulture和CurrentUICulture的SOAP报头名称和命名空间。

[code]
     using System;

     using System.Configuration;

     using System.ServiceModel.Configuration;

     namespace Artech.WcfExtensions.CulturePropagation

     {

         public class CulturePropagationBehaviorElement: BehaviorExtensionElement

         {

             [ConfigurationProperty("namespace",IsRequired =false,             

                 DefaultValue = CulturePropagationBehaviorAttribute.DefaultNamespace)]

             public string Namespace

             {

                 get { return (string)this["namespace"]; }

                 set { this["namespace"] = value; }

             }

             [ConfigurationProperty("currentCultureName", IsRequired = false,             

                 DefaultValue = CulturePropagationBehaviorAttribute.DefaultCurrentCultureName)]

             public string CurrentCultureName

             {

                 get { return (string)this["currentCultureName"]; }

                 set { this["currentCultureName"] = value; }

             }

             [ConfigurationProperty("currentUICultureName", IsRequired = false,             

                 DefaultValue = CulturePropagationBehaviorAttribute.DefaultCurrentUICultureName)]

             public string CurrentUICultureName

             {

                 get { return (string)this["currentUICultureName"]; }

                 set { this["currentUICultureName"] = value; }

             }

             public override Type BehaviorType

             {

                 get { return typeof(CulturePropagationBehaviorAttribute); }

             }

             protected override object CreateBehavior()

             {

                 return new CulturePropagationBehaviorAttribute

                 {

                     Namespace = this.Namespace,

                     CurrentCultureName = this.CurrentCultureName,

                     CurrentUICultureName = this.CurrentUICultureName

                 };

             }

         }

     }

[/code]

下面的XML片断反映了如何将CulturePropagationBehaviorAttribute作为服务行为以配置的方式应用到目标服务上。首先，我们需要将基于服务行为的配置元素类型以行为或者的形式定义在<extensions>/<behaviorExtensions>结点下，并给它一个名称（在这里将我们定义的扩展起名为culturePropagation）。在配置服务行为的时候，我们只需要在行为配置节点中添加以行为扩展名为元素名的XML结点，并对定义在配置元素类型中的配置属性进行相应的设置即可。在本例中，我们定义了一个名称为defaultSvcBehavior的服务行为。该行为结点的字结点<culturePropagation>代表我们自定义的CulturePropagationBehaviorAttribute行为。在<culturePropagation>结点下，我们对namespace、currentCultureName和currentUICultureName作了显式设置（由于三个配置属性可选的，如果没有对它们进行显式设置，它们将会具有一个默认值）。最终这个名称为defaultSvcBehavior的服务行为被应用到了ResourceService服务上（behaviorConfiguration="defaultSvcBehavior"）。

[code]
     <configuration>

       <system.serviceModel>

         <services>

           <service behaviorConfiguration="defaultSvcBehavior" 

                    name="Artech.WcfServices.Servicies.ResourceService">

             <endpoint  address = “http://127.0.0.1:3721/resourceservice”

                        binding="ws2007HttpBinding"  

                        contract="Artech.WcfServices.Contracts.IResourceService" />

           </service>

         </services>

         <behaviors>

           <serviceBehaviors>

             <behavior name="defaultSvcBehavior">

               <culturePropagation 

            namespace="http://www.artech.com/" 

            currentCultureName="cultureName" 

            currentUICultureName="uiCultureName"/>

             </behavior>

           </serviceBehaviors>

         </behaviors>

         <extensions>

           <behaviorExtensions>

             <add name="culturePropagation" 

                  type="Artech.WcfExtensions.CulturePropagation.CulturePropagationBehaviorElement, Artech.WcfExtensions.Lib" />

           </behaviorExtensions>

         </extensions>

       </system.serviceModel>

     </configuration>

[/code]

如果你需要将CulturePropagationBehaviorAttribute以终结点行为的方式应用到服务的某个终结点上，配置方式与此类似。首先，你同样需要将代表行为配置元素的类型名称定义成行为扩展。然后将代表该行为配置的XML结点添加到终结点配置节点即可。在下面这段配置中，ResourceService服务具有唯一的终结点，该终结点应用了一个名称为defaultEndpointBehavior的终结点行为。而该种节点行为包含了CulturePropagationBehaviorAttribute的相关配置。

[code]
     <configuration>

       <system.serviceModel>

         <services>

           <service name="Artech.WcfServices.Servicies.ResourceService">

             <endpoint address     = "http://127.0.0.1:3721/resourceservice"

                       binding     = "ws2007HttpBinding"

                       contract    ="Artech.WcfServices.Contracts.IResourceService" 

                       behaviorConfiguration="defaultEndpointBehavior"/>

           </service>

         </services>

         <behaviors>

           <endpointBehaviors>

             <behavior name="defaultEndpointBehavior">

               <culturePropagation

                Namespace        ="http://www.artech.com/"

                currentCultureName    ="cultureName"

                currentUICultureName="uiCultureName"/>

             </behavior>

           </endpointBehaviors>

         </behaviors>

         <extensions>

           <behaviorExtensions>

             <add name="culturePropagation" type="Artech.WcfExtensions.CulturePropagation.CulturePropagationBehaviorElement, Artech.WcfExtensions.Lib" />

           </behaviorExtensions>

         </extensions>

       </system.serviceModel>

     </configuration>

[/code]

步骤五、创建实例应用检验语言文化的自动传播

到目前为止，关于实现语言文化从客户端自动传播到服务端的所有扩展实现均已完成。为了检验我们自定义的行为CulturePropagationBehaviorAttribute是否真的能够实现这个目标，我们需要通过建立一个简单的WCF应用程序来检验。

我们采用之前介绍过的文本型资源提供服务，为此我们创建了如下一个简单的代表服务契约接口IResourceService，该服务契约具有一个唯一的操作契约方法GetString用于获取基于给定的键值得到的对应的文本型资源的内容。需要注意的是，我们定义的CulturePropagationBehaviorAttribute以契约行为的形式应用到IResourceService接口之上。

[code]
     using System.ServiceModel;

     using Artech.WcfExtensions.CulturePropagation;

     namespace Artech.WcfServices.Contracts

     {

         [ServiceContract(Namespace = "http://www.artech.com/")]

         [CulturePropagationBehavior]

         public interface IResourceService

         {

             [OperationContract]

             string GetString(string key);

         }

     }

[/code]

为了提供对于多语言的支持，我们将资源文本的内容定义在资源文件中。为此我们在定义服务类型的项目中添加了如下图所示的两个资源文件。其中Resources.resx代表语言文化中性的资源文件，而Resources.zh-CN.resx则代表基于中国（大陆）简体中文的资源文件。两个资源文件定义了英文和中文作为内容的两个文本资源条目HappyNewYear和MerryChristmas。





在默认的情况下，添加语言文化中性的资源文件会自动生成方便访问资源条目的代码。在服务类型的GetString方法中，我就直接使用定义在自动生成的Resources类的静态属性ResourceManager（相应类型为System.Resources.ResourceManager）来获取给定键值的相应文本资源的内容。

[code]
     using Artech.WcfServices.Contracts;

     using Artech.WcfServices.Servicies.Properties;

     namespace Artech.WcfServices.Servicies

     {

         public class ResourceService : IResourceService

         {

             public string GetString(string key)

             {

                 return Resources.ResourceManager.GetString(key);

             }

         }

     }

[/code]

然后，服务ResourceService以控制台应用作为宿主进行简单的自我寄宿。下面是服务端配置和客户端配置，由于我们自定义的CulturePropagationBehaviorAttribute是以声明的方式作为契约行为应用到契约接口上，所以配置中并不包含相关的内容。

服务寄宿端配置：

[code]
     <configuration>

       <system.serviceModel>

         <services>

           <service name="Artech.WcfServices.Servicies.ResourceService">

             <endpoint  address = "http://127.0.0.1:3721/resourceservice"

                        binding ="ws2007HttpBinding"

                        contract ="Artech.WcfServices.Contracts.IResourceService"/>

           </service>

         </services>

       </system.serviceModel>

     </configuration>

[/code]

客户端配置：

[code]
     <configuration>

       <system.serviceModel>

         <client>

           <endpoint name ="resourceservice"

                     address = "http://127.0.0.1:3721/resourceservice"

                     binding ="ws2007HttpBinding"

                     contract ="Artech.WcfServices.Contracts.IResourceService"/>

         </client>

       </system.serviceModel>

     </configuration>

[/code]

客户端同样是一个控制台应用，下面是进行服务调用的代码。从中我们可以看到，我们一共进行了四次针对GetString操作的服务调用，在调用之前我们对当前线程的CurrentUICulture（它决定了语言的种类和对资源文件的选择）。前面两次和后面两次是在CurrentUICulture为en-US和zh-CN情况下进行调用的。从输出结果我们可以清晰地看到：客户端得到的资源文本的语言正好是和当前线程的CurrentUICulture一致的，而这正是应用在契约接口上CulturePropagationBehaviorAttribute特性所致。

[code]
     using System;

     using System.ServiceModel;

     using System.Threading;

     using Artech.WcfServices.Contracts;

     namespace Client

     {

         class Program

         {

             static void Main(string[] args)

             {

                 using(ChannelFactory<IResourceService> channelFactory = new ChannelFactory<IResourceService>("resourceservice"))

                 {

                     IResourceService proxy = channelFactory.CreateChannel();

                     Thread.CurrentThread.CurrentUICulture = new System.Globalization.CultureInfo("en-US");

                     Console.WriteLine(proxy.GetString("HappyNewYear"));

                     Console.WriteLine(proxy.GetString("MerryChristmas")+"\n");

      

                     Thread.CurrentThread.CurrentUICulture = new System.Globalization.CultureInfo("zh-CN");

                     Console.WriteLine(proxy.GetString("HappyNewYear"));

                     Console.WriteLine(proxy.GetString("MerryChristmas"));

                 }

                 Console.Read();

             }

         }

     }

[/code]

输出结果：

[code]
     Happy New Year!

     Merry Christmas!

      

     新年快乐！

     圣诞快乐！

[/code]

通过“四大行为”对WCF的扩展[原理篇]


通过“四大行为”对WCF的扩展[实例篇]