如何通过一个ASP.NET程序模拟WCF基本架构
如何通过一个ASP.NET程序模拟WCF基本架构,针对这个问题,这篇文章详细介绍了相对应的分析和解答,希望可以帮助更多想解决这个问题的小伙伴找到更简单易行的方法。
创新互联"三网合一"的企业建站思路。企业可建设拥有电脑版、微信版、手机版的企业网站。实现跨屏营销,产品发布一步更新,电脑网络+移动网络一网打尽,满足企业的营销需求!创新互联具备承接各种类型的成都网站建设、做网站项目的能力。经过10年的努力的开拓,为不同行业的企事业单位提供了优质的服务,并获得了客户的一致好评。
目的在于对WCF技术剖析的补充,对一些内容进行展开讲述,同时会囊括很多由于篇幅的原因忍痛割弃的内容。
我将会对WCF的基本架构作一个大致的讲解。不过,一改传统对WCF的工作流程进行平铺直叙,我将另辟蹊径,借助于我们熟悉的ASP.NET作为请求处理平台,通过一个简单的托管程序模拟整个WCF客户端和服务端的架构。
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框架模拟案例应用结构
步骤一、通过服务契约类型创建相关组件
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; } }
步骤三、实现服务端对服务调用请求的处理
我们通过一个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
关于如何通过一个ASP.NET程序模拟WCF基本架构问题的解答就分享到这里了,希望以上内容可以对大家有一定的帮助,如果你还有很多疑惑没有解开,可以关注创新互联行业资讯频道了解更多相关知识。
分享题目:如何通过一个ASP.NET程序模拟WCF基本架构
网站网址:http://pwwzsj.com/article/gidhjh.html