在《WCF技術剖析》寫作期間，對WCF又有了新的感悟，為此以書名開始本人的第三個WCF系列。本系列的目的在于對《WCF技術剖析》的補充，會對書中的一些內容進行展開講述，同時會囊括很多由于篇幅的原因忍痛割棄的內容。

本系列的第一篇，我將會對WCF的基本架構作一個大致的講解。不過，一改傳統對WCF的工作流程進行平鋪直敘，我將另辟蹊徑，借助于我們熟悉的ASP.NET作為請求處理平臺，通過一個簡單的托管程序模擬整個WCF客戶端和服務端的架構。本篇文章的大部分內容節選自《WCF技術剖析（卷1）》第八章。

WCF框架處理流程和涉及的組件

我們的模擬程序將你搭建一個迷你版的WCF框架，為了展示WCF整個處理流程中使用到一些特殊組件。我們首先來簡單介紹一下對于一個簡單的WCF服務調用，WCF的客戶端和服務端框架的處理流程，和該流程的每一個階段都使用那些重要組件。

下面的列表列出了WCF服務端框架對于處理一個簡單的WCF服務調用請求所提供的功能，以及相應的功能承載的組件：

請求消息的接收和回復消息的發送：服務端在傳輸層監聽與接收來自客戶的請求，并將經過編碼后的回復消息通過傳輸層發送到客戶端

請求消息的解碼和回復消息的編碼：將接收到的字節數組通過解碼生成請求消息對象，并將回復消息通過編程轉化成字節組。消息的編碼和解碼通過MessageEncoder完成，而MessageEncoderFactory負責創建該對象

請求消息的反序列化和回復消息的序列化：對請求消息進行反序列化，為服務操作的執行生成相應的輸入參數，以及將服務操作執行的結果（返回值或者ref/out參數）序列化，并生成回復消息。序列化和反序列化通過DispatchMessageFormatter完成

服務對象的創建：創建或者激活服務對象實例，IntanceProvider用于服務對象的創建或獲取

服務操作的執行：調用創建的服務對象的操作方法，并傳入經過反序列化生成的輸入參數。OperationInvoker完成對服務操作的最終執行

較之服務端的流程，客戶端的流程顯得相對簡單，僅僅包含以下三個必需的階段：

請求消息的序列化和回復消息的反序列化：生成請求消息并將輸入參數序列化到請求消息中，以及對回復消息進行反序列化，轉化成方法調用的返回值或者ref/out參數。序列化和反序列化通過ClienthMessageFormatter完成

請求消息的編碼和回復消息的解碼：對請求消息進行編碼生成字節數組供傳輸層發送，以及將傳輸層接收到的字節數組解碼生成恢復消息。消息的編碼和解碼通過MessageEncoder完成，而MessageEncoderFactory負責創建該對象

請求消息的發送和回復消息的接收：在傳輸層將經過編碼的請求消息發送到服務端，以及將接收來自服務端的恢復消息

 
圖1 精簡版WCF客戶端與服務端組件

圖1反映了進行服務調用的必要步驟和使用到的相關WCF組件。在本案例演示中，我們需要做的就是手工創建這些組件，并通過我們自己的代碼利用它們搭建一個建議版的WCF框架。如果讀者能夠對本案例的實現有一個清晰的理解，相信對于整個WCF的框架就不會感到陌生了。

圖2顯示了本案例解決方案的基本結構，總共分三個項目。Contracts用于定義服務契約，被服務端和客戶端引用。客戶端通過一個Console應用模擬，而服務端則通過一個ASP.NET Website實現。

 
圖2 WCF框架模擬案例應用結構

#p#

步驟一、通過服務契約類型創建相關組件

WCF在整個服務調用生命周期的不同階段，會使用到不同的組件。我們通過一個方法將服務端和客戶端所需的所有組件都創建出來，為此，我們在Contracts項目中添加了一個Utility類型，在Create< T>方法中創建所有的組件并通過輸出參數的形式返回，泛型類型T表示的是服務契約類型。在該方法中，輸出參數encoderFactory被服務端和客戶端用于消息的編碼和解碼，clientFormatters和dispatchFormatters以字典的形式包含了基于服務操作的IClientMessageFormatter和IDispatchMessageFormatter，其中clientFormatters和dispatchFormatters的Key分別為操作名稱和操作對應的Action。同樣通過字典形式返回的operationInvokers和methods用于在服務端執行相應的操作方法，Key同樣為操作對應的Action。

public static class Utility  
{  
    public static void Create< T>(out MessageEncoderFactory encoderFactory,  
        out IDictionary< string, IClientMessageFormatter> clientFormatters,  
        out IDictionary< string, IDispatchMessageFormatter> dispatchFormatters,  
        out IDictionary< string, IOperationInvoker> operationInvokers,  
        out IDictionary< string, MethodInfo> methods)  
    {  
        //省略實現  
    }  
} 

具體的實現如下，由于在WCF框架中使用的MessageEncoderFactory（TextMessageEncoderFactory）、MessageFormatter（DataContractSerializerOperationFormatter）和OperationInvoker（SyncMethodInvoker）都是一些內部類型，所以只能通過反射的方式創建它們。而操作名稱和Action也主要通過反射的原理解析應用在服務方法上的OperationContractAttribute得到。

public static void Create< T>(out MessageEncoderFactory encoderFactory,  
    out IDictionary< string, IClientMessageFormatter> clientFormatters,  
    out IDictionary< string, IDispatchMessageFormatter> dispatchFormatters,  
    out IDictionary< string, IOperationInvoker> operationInvokers,  
    out IDictionary< string, MethodInfo> methods)  
{  
    //確保類型T是應用了ServiceContractAttribute的服務契約  
    object[] attributes = typeof(T).GetCustomAttributes(typeof(ServiceContractAttribute), false);  
    if (attributes.Length == 0)  
    {  
        throw new InvalidOperationException(string.Format("The type \"{0}\" is not a ServiceContract!", typeof(T).AssemblyQualifiedName));  
    }   
 
    //創建字典保存IClientMessageFormatter、IDispatchMessageFormatter、IOperationInvoker和MethodInfo  
    clientFormatters = new Dictionary< string, IClientMessageFormatter>();  
    dispatchFormatters = new Dictionary< string, IDispatchMessageFormatter>();  
    operationInvokers = new Dictionary< string, IOperationInvoker>();  
    methods = new Dictionary< string, MethodInfo>();   
 
    //MessageEncoderFactory  
    string encoderFactoryType = "System.ServiceModel.Channels.TextMessageEncoderFactory,System.ServiceModel, Version=3.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089";  
    encoderFactory = (MessageEncoderFactory)Activator.CreateInstance(Type.GetType(encoderFactoryType), MessageVersion.Default, Encoding.UTF8, int.MaxValue, int.MaxValue, new XmlDictionaryReaderQuotas());   
 
//得到OperationDecription列表  
string defaultNamespace = "http://tempuri.org/";  
    ServiceContractAttribute serviceAttribute = (ServiceContractAttribute)attributes[0];  
    string serviceNamepace = string.IsNullOrEmpty(serviceAttribute.Namespace) ? defaultNamespace : serviceAttribute.Namespace;  
    string serviceName = string.IsNullOrEmpty(serviceAttribute.Name) ? typeof(T).Name : serviceAttribute.Name;  
    var operations = ContractDescription.GetContract(typeof(T)).Operations;   
 
    //得到具體的IClientMessageFormatter、IDispatchMessageFormatter和IOperationInvoker的具體類型  
    //IClientMessageFormatter+IDispatchMessageFormatter：DataContractSerializerOperationFormatter  
    //IOperationInvoker：SyncMethodInvoker  
    string formatterTypeName = "System.ServiceModel.Dispatcher.DataContractSerializerOperationFormatter,System.ServiceModel, Version=3.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089";  
    Type formatterType = Type.GetType(formatterTypeName);  
    ConstructorInfo formatterConstructor = formatterType.GetConstructor(new Type[] { typeof(OperationDescription), typeof(DataContractFormatAttribute), typeof(DataContractSerializerOperationBehavior) });  
    string operationInvokerTypeName = "System.ServiceModel.Dispatcher.SyncMethodInvoker,System.ServiceModel, Version=3.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089";  
    Type operationInvokerType = Type.GetType(operationInvokerTypeName);   
 
    foreach (MethodInfo method in typeof(T).GetMethods())  
    {  
        attributes = method.GetCustomAttributes(typeof(OperationContractAttribute), true);  
        if (attributes.Length > 0)  
        {  
            OperationContractAttribute operationAttribute = (OperationContractAttribute)attributes[0];  
            string operationName = string.IsNullOrEmpty(operationAttribute.Name) ? method.Name : operationAttribute.Name;  
            //通過OperationContractAttribute得到Action  
            string action;  
            if (string.IsNullOrEmpty(operationAttribute.Action))  
            {  
                action = string.Format("{0}{1}/{2}", serviceNamepace, serviceName, operationName);  
            }  
            else 
            {  
                action = operationAttribute.Action;  
            }   
 
            OperationDescription operation = operations.Where(op => op.Name == operationName).ToArray< OperationDescription>()[0];  
            //通過反射創建DataContractSerializerOperationFormatter對象  
            object formatter = formatterConstructor.Invoke(new object[] { operation, new DataContractFormatAttribute(), null });  
            clientFormatters.Add(operationName, formatter as IClientMessageFormatter);  
            dispatchFormatters.Add(action, formatter as IDispatchMessageFormatter);   
 
            //通過反射創建SyncMethodInvoker對象  
            IOperationInvoker operationInvoker = (IOperationInvoker)Activator.CreateInstance(operationInvokerType, method);  
            operationInvokers.Add(action, operationInvoker);  
            methods.Add(action, method);  
        }  
}  

步驟二、創建服務契約和實現服務

接下來為本案例創建一個服務契約和實現該契約。服務契約定義在Contracts項目，具體的服務實現在模擬服務端的ASP.NET Web站點中。簡單起見，依然沿用計算服務的例子。

namespace Artech.WcfFrameworkSimulator.Contracts  
{  
    [ServiceContract(Namespace = "http://www.artech.com/")]  
    public interface ICalculator  
    {  
        [OperationContract]  
        double Add(double x, double y);  
    }  
}  
   
 
public class CalculatorService : ICalculator  
{  
    public double Add(double x, double y)  
    {  
        return x + y;  
    }  
}  

#p#

步驟三、實現服務端對服務調用請求的處理

我們通過一個ASP.NET的Web Page來模擬WCF服務端對服務請求的處理，下面的Calculator類型相關的代碼實際上就是Calculator.aspx的后臺代碼（Code Behind）。整個處理流程不算復雜。在構造函數中，調用Utility的Create< ICalculator>方法，將所需的組件進行初始化，而具體的服務調用請求處理的邏輯在直接寫在Web Page的Load事件中。

首先，通過MessageCoderFactory創建MessageEncoder對接收到的以HttpRequest形式體現的服務調用請求進行解碼，并生成請求消息。通過請求消息得到當前服務操作的Action屬性后，在初始化過程中得到的基于服務契約所有MethodInfo列表中，根據該Action得到當前操作對應的MethodInfo對象。借助于MethodInfo對象得到操作方法的輸入參數和輸出參數數量后，創建兩個對象數組，分別用于保存通過DispatchMessageFormatter對象對于請求消息進行反序列化得到的輸入參數，和通過OperationInvoker執行操作方法得到的輸出參數。在OperationInvoker執行操作方法之前，通過反射的方式直接創建服務對象，這一步在真正的WCF框架中是通過InstanceProvider實現的。

通過OperationInvoker執行操作方法的結果有兩種形式：返回值和輸出參數（包括引用參數）。它們通過被傳入DispatchMessageFormatter被序列化并生成回復消息對象。回復消息通過MessageCoderFactory創建MessageEncoder進行編碼后通過HttpResponse返回。

public partial class Calculator : System.Web.UI.Page  
{  
    private static MessageVersion messageversion = MessageVersion.Default;  
    private static MessageEncoderFactory encoderFactory;  
    private static IDictionary< string, IDispatchMessageFormatter> dispatchFormatters;  
    private static IDictionary< string, IOperationInvoker> operationInvokers;  
    private static IDictionary< string, MethodInfo> methods;  
 
    protected Calculator()  
    {  
        IDictionary< string, IClientMessageFormatter> clientFormatters;  
        Utility.Create< ICalculator>(out encoderFactory, out clientFormatters, out dispatchFormatters, out operationInvokers, out methods);  
    }  
 
    protected void Page_Load(object sender, EventArgs e)  
    {  
        //對HttpPRequest進行解碼生成請求消息對象  
        Message request = encoderFactory.Encoder.ReadMessage(this.Request.InputStream, int.MaxValue, "application/soap+xml; charset=utf-8");  
 
        //通過請求消息得到代表服務操作的Action  
        string action = request.Headers.Action;  
 
        //通過Action從MethodInfo字典中獲取服務操作對應的MethodInfo對象  
        MethodInfo method = methods[action];  
 
        //得到輸出參數的數量  
        int outArgsCount = 0;  
        foreach (var parameter in method.GetParameters())  
        {  
            if (parameter.IsOut)  
            {  
                outArgsCount++;  
            }  
        }  
 
        //創建數組容器，用于保存請求消息反序列后生成的輸入參數對象  
        int inputArgsCount = method.GetParameters().Length - outArgsCount;  
        object[] parameters = new object[inputArgsCount];  
        dispatchFormatters[action].DeserializeRequest(request, parameters);  
 
        List< object> inputArgs = new List< object>();  
        object[] outArgs = new object[outArgsCount];  
        //創建服務對象，在WCF中服務對象通過InstanceProvider創建  
        object serviceInstance = Activator.CreateInstance(typeof(CalculatorService));  
        //執行服務操作  
        object result = operationInvokers[action].Invoke(serviceInstance, parameters, out outArgs);  
        //將操作執行的結果（返回值或者輸出參數）序列化生成回復消息  
        Message reply = dispatchFormatters[action].SerializeReply(messageversion, outArgs, result);  
        this.Response.ClearContent();  
        this.Response.ContentEncoding = Encoding.UTF8;  
        this.Response.ContentType = "application/soap+xml; charset=utf-8";  
        //對回復消息進行編碼，并將編碼后的消息通過HttpResponse返回  
        encoderFactory.Encoder.WriteMessage(reply, this.Response.OutputStream);  
        this.Response.Flush();  
    }  
}  

步驟四、實現客戶端對服務調用請求的處理

由于在客戶端對服務請求的處理是通過一個RealProxy（ServiceChannelFactory）實現的,為了真實模擬WCF處理框架，在這里通過一個自定義RealProxy來實現客戶端相關的服務調用請求的處理。下面代碼中定義的ServiceRealProxy< IContract>就是這樣一個自定義RealProxy。

用于處理服務調用請求的相關組件對象，比如MessageEncoderFactory和IClientMessageFormatter字典，以及所需的屬性，比如消息的版本和服務的目的地址，通過構造函數指定。而具體的請求處理實現在重寫的Invoke方法之中。首先通過解析應用在當前方法的上面的OperationContractAttribute得到服務操作的名稱，以此為Key從IClientMessageFormatter字典中得到當前服務操作對應的IClientMessageFormatter對象。當前操作方法調用的輸入參數通過IClientMessageFormatter對象進行序列化后生成請求消息。為請求消息添加必要的尋址報頭后，通過MessageEncoderFactory創建的MessageEncoder對請求消息進行編碼。經過編碼的消息以HttpRequest的形式發送到服務端，從而完成了服務調用請求的發送。

服務調用的結果通過HttpResponse的形式返回后，先通過MessageEncoder對其解碼，并生成回復消息。回復消息通過IClientMessageFormatter進行反序列化后，在消息中以XML InfoSet實行體現的結果被轉化成具體的對象，這些對象被最終影射為方法調用的返回值和輸出參數（包含引用參數）。

namespace Artech.WcfFrameworkSimulator.Client  
{  
    public class ServiceRealProxy< IContract> : RealProxy  
    {  
        private Uri _remoteAddress;  
        private IDictionary< string, IClientMessageFormatter> _messageFormatters;  
        private MessageVersion _messageVersion = MessageVersion.Default;  
        private MessageEncoderFactory _messageEncoderFactory;  
 
        public ServiceRealProxy(MessageVersion messageVersion, Uri address, IDictionary< string, IClientMessageFormatter> messageFormaters, MessageEncoderFactory messageEncoderFactory)  
            : base(typeof(IContract))  
        {  
            object[] attribute = typeof(IContract).GetCustomAttributes(typeof(ServiceContractAttribute), false);  
            if (attribute.Length == 0)  
            {  
                throw new InvalidOperationException(string.Format("The type \"{0}\" is not a ServiceContract!", typeof(IContract).AssemblyQualifiedName));  
            }  
            this._messageVersion = messageVersion;  
            this._remoteAddress = address;  
            this._messageFormatters = messageFormaters;  
            this._messageEncoderFactory = messageEncoderFactory;  
        }  
 
        public override IMessage Invoke(IMessage msg)  
        {  
            IMethodCallMessage methodCall = (IMethodCallMessage)msg;  
 
            //Get Operation name.  
            object[] attributes = methodCall.MethodBase.GetCustomAttributes(typeof(OperationContractAttribute), true);  
            if (attributes.Length == 0)  
            {  
                throw new InvalidOperationException(string.Format("The method \"{0}\" is not a valid OperationContract.", methodCall.MethodName));  
            }  
            OperationContractAttribute attribute = (OperationContractAttribute)attributes[0];  
            string operationName = string.IsNullOrEmpty(attribute.Name) ? methodCall.MethodName : attribute.Name;  
 
            //序列化請求消息  
            Message requestMessage = this._messageFormatters[operationName].SerializeRequest(this._messageVersion, methodCall.InArgs);  
 
            //添加必要的WS-Address報頭  
            EndpointAddress address = new EndpointAddress(this._remoteAddress);  
            requestMessage.Headers.MessageId = new UniqueId(Guid.NewGuid());  
            requestMessage.Headers.ReplyTo = new EndpointAddress("http://www.w3.org/2005/08/addressing/anonymous");  
            address.ApplyTo(requestMessage);  
 
            //對請求消息進行編碼，并將編碼生成的字節發送通過HttpWebRequest向服務端發送  
            HttpWebRequest webRequest = (HttpWebRequest)HttpWebRequest.Create(this._remoteAddress);  
            webRequest.Method = "Post";  
            webRequest.KeepAlive = true;  
            webRequest.ContentType = "application/soap+xml; charset=utf-8";  
            ArraySegment< byte> bytes = this._messageEncoderFactory.Encoder.WriteMessage(requestMessage, int.MaxValue, BufferManager.CreateBufferManager(long.MaxValue, int.MaxValue));  
            webRequest.ContentLength = bytes.Array.Length;  
            webRequest.GetRequestStream().Write(bytes.Array, 0, bytes.Array.Length);  
            webRequest.GetRequestStream().Close();  
            WebResponse webResponse = webRequest.GetResponse();  
 
            //對HttpResponse進行解碼生成回復消息.  
            Message responseMessage = this._messageEncoderFactory.Encoder.ReadMessage(webResponse.GetResponseStream(), int.MaxValue);  
 
            //回復消息進行反列化生成相應的對象，并映射為方法調用的返回值或者ref/out參數  
            object[] allArgs = (object[])Array.CreateInstance(typeof(object), methodCall.ArgCount);  
            Array.Copy(methodCall.Args, allArgs, methodCall.ArgCount);  
            object[] refOutParameters = new object[GetRefOutParameterCount(methodCall.MethodBase)];  
            object returnValue = this._messageFormatters[operationName].DeserializeReply(responseMessage, refOutParameters);  
            MapRefOutParameter(methodCall.MethodBase, allArgs, refOutParameters);  
 
            //通過ReturnMessage的形式將返回值和ref/out參數返回  
            return new ReturnMessage(returnValue, allArgs, allArgs.Length, methodCall.LogicalCallContext, methodCall);  
        }  
 
        private int GetRefOutParameterCount(MethodBase method)  
        {  
            int count = 0;  
            foreach (ParameterInfo parameter in method.GetParameters())  
            {  
                if (parameter.IsOut || parameter.ParameterType.IsByRef)  
                {  
                    count++;  
                }  
            }  
            return count;  
        }  
 
        private void MapRefOutParameter(MethodBase method, object[] allArgs, object[] refOutArgs)  
        {  
            List< int> refOutParamPositionsList = new List< int>();  
            foreach (ParameterInfo parameter in method.GetParameters())  
            {  
                if (parameter.IsOut || parameter.ParameterType.IsByRef)  
                {  
                    refOutParamPositionsList.Add(parameter.Position);  
                }  
            }  
            int[] refOutParamPositionArray = refOutParamPositionsList.ToArray();  
            for (int i = 0; i <  refOutArgs.Length; i++)  
            {  
                allArgs[refOutParamPositionArray[i]] = refOutArgs[i];  
            }  
        }  
    }  
}  

在真正的WCF客戶端框架下，客戶端通過ChannelFactory< T>創建服務代理對象進行服務的調用，在這里我們也創建一個完成相似功能的工廠類型: SerivceProxyFactory< T>，泛型類型T代表服務契約類型。

用于創建服務代理的Create方法很簡單：先通過Utility.Create< T>方法創建客戶端進行服務調用必須的相關組件對象，通過這些對象連同該方法的參數（消息版本和服務目的地址）創建ServiceRealProxy< T>對象，最終返回的是該RealProxy的TransparentProxy。

namespace Artech.WcfFrameworkSimulator.Client  
{  
    public static class SerivceProxyFactory< T>  
    {  
        public static T Create(MessageVersion messageVersion, Uri remoteAddress)  
        {  
            MessageEncoderFactory encoderFactory;  
            IDictionary< string, IClientMessageFormatter> clientFormatters;  
            IDictionary< string, IDispatchMessageFormatter> dispatchFormatters;  
            IDictionary< string, IOperationInvoker> operationInvokers;  
            IDictionary< string, MethodInfo> methods;  
            Utility.Create< T>(out encoderFactory, out clientFormatters, out dispatchFormatters, out operationInvokers, out methods);  
            ServiceRealProxy< T> realProxy = new ServiceRealProxy< T>(messageVersion, remoteAddress, clientFormatters, encoderFactory);  
            return (T)realProxy.GetTransparentProxy();  
        }  
    }  
} 

那么在最終的客戶端代碼中就可以借助SerivceProxyFactory< T>創建服務代理進行服務調用了，而這里服務的目標地址實際上是上面用于模擬WCF服務端框架的.aspx Web Page的地址。

namespace Artech.WcfFrameworkSimulator.Client  
{  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            ICalculator calculator = SerivceProxyFactory< ICalculator>.Create(MessageVersion.Default, new Uri("http://localhost/Artech.WcfFrameworkSimulator/Calculator.aspx"));  
            double result = calculator.Add(1, 2);  
            Console.WriteLine("x + y = {2} when x = {0} and y = {1}", 1, 2, result);  
        }  
    }  
} 

執行結果：

x + y = 3 when x = 1 and y = 2

【編輯推薦】

1. WCF初試,用JQuery實現loading的功能
2. jQuery調用WCF服務傳遞JSON對象
3. WCF的傳輸安全機制
4. 詳解WCF中的變更處理：不可不知的最佳實踐
5. 使用ASP.NET AJAX調用WCF服務項模板