在应用WCF之前,我们需要创建一个编码器来帮组我们的程序开发。那么如何才能正确的实现WCF编码器的创建呢?首先,我们需要创建一个定制的MessageEncoderFactory,它能创建我们的定制的编码器对象,它需要:#t#
一个被覆盖的编码器对象
一个被覆盖的消息版本
包含一个从CustomMessageEncoder工厂创建的名为CustomEncoderFactory的样本类。我们需要将该编码器标记为一个单独的CustomMessageEncoder工厂对象。
为了创建一个CustomEncoderFactory实例,需要传入两个新的东西:一个EncodeMode枚举值以及一个EnableCompression变量:
EncodeMode是一个可根据配置值动态改变编码格式,并且无需知道任何特殊的WCF编码器的深入知识就可以编写压缩/解压缩逻辑的枚举值。它支持各种压缩类型,包括None、Deflate、Gzip,同时,我们还可以添加更多定制的压缩编码器格式:
- /// < summary>
- /// Compression Encoder formats. Add custom encoders such as
- /// ICSharpLib, 7z, rar
- /// < /summary>
- public enum CompressionEncoder
- {
- None,
- Deflate,
- GZip
- }
EnableCompression是一个布尔开关值,通过它可以启用或者禁用压缩处理。
接下来,我们需要创建一个CustomEncoder,以实现抽象类MessageEncoder,具体代码如清单2所示。清单2的示例代码实现了IsDataCompressed方法,用以确定数据是否已经压缩。对于Gzip,可以使用“幻码”值来确定数据是否经过压缩处理。
就像前面提到的那样,这个定制的WCF编码器的编码过程是在ReadMessage和WriteMessage方法中进行的。所以,我们还需要覆盖ContentType属性来交付不同的内容类型。枚举类型的CompressionEncoder变量值决定了运行时的内容类型。
然后,我们需要创建一个CustomMessageEncodingBinding元素,以便规定可配置的定制属性,在本例中它包含EnableCompression、CompressionEncoder 和捆绑元素。
***,我们需要创建一个CustomMessageEncodingElement元素,它派生自BindingElementExtensionElement类。
从配置文件读取这些值之后,CreateBindingElement方法充当一个入口点,并将这些值转换成定制的捆绑元素的适当的属性。
我们需要注意的事项如下所示:CreateBindingElement方法,它充当一个入口点。
注意,我们可以通过配置修改捆绑元素的messageversion属性,但是为简单起见,我们在此不对此加以讨论。
ApplyConfiguration方法,它使我们可以显式指定属性。
ReaderQuotas,它用来给CustomMesssageEncodingBindingElement指定属性。
值ReaderQuotas.MaxArrayLength可以控制请求大小。因为这个例子使用定制的捆绑,所以需要将其设为捆绑元素。
***,需要实现CustomBindingElement的配置部分。对于客户端,配置看上去是这样的:
- < system.serviceModel>
- < extensions>
- < bindingElementExtensions>
- < add name="customMessageEncoding" type="
- Infrastructure.CustomEncoder.CustomMessageEncodingElement, assemblyname" />
- < /bindingElementExtensions>
- < /extensions>
- < bindings>
- < customBinding>
- < binding name="myBinding">
- < customMessageEncoding innerMessageEncoding=
- "textMessageEncoding" enableCompression="false"
- compressionEncode="gzip">
- < readerQuotas maxArrayLength="62914560" >< /readerQuotas>
- < /customMessageEncoding >
- < httpTransport maxBufferSize="62914560"
- maxReceivedMessageSize="62914560"
- authenticationScheme="Anonymous"
- proxyAuthenticationScheme="Anonymous"
- useDefaultWebProxy="true"
- />
- < /binding>
- < /customBinding>
- < /bindings>
- < client>
- < endpoint address="http://127.0.0.1/mywcf.services/service1.svc"
- binding="customBinding" bindingConfiguration="myBinding"
- contract="IService" name="Service1">
- < /endpoint>
- < /client>
- < /system.serviceModel>
上面创建的定制的捆绑使用新的CustomMessageEncoding。请求通常不需要压缩,因为它们通常很小;事实上,压缩它们反而会增加请求的尺寸。因此,以上显示的客户端配置文件了enableCompression ="false"的设置。服务器配置看起来象这样:
- < system.serviceModel>
- < extensions>
- < bindingElementExtensions>
- < add name="customMessageEncoding" type="
- Infrastructure.CustomEncoder.CustomMessageEncodingElement, assemblyname" />
- < /bindingElementExtensions>
- < /extensions>
- < bindings>
- < customBinding>
- < binding name="myBinding">
- < customMessageEncoding
- innerMessageEncoding="textMessageEncoding"
- enableCompression="true"
- compressionEncode="gzip">
- < readerQuotas
- maxArrayLength="62914560" >
- < /readerQuotas>
- < /customMessageEncoding >
- < httpTransport maxBufferSize="62914560"
- maxReceivedMessageSize="62914560"
- authenticationScheme="Anonymous"
- proxyAuthenticationScheme="Anonymous"
- useDefaultWebProxy="true" />
- < /binding>
- < /customBinding>
- < bindings>
- < services>
- < service behaviorConfiguration="Host.Behavior"
- name="Host.Service">
- endpoint address=""
- binding="customBinding"
- bindingConfiguration="myBinding"
- contract="ServiceContracts.IService" />
- < endpoint address="mex" binding="mexHttpBinding"
- contract="IMetadataExchange" />
- < /service>
- < /services>
- < /system.serviceModel>
通过阅读本文,您会发现向我们的WCF编码器中添加定制的编码不仅简单,而且还是透明的。我们的示例代码不仅包含了文中描述的class属性的详尽的源代码,而且还提供了所需的配置章节。