在 WCF 中使用高效的 BinaryFormatter 序列化

本文将定义一个 WCF 终结点行为扩展，以在 WCF 中使用更高效的 BinaryFormatter 进行二进制序列化，并实现对是否使用传统二进制序列化功能的可配置。

• 介绍
• 实现步骤
• 使用方法
• 效果

 

介绍

---

在 OEA 框架中，是使用 WCF 作为数据传输框架。但是使用 WCF 内部的二进制序列化，序列化后的数据大小，要比使用传统的 System.Runtime.Serialization.Formatters.Binary.BinaryFormatter 类进行序列化后的数据大小要大得多。作为使用 .NET 框架的系统内部互联，往往期望在使用 WCF 获取统一传输方案的同时，还能得到 BinaryFormatter 类的序列化性能。所以本篇文章将设计一个 WCF 终结点行为扩展，来配置是否使用 BinaryFormatter 进行数据的序列化。

Tip

只能在操作上添加二进制序列化的行为。这是因为 WCF 的扩展点中，只有操作才支持设置 IClientMessageFormatter 及 IDispatchMessageFormatter。

WCF 中，要实现替换操作的序列化器，最直接的方式应该是使用一个实现 IOperationBehavior 的特性（Attribute），并将该特性直接标记到操作方法上。但是，这样会导致该方法在所有的终结点都使用 BinaryFormatter 来进行序列化。这并不是我们所想要的，所以只能使用配置的方法来对 WCF 进行扩展。

 

实现步骤

---

 

• 封装 BinaryFormatter

首先，需要对 BinaryFormatter 进行一个简单的封装。该类使用 BinaryFormatter 来实现对象到二进制流的序列化及反序列化。

/// <summary>
/// 序列化门户 API
/// </summary>
public static class Serializer
{
    /// <summary>
    /// 使用二进制序列化对象。
    /// </summary>
    /// <param name="value"></param>
    /// <returns></returns>
    public static byte[] SerializeBytes(object value)
    {
        if (value == null) return null;

        var stream = new MemoryStream();
        new BinaryFormatter().Serialize(stream, value);

        //var dto = Encoding.UTF8.GetString(stream.GetBuffer());
        var bytes = stream.ToArray();
        return bytes;
    }

    /// <summary>
    /// 使用二进制反序列化对象。
    /// </summary>
    /// <param name="bytes"></param>
    /// <returns></returns>
    public static object DeserializeBytes(byte[] bytes)
    {
        if (bytes == null) return null;

        //var bytes = Encoding.UTF8.GetBytes(dto as string);
        var stream = new MemoryStream(bytes);

        var result = new BinaryFormatter().Deserialize(stream);

        return result;
    }
}

 

• 添加 BinaryFormatterAdapter

添加一个 BinaryFormatterAdapter 类型，该类实现了从 WCF 序列化器到 BinaryFormatter 的甜适配。它实现 IClientMessageFormatter 及 IDispatchMessageFormatter 两个接口，并调用 Serializer 来进行二进制序列化。

namespace OEA.WCF
{
    /// <summary>
    /// 在内部序列化器的基础上添加 Remoting 二进制序列化的功能。
    /// </summary>
    internal class BinaryFormatterAdapter : IClientMessageFormatter, IDispatchMessageFormatter
    {
        private IClientMessageFormatter _innerClientFormatter;
        private IDispatchMessageFormatter _innerDispatchFormatter;
        private ParameterInfo[] _parameterInfos;
        private string _operationName;
        private string _action;

        /// <summary>
        /// for client
        /// </summary>
        /// <param name="operationName"></param>
        /// <param name="parameterInfos"></param>
        /// <param name="innerClientFormatter"></param>
        /// <param name="action"></param>
        public BinaryFormatterAdapter(
            string operationName,
            ParameterInfo[] parameterInfos,
            IClientMessageFormatter innerClientFormatter,
            string action
            )
        {
            if (operationName == null) throw new ArgumentNullException("methodName");
            if (parameterInfos == null) throw new ArgumentNullException("parameterInfos");
            if (innerClientFormatter == null) throw new ArgumentNullException("innerClientFormatter");
            if (action == null) throw new ArgumentNullException("action");

            this._innerClientFormatter = innerClientFormatter;
            this._parameterInfos = parameterInfos;
            this._operationName = operationName;
            this._action = action;
        }

        /// <summary>
        /// for server
        /// </summary>
        /// <param name="operationName"></param>
        /// <param name="parameterInfos"></param>
        /// <param name="innerDispatchFormatter"></param>
        public BinaryFormatterAdapter(
            string operationName,
            ParameterInfo[] parameterInfos,
            IDispatchMessageFormatter innerDispatchFormatter
            )
        {
            if (operationName == null) throw new ArgumentNullException("operationName");
            if (parameterInfos == null) throw new ArgumentNullException("parameterInfos");
            if (innerDispatchFormatter == null) throw new ArgumentNullException("innerDispatchFormatter");

            this._innerDispatchFormatter = innerDispatchFormatter;
            this._operationName = operationName;
            this._parameterInfos = parameterInfos;
        }

        Message IClientMessageFormatter.SerializeRequest(MessageVersion messageVersion, object[] parameters)
        {
            var result = new object[parameters.Length];
            for (int i = 0; i < parameters.Length; i++) { result[i] = Serializer.SerializeBytes(parameters[i]); }

            return _innerClientFormatter.SerializeRequest(messageVersion, result);
        }

        object IClientMessageFormatter.DeserializeReply(Message message, object[] parameters)
        {
            var result = _innerClientFormatter.DeserializeReply(message, parameters);

            for (int i = 0; i < parameters.Length; i++) { parameters[i] = Serializer.DeserializeBytes(parameters[i] as byte[]); }
            result = Serializer.DeserializeBytes(result as byte[]);

            return result;
        }

        void IDispatchMessageFormatter.DeserializeRequest(Message message, object[] parameters)
        {
            _innerDispatchFormatter.DeserializeRequest(message, parameters);

            for (int i = 0; i < parameters.Length; i++) { parameters[i] = Serializer.DeserializeBytes(parameters[i] as byte[]); }
        }

        Message IDispatchMessageFormatter.SerializeReply(MessageVersion messageVersion, object[] parameters, object result)
        {
            var seralizedParameters = new object[parameters.Length];
            for (int i = 0; i < parameters.Length; i++) { seralizedParameters[i] = Serializer.SerializeBytes(parameters[i]); }
            var serialzedResult = Serializer.SerializeBytes(result);

            return _innerDispatchFormatter.SerializeReply(messageVersion, seralizedParameters, serialzedResult);
        }
    }
}

 

• 添加 BinaryFormatterOperationBehavior

添加 BinaryFormatterOperationBehavior 操作行为类。这个类会设置客户端、服务端的操作的序列化器。

namespace OEA.WCF
{
    /// <summary>
    /// 在原始 Formatter 的基础上装饰 BinaryFormatterAdapter
    /// <remarks>
    /// BinaryFormatterOperationBehavior 为什么要实现为操作的行为：
    /// 因为只有当操作的 DataContractSerializerBehavior 行为应用功能后，才能拿到 DataContractSerializerFormatter 并包装到 BinaryFormatterAdapter 中。
    ///
    /// 由于一个操作的操作契约在系统中只有一份。而我们期望序列化的行为只影响指定的终结点，所以这个行为在应用时，会检查是否传入的运行时，即是添加时的运行时。
    /// </remarks>
    /// </summary>
    internal class BinaryFormatterOperationBehavior : IOperationBehavior
    {
        private object _runtime;

        internal BinaryFormatterOperationBehavior(object runtime)
        {
            _runtime = runtime;
        }

        /// <summary>
        /// 本行为只为这个运行时起作用。
        /// </summary>
        public object ParentRuntime
        {
            get { return _runtime; }
        }

        public void ApplyClientBehavior(OperationDescription description, ClientOperation runtime)
        {
            if (_runtime == runtime.Parent)
            {
                //在之前的创建的 Formatter 的基础上，装饰新的 Formatter
                runtime.Formatter = new BinaryFormatterAdapter(description.Name, runtime.SyncMethod.GetParameters(), runtime.Formatter, runtime.Action);
            }
        }

        public void ApplyDispatchBehavior(OperationDescription description, DispatchOperation runtime)
        {
            if (_runtime == runtime.Parent)
            {
                runtime.Formatter = new BinaryFormatterAdapter(description.Name, description.SyncMethod.GetParameters(), runtime.Formatter);
            }
        }

        public void AddBindingParameters(OperationDescription description, BindingParameterCollection parameters) { }

        public void Validate(OperationDescription description) { }
    }
}

 

• 添加终结点行为 EnableBinaryFormatterBehavior

添加终结点行为 EnableBinaryFormatterBehavior，实现为该终结点下的所有操作添加 BinaryFormatterOperationBehavior 的逻辑。

namespace OEA.WCF
{
    class EnableBinaryFormatterBehavior : IEndpointBehavior
    {
        public void ApplyClientBehavior(ServiceEndpoint endpoint, ClientRuntime clientRuntime)
        {
            foreach (var operation in endpoint.Contract.Operations)
            {
                DecorateFormatterBehavior(operation, clientRuntime);
            }
        }

        public void ApplyDispatchBehavior(ServiceEndpoint endpoint, EndpointDispatcher endpointDispatcher)
        {
            foreach (var operation in endpoint.Contract.Operations)
            {
                DecorateFormatterBehavior(operation, endpointDispatcher.DispatchRuntime);
            }
        }

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

        public void Validate(ServiceEndpoint endpoint) { }

        private static void DecorateFormatterBehavior(OperationDescription operation, object runtime)
        {
            //这个行为附加一次。
            var dfBehavior = operation.Behaviors.Find<BinaryFormatterOperationBehavior>();
            if (dfBehavior == null)
            {
                //装饰新的操作行为
                //这个行为是操作的行为，但是我们期望只为当前终结点做操作的序列化，所以传入 runtime 进行区分。
                dfBehavior = new BinaryFormatterOperationBehavior(runtime);
                operation.Behaviors.Add(dfBehavior);
            }
        }
    }
}

 

• 添加行为扩展元素 EnableBinaryFormatterBehaviorElement

添加终结点行为扩展类，使得该类在配置文件可以使用。它指定了对应的运行时行为类型是 EnableBinaryFormatterBehavior

namespace OEA.WCF
{
    /// <summary>
    /// 启用旧的 BinaryFormatter 来对数据进行序列化。
    /// </summary>
    public class EnableBinaryFormatterBehaviorElement : BehaviorExtensionElement
    {
        public override Type BehaviorType
        {
            get { return typeof(EnableBinaryFormatterBehavior); }
        }

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

 

使用方法

---

要使用这个扩展，只需要在客户端、服务端做相应的配置即可：

• 服务端配置

在 system.serviceModel 中添加扩展及行为配置：

<system.serviceModel>
    <behaviors>
        <endpointBehaviors>
            <behavior name="enableRemotingBinarySerialization">
                <remotingBinarySerialization/>
            </behavior>
        </endpointBehaviors>
    </behaviors>
    <extensions>
        <behaviorExtensions>
            <add name="remotingBinarySerialization" type="OEA.WCF.EnableBinaryFormatterBehaviorElement, OEA"/>
        </behaviorExtensions>
    </extensions>
</system.serviceModel>

 

为服务终结点添加行为配置 behaviorConfiguration="enableRemotingBinarySerialization"。

<system.serviceModel>
    <services>
        <service name="OEA.Server.Hosts.WcfPortal" behaviorConfiguration="includesException">
            <endpoint address="/Binary" binding="customBinding" bindingConfiguration="compactBindingConfig"
                        behaviorConfiguration="enableRemotingBinarySerialization"
                        contract="OEA.Server.Hosts.IWcfPortal"/>
        </service>
    </services>
</system.serviceModel>

• 客户端

  客户端同样添加相应的扩展及行为配置，并添加到服务终结点上即可。

 

• 效果

  ---

  效果图：

  

  以上是使用公司目前正在开发的系统的数据量进行测试的结果。可以看到，使用 WCF 直接二进制序列化时，32000 行数据序列化后大小是 28.34M（黄底），而启用这个扩展进行序列化后大小是 13.89M（浅绿底）。当同时使用 WCF 二进制序列化及 BinaryFormatter 序列化后，数据大小是10.42 M（绿底）。

  Note

  同时使用多次序列化，虽然数据量会更小，但是序列化时间却增多。使用时，需要根据实际情况来调整。