總結WebService的一些封裝技巧
今天早上起來，想談談.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，代碼如下：
- 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訪問。
原文鏈接：http://www.cnblogs.com/sxwgf/archive/2011/07/10/something-about-webservice.html
【編輯推薦】
