今天早上起来,想谈谈.NET中的WebService,当然我不想讲什么是WebService,或者怎么用WebService,因为那个大家 随便Google一下前100页都能找到答案。今天我想来分享一下我在用WebService中的一些技巧(至少我认为是技巧,还有点成就感),希望能给大家以后在用WebService时一点帮助和启发吧。
一、问题诞生 -- 大部分解决方案的背后总是一些头痛的问题
很早以前就用过传说中的WebService,但一直是用常规的思路在用:创建WebService项目-->写Web服务方法--> 在项目中添加Web引用-->调用Web方法。这样貌似很好,非常符合规范,在一段时间内效果也还可以,但渐渐的随着项目的扩大和同时参与项目的人员增多,就越来越觉得这种常规的方法很是不爽,为什么呢?我每次修改WebService端(添加、删除Web方法,以及修改方法名称),在引用端我都要更新WebService引用,其实是就是更新WSDL文件,很是烦人。
二、化分为合 -- 传说分久必合,合久必分
好吧,既然增加、删除、修改web方法名都会引起WSDL的更新,那么我们索性用一个统一的方法来作为webservice的访问入口吧,然后内部用switch case来区分调用哪个方法,先贴代码吧,再来简单讲讲:
统一访问接口IRemoteCall:
publicinterfaceIRemoteCall
{byte[] GeneralCall(stringmethodName,paramsbyte[] param);
}
然后定义一个WebService并实现以上接口(以前还没真在webservice上实现过接口,哈哈):
[WebService(Namespace="http://tempuri.org/")]
[WebServiceBinding(ConformsTo=WsiProfiles.BasicProfile1_1)]
[ToolboxItem(false)]publicclassBlogService : System.Web.Services.WebService, IRemoteCall
{
[WebMethod(EnableSession=true)]publicbyte[] GeneralCall(stringmethodName,paramsbyte[] param)
{switch(methodName)
{case"LoadBlog":
{longblogId=Serializer.DeserializeToObject(param);
BLLBlogArtical ba=newAppBlog().LoadBlog(blogId);returnSerializer.SerializeToBinary(ba);
}case"DeleteBlog":
{//To Do Your Codereturnnull;
}
}
}
}
这里为什么要定义接口IRemoteCall呢,主要是为接下来统一调用webservice服务的,所有实现这个接口的webservice类都可以通过GeneralCall来完成调用,待会将webservice访问器的时候会具体讲到,这里主要讲讲这个switch case。
这里我们定义了一个统一的访问入口
byte[] GeneralCall(string methodName,params byte[] param)
意思是:传入要调用的方法名称以及序列化后的参数,返回序列化后的结果。这里为了统一数据,我们均对参数和返回值都序列化成byte数组,即用Serializer.SerializeToBinary(object)来实现,这样所有调用就都统一了格式。
有人可能会提出质疑,这样方法名称都已字符串形式是不是会显得难看,而且字符串容易出错,还没有智能提示?那也好解决,我们可以把方法名称定义成const常量就可以了。这里我对webservice的一个态度是:webservice层就是完成转接和调度工作的,它仅仅起到承接的作用,用了他可以将服务任意分布,所以里面是没有任何逻辑的(逻辑都是被封装在其他dll中的),最多是一些数据转换,所以我采用了这种模糊接口的方式。
三、自定义webservice访问器,爽死客户端
上面我们完成了webservice端的工作,接下来就来实现客户端对webservice的灵活调用,这里上面定义的那个IRemoteCall就起到作用了,首先我们定义一个webservice访问器类RemoteCaller,代码如下:
View Code
usingSystem;usingSystem.Collections.Generic;usingSystem.Text;usingSystem.Collections;usingSystem.Web.Services.Protocols;usingSharedLib_403;namespaceITIvy.Shared.RemoteCaller
{//远程接口访问器///publicclassRemoteCaller
{privatestring_MethodName;privatebyte[] _ParamByte;privateIRemoteCall _Caller;privateArrayList _Params;//参数列表///publicArrayList Params
{get{return_Params; }set{ _Params=value; }
}//序列化后的参数///publicbyte[] ParamByte
{get{return_ParamByte; }set{ _ParamByte=value; }
}//远程服务方法名称///publicstringMethodName
{get{return_MethodName; }set{ _MethodName=value; }
}//远程服务调用接口///publicIRemoteCall Caller
{get{return_Caller; }set{ _Caller=value; }
}//构造//Webservice远程接口publicRemoteCaller(IRemoteCall caller)
{
_Caller=caller;
_Params=newArrayList();
}//调用远程接口//方法名称///参数对象///publicbyte[] Call(stringmethodName,objectparam)
{try{
_MethodName=methodName;
_ParamByte=Serializer.SerializeToBinary(param);return_Caller.GeneralCall(_MethodName, _ParamByte);
}catch(Exception ex)
{if(exisSoapException)thrownewException(((SoapException)ex).Detail["Message"].InnerText);elsethrowex;
}
}//调用远程接口//方法名称///参数列表///publicbyte[] Call(stringmethodName, ArrayList param)
{try{
_MethodName=methodName;
_Params=param;
_ParamByte=Serializer.SerializeToBinary(_Params);return_Caller.GeneralCall(_MethodName, _ParamByte);
}catch(Exception ex)
{if(exisSoapException)thrownewException(((SoapException)ex).Detail["Message"].InnerText);elsethrowex;
}
}//调用远程接口//方法名称///参数对象数组///publicbyte[] Call(stringmethodName,paramsobject[] param)
{try{foreach(objectobjinparam)
_Params.Add(obj);
_MethodName=methodName;
_ParamByte=Serializer.SerializeToBinary(_Params);return_Caller.GeneralCall(_MethodName, _ParamByte);
}catch(Exception ex)
{if(exisSoapException)thrownewException(((SoapException)ex).Detail["Message"].InnerText);elsethrowex;
}
}//调用远程接口//publicbyte[] Call()
{try{if(string.IsNullOrEmpty(_MethodName))thrownewException("远程方法不能为空!");return_Caller.GeneralCall(_MethodName, _ParamByte);
}catch(Exception ex)
{if(exisSoapException)thrownewException(((SoapException)ex).Detail["Message"].InnerText);elsethrowex;
}
}//调用远程接口//返回值类型///publicT Call()
{byte[] resultByte=Call();returnSerializer.DeserializeToObject(resultByte);
}//调用远程接口//返回值类型///方法名称///参数列表///publicT Call(stringmethodName, ArrayList param)
{byte[] resultByte=Call(methodName, param);returnSerializer.DeserializeToObject(resultByte);
}publicT Call(stringmethodName,objectparam)
{try{
_MethodName=methodName;
_ParamByte=Serializer.SerializeToBinary(param);byte[] resultByte=_Caller.GeneralCall(_MethodName, _ParamByte);returnSerializer.DeserializeToObject(resultByte);
}catch(Exception ex)
{if(exisSoapException)thrownewException(((SoapException)ex).Detail["Message"].InnerText);elsethrowex;
}
}//调用远程接口//返回值类型///方法名称///参数对象数组///publicT Call(stringmethodName,paramsobject[] param)
{byte[] resultByte=Call(methodName, param);returnSerializer.DeserializeToObject(resultByte);
}
}
}
这个访问器主要是定义了一系列访问接口的重载,利用了c#的泛型更加使接口简单了。哈哈,这个类就能让我们实现一句话调用webservice,相当简洁。注意里面的IRemoteCall属性,就是只要传入实现了该接口的类,就都可以通过该访问器来访问webservice。如何使用该类呢,下面给一个例子吧:
IRemoteCall Caller=newBlogService.BlogService();
BLLBlogArtical bllArtical=newRemoteCaller(Caller).Call("LoadBlog", id);
抱歉,说错了,要两句话来调用,但是这里少去了很多数据转换的工作,因为有了泛型,呵呵,而且我可以在RemoteCaller这个访问器类中做很多工作,比如异常处理,权限验证等等。
四、总结 -- 写了这么多不总结可不行
这个实现方法的核心在于用IRemoteCall接口来规范webservice类的实现方式均为统一GenerateCall,然后 webservice类中通过switch case来将所有方法整合在一起,避免频繁更新WSDL的麻烦,最后客户端利用IRemoteCall定义一个webservice访问器类 RemoteCaller来提供统一的webservice访问。小技巧,呵呵,请大家笑纳,有什么不对的地方请指出...
另外,最近又想开始写点东西,冒昧的欢迎各位有空去我的博客逛逛,没什么太好的技术,自己写的blog程序挂在网上,就是想交一些朋友,别无他意。地址:http://www.itivy.com/ivy
不好意思,上面引用的那个SharedLib_403中有序列化和反序列化的代码,一时忘记贴出来了,现在补上:
View Code
usingSystem;usingSystem.Collections.Generic;usingSystem.Text;usingSystem.IO;usingSystem.Runtime.Serialization.Formatters.Binary;usingSystem.Xml;namespaceSharedLib_403
{publicclassSerializer
{//把对象序列化成二进制流//需要序列化的对象///publicstaticbyte[] SerializeToBinary(objectobj)
{if(obj==null)
{returnnull;
}
MemoryStream stream=newMemoryStream();newBinaryFormatter().Serialize(stream, obj);
stream.Position=0L;byte[] buffer=newbyte[stream.Length];
stream.Read(buffer,0, buffer.Length);
stream.Close();returnbuffer;
}//把二进制流反序列化成对象//需要反序列化的二进制流///publicstaticobjectDeserializeToObject(byte[] bytes)
{objectobj=null;if(bytes!=null)
{
MemoryStream stream=newMemoryStream(bytes);
stream.Position=0L;
obj=newBinaryFormatter().Deserialize(stream);
stream.Close();
}returnobj;
}//把二进制流反序列化成对象//对象类型///需要反序列化的二进制流///publicstaticT DeserializeToObject(byte[] bytes)
{objectobj=DeserializeToObject(bytes);return(T)obj;
}
}
}