对WebService的一些封装技巧总结

  1. 云栖社区>
  2. 博客>
  3. 正文

对WebService的一些封装技巧总结

技术小甜 2017-11-09 13:48:00 浏览511
展开阅读全文

http://www.cnblogs.com/sxwgf/archive/2011/07/10/something-about-webservice.html

今天早上起来,想谈谈.NET中的WebService,当然我不想讲什么是 WebService,或者怎么用WebService,因为那个大家 随便Google一下前100页都能找到答案。今天我想来分享一下我在用WebService中的一些技巧(至少我认为是技巧,还有点成就感),希望能给 大家以后在用WebService时一点帮助和启发吧。

一、问题诞生 -- 大部分解决方案的背后总是一些头痛的问题

很早以前就用过传说中的WebService,但一直是用常规的思路在用:创建WebService项目-->写Web服务方法--> 在项目中添加Web引用-->调用Web方法。这样貌似很好,非常符合规范,在一段时间内效果也还可以,但渐渐的随着项目的扩大和同时参与项目的人 员增多,就越来越觉得这种常规的方法很是不爽,为什么呢?我每次修改WebService端(添加、删除Web方法,以及修改方法名称),在引用端我都要 更新WebService引用,其实是就是更新WSDL文件,很是烦人。

二、化分为合 -- 传说分久必合,合久必分

好吧,既然增加、删除、修改web方法名都会引起WSDL的更新,那么我们索性用一个统一的方法来作为webservice的访问入口吧,然后内部用switch case来区分调用哪个方法,先贴代码吧,再来简单讲讲:

统一访问接口IRemoteCall:

public interface IRemoteCall
{
byte[] GeneralCall(string methodName, params byte[] param);
}

然后定义一个WebService并实现以上接口(以前还没真在webservice上实现过接口,哈哈):

[WebService(Namespace = "http://tempuri.org/")]
[WebServiceBinding(ConformsTo 
= WsiProfiles.BasicProfile1_1)]
[ToolboxItem(
false)]
public class BlogService : System.Web.Services.WebService, IRemoteCall
{
[WebMethod(EnableSession 
= true)]
public byte[] GeneralCall(string methodName, params byte[] param)
{
switch (methodName)
{
case "LoadBlog":
{
long blogId = Serializer.DeserializeToObject<long>(param);
BLLBlogArtical ba 
= new AppBlog().LoadBlog(blogId);
return Serializer.SerializeToBinary(ba);
}
case "DeleteBlog":
{
//To Do Your Code
return null;
}
}
}
}
这里为什么要定义接口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
using System;
using System.Collections.Generic;
using System.Text;
using System.Collections;
using System.Web.Services.Protocols;
using SharedLib_403;

namespace ITIvy.Shared.RemoteCaller
{

/// <summary>
/// 远程接口访问器
/// </summary>
public class RemoteCaller
{
private string _MethodName;
private byte[] _ParamByte;
private IRemoteCall _Caller;
private ArrayList _Params;

/// <summary>
/// 参数列表
/// </summary>
public ArrayList Params
{
get { return _Params; }
set { _Params = value; }
}

/// <summary>
/// 序列化后的参数
/// </summary>
public byte[] ParamByte
{
get { return _ParamByte; }
set { _ParamByte = value; }
}

/// <summary>
/// 远程服务方法名称
/// </summary>
public string MethodName
{
get { return _MethodName; }
set { _MethodName = value; }
}

/// <summary>
/// 远程服务调用接口
/// </summary>
public IRemoteCall Caller
{
get { return _Caller; }
set { _Caller = value; }
}

/// <summary>
/// 构造
/// </summary>
/// <param name="caller">Webservice远程接口</param>
public RemoteCaller(IRemoteCall caller)
{
_Caller 
= caller;
_Params 
= new ArrayList();
}

/// <summary>
/// 调用远程接口
/// </summary>
/// <param name="methodName">方法名称</param>
/// <param name="param">参数对象</param>
/// <returns></returns>
public byte[] Call(string methodName, object param)
{
try
{
_MethodName 
= methodName;
_ParamByte 
= Serializer.SerializeToBinary(param);
return _Caller.GeneralCall(_MethodName, _ParamByte);
}
catch (Exception ex)
{
if (ex is SoapException)
throw new Exception(((SoapException)ex).Detail["Message"].InnerText);
else
throw ex;
}
}

/// <summary>
/// 调用远程接口
/// </summary>
/// <param name="methodName">方法名称</param>
/// <param name="param">参数列表</param>
/// <returns></returns>
public byte[] Call(string methodName, ArrayList param)
{
try
{
_MethodName 
= methodName;
_Params 
= param;
_ParamByte 
= Serializer.SerializeToBinary(_Params);
return _Caller.GeneralCall(_MethodName, _ParamByte);
}
catch (Exception ex)
{
if (ex is SoapException)
throw new Exception(((SoapException)ex).Detail["Message"].InnerText);
else
throw ex;
}
}

/// <summary>
/// 调用远程接口
/// </summary>
/// <param name="methodName">方法名称</param>
/// <param name="param">参数对象数组</param>
/// <returns></returns>
public byte[] Call(string methodName, params object[] param)
{
try
{
foreach (object obj in param)
_Params.Add(obj);
_MethodName 
= methodName;
_ParamByte 
= Serializer.SerializeToBinary(_Params);
return _Caller.GeneralCall(_MethodName, _ParamByte);
}
catch (Exception ex)
{
if (ex is SoapException)
throw new Exception(((SoapException)ex).Detail["Message"].InnerText);
else
throw ex;
}
}

/// <summary>
/// 调用远程接口
/// </summary>
/// <returns></returns>
public byte[] Call()
{
try
{
if (string.IsNullOrEmpty(_MethodName))
throw new Exception("远程方法不能为空!");
return _Caller.GeneralCall(_MethodName, _ParamByte);
}
catch (Exception ex)
{
if (ex is SoapException)
throw new Exception(((SoapException)ex).Detail["Message"].InnerText);
else
throw ex;
}
}

/// <summary>
/// 调用远程接口
/// </summary>
/// <typeparam name="T">返回值类型</typeparam>
/// <returns></returns>
public T Call<T>()
{
byte[] resultByte = Call();
return Serializer.DeserializeToObject<T>(resultByte);
}

/// <summary>
/// 调用远程接口
/// </summary>
/// <typeparam name="T">返回值类型</typeparam>
/// <param name="methodName">方法名称</param>
/// <param name="param">参数列表</param>
/// <returns></returns>
public T Call<T>(string methodName, ArrayList param)
{
byte[] resultByte = Call(methodName, param);
return Serializer.DeserializeToObject<T>(resultByte);
}

public T Call<T>(string methodName, object param)
{
try
{
_MethodName 
= methodName;
_ParamByte 
= Serializer.SerializeToBinary(param);
byte[] resultByte = _Caller.GeneralCall(_MethodName, _ParamByte);
return Serializer.DeserializeToObject<T>(resultByte);
}
catch (Exception ex)
{
if (ex is SoapException)
throw new Exception(((SoapException)ex).Detail["Message"].InnerText);
else
throw ex;
}
}

/// <summary>
/// 调用远程接口
/// </summary>
/// <typeparam name="T">返回值类型</typeparam>
/// <param name="methodName">方法名称</param>
/// <param name="param">参数对象数组</param>
/// <returns></returns>
public T Call<T>(string methodName, params object[] param)
{
byte[] resultByte = Call(methodName, param);
return Serializer.DeserializeToObject<T>(resultByte);
}
}
}

这个访问器主要是定义了一系列访问接口的重载,利用了c#的泛型更加使接口简单了。哈哈,这个类就能让我们实现一句话调用webservice,相 当简洁。注意里面的IRemoteCall属性,就是只要传入实现了该接口的类,就都可以通过该访问器来访问webservice。如何使用该类呢,下面 给一个例子吧:

IRemoteCall Caller = new BlogService.BlogService();
BLLBlogArtical bllArtical 
= new RemoteCaller(Caller).Call<BLLBlogArtical>("LoadBlog", id);
抱歉,说错了,要两句话来调用,但是这里少去了很多数据转换的工作,因为有了泛型,呵呵,而且我可以在RemoteCaller这个访问器类中做很多工作,比如异常处理,权限验证等等。

四、总结 -- 写了这么多不总结可不行

这个实现方法的核心在于用IRemoteCall接口来规范webservice类的实现方式均为统一GenerateCall,然后 webservice类中通过switch case来将所有方法整合在一起,避免频繁更新WSDL的麻烦,最后客户端利用IRemoteCall定义一个webservice访问器类 RemoteCaller来提供统一的webservice访问。小技巧,呵呵,请大家笑纳,有什么不对的地方请指出...

另外,最近又想开始写点东西,冒昧的欢迎各位有空去我的博客逛逛,没什么太好的技术,自己写的blog程序挂在网上,就是想交一些朋友,别无他意。地址:http://www.itivy.com/ivy

不好意思,上面引用的那个SharedLib_403中有序列化和反序列化的代码,一时忘记贴出来了,现在补上:

View Code
using System;
using System.Collections.Generic;
using System.Text;
using System.IO;
using System.Runtime.Serialization.Formatters.Binary;
using System.Xml;

namespace SharedLib_403
{
public class Serializer
{
/// <summary>
/// 把对象序列化成二进制流
/// </summary>
/// <param name="obj">需要序列化的对象</param>
/// <returns></returns>
public static byte[] SerializeToBinary(object obj)
{
if (obj == null)
{
return null;
}

MemoryStream stream 
= new MemoryStream();

new BinaryFormatter().Serialize(stream, obj);
stream.Position 
= 0L;
byte[] buffer = new byte[stream.Length];
stream.Read(buffer, 
0, buffer.Length);
stream.Close();
return buffer;
}

/// <summary>
/// 把二进制流反序列化成对象
/// </summary>
/// <param name="bytes">需要反序列化的二进制流</param>
/// <returns></returns>
public static object DeserializeToObject(byte[] bytes)
{
object obj = null;
if (bytes != null)
{
MemoryStream stream 
= new MemoryStream(bytes);
stream.Position 
= 0L;
obj 
= new BinaryFormatter().Deserialize(stream);
stream.Close();
}
return obj;
}

/// <summary>
/// 把二进制流反序列化成对象
/// </summary>
/// <typeparam name="T">对象类型</typeparam>
/// <param name="bytes">需要反序列化的二进制流</param>
/// <returns></returns>
public static T DeserializeToObject<T>(byte[] bytes)
{
object obj = DeserializeToObject(bytes);
return (T)obj;
}

}
}
















本文转自cnn23711151CTO博客,原文链接:http://blog.51cto.com/cnn237111/617461 ,如需转载请自行联系原作者





网友评论

登录后评论
0/500
评论
技术小甜
+ 关注