Index :
(3)字符串、集合與流
(4)委托、事件、反射與特性
(5)多線程開發基礎
(7)WebService的開發與應用基礎
一、SOAP和Web Service的基本概念
Web Service基於SOAP協議,而SOAP本身符合XML語法規范。雖然.NET為Web Service提供了強大的支持,但了解其基本機制對於程序員來說仍然是必需的。
1.1 神馬是SOAP協議?
SOAP協議的全稱是簡單對象訪問協議(Simple Object Access Protocol),SOAP致力於以XML形式提供一個簡單、輕量的用於在分散或分布環境中交換結構化和類型信息的機制。SOAP只規范對象訪問的方式,而不限制具體實現的技術環境,這意味着SOAP協議是一種跨平台的協議:一個.NET客戶端程序可以按照SOAP協議訪問一個基於JavaEE技術體系結構的Web Service。SOAP訪問仍然基於HTTP協議,同時其內容又以XML形式展現。
SOAP規范由四部分組成:
① SOAP信封(SOAP envelop)
② SOAP編碼規則(SOAP encoding rules)
③ SOAP RPC表示(SOAP RPC representation)
④ SOAP綁定(SOAP binding)
這里不對這四部分展開介紹,通過下面的一個小例子來直觀地認識一下。
(1)在Web服務端,打算對外提供一個公共方法來供客戶端調用,而客戶端則需要提供這個方法需要的參數,並且最終得到返回值。假設這個方法被申明在MySimpleService.asmx文件中:
[WebMethod] public string GetSumString(int para1, int para2) { int result = para1 + para2; return result.ToString(); }
(2)當客戶端試圖使用這個Web Service方法時,就需要向服務器端發出這樣的一個HTTP請求:
POST /MySimpleService.asmx HTTP/1.1 Host: localhost Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://tempuri.org/GetSumString" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <GetSumString xmlns="http://tempuri.org/"> <para1>250</para1> <para2>250</para2> </GetSumString> </soap:Body> </soap:Envelope>
(3)等到Web Service服務器端接收到上面的請求之后,就可以進行相應的邏輯處理,並且返回結果。根據SOAP協議,HTTP響應如下形式:
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <GetSumStringResponse xmlns="http://tempuri.org/"> <GetSumStringResult>500</GetSumStringResult> </GetSumStringResponse> </soap:Body> </soap:Envelope>
如此一來,客戶端就得到了服務端的處理結果,換句話說,客戶端已經得到了Web Service提供的服務。
PS:最后,再說一下SOAP協議和HTTP協議,它們的關系非常類似於網絡分層中的上下層協議,使用SOAP協議的雙方將SOAP數據包放入HTTP報文之中,並且通過HTTP協議完成實際的傳輸,換句話說,SOAP是對HTTP的一個封裝,下圖說明了這一過程:
1.2 WSDL又是什么鬼,它有啥作用?
(1)WSDL介紹
WSDL(Web Service Description Language)是Web服務描述語言,它是一種由微軟、IBM、Intel等大型供應商提出的語言規范,目的就是為了描述Web服務器所提供的服務,以供使用者參考。WSDL是一種復合XML語法規范的語言,它的設計完全基於SOAP協議,當一個Web Service服務器期望為使用者提供服務說明時,WSDL是最好的選擇之一。
這里仍以上面的實例來說明,在Web服務端提供了這樣一個方法:
string GetSumString(int para1, int para2)
當服務端視圖利用WSDL告訴客戶端如何使用該方法時,就會提供下面的這樣一個WSDL文件(仍然是一個XML):
<?xml version="1.0" encoding="utf-8"?> <wsdl:definitions xmlns:tm="http://microsoft.com/wsdl/mime/textMatching/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/" xmlns:tns="http://tempuri.org/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:s="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/" xmlns:http="http://schemas.xmlsoap.org/wsdl/http/" targetNamespace="http://tempuri.org/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"> <wsdl:types> <s:schema elementFormDefault="qualified" targetNamespace="http://tempuri.org/"> <s:element name="GetSumString"> <s:complexType> <s:sequence> <s:element minOccurs="1" maxOccurs="1" name="para1" type="s:int" /> <s:element minOccurs="1" maxOccurs="1" name="para2" type="s:int" /> </s:sequence> </s:complexType> </s:element> <s:element name="GetSumStringResponse"> <s:complexType> <s:sequence> <s:element minOccurs="0" maxOccurs="1" name="GetSumStringResult" type="s:string" /> </s:sequence> </s:complexType> </s:element> </s:schema> </wsdl:types> <wsdl:message name="GetSumStringSoapIn"> <wsdl:part name="parameters" element="tns:GetSumString" /> </wsdl:message> <wsdl:message name="GetSumStringSoapOut"> <wsdl:part name="parameters" element="tns:GetSumStringResponse" /> </wsdl:message> <!-- 這里省略其他定義 --> </wsdl:definitions>
如上xml所示,在<wsdl:types>節點下,WSDL定義了GetSumString方法的名字:
<s:element name="GetSumString">
參數數量、每個參數的類型:
<s:complexType> <s:sequence> <s:element minOccurs="1" maxOccurs="1" name="para1" type="s:int" /> <s:element minOccurs="1" maxOccurs="1" name="para2" type="s:int" /> </s:sequence> </s:complexType>
以及返回參數的類型:
<s:element name="GetSumStringResponse"> <s:complexType> <s:sequence> <s:element minOccurs="0" maxOccurs="1" name="GetSumStringResult" type="s:string" /> </s:sequence> </s:complexType> </s:element>
通過完整的描述,使用者就能夠了解如何使用該Web服務了。
(2)獲取和使用WSDL
當Web Service服務器提供WSDL時,就可以通過特定的工具獲得WSDL文件。最直接的方式就是在URL中直接添加WSDL參數,來發送得到WSDL文件的請求,如下所示:
http://localhost:6105/MySimpleService.asmx?wsdl
這時點擊回車就可以得到如下圖所示的WSDL結果:

1.3 Web Service中如何處理附件?
盡管Web Service提供的方法的參數類型沒有任何限制,也就意味着所有的附件可以通過字節數組來進行傳遞,但是把字節流直接內嵌在SOAP消息的做法有很多問題,這也曾經成為XML語法和SOAP協議被詬病的原因。這里主要介紹一下XOP的概念。
在XOP出現之前,SOAP處理二進制數據的方式都很簡單,比如當一個Web Service服務端提供了如下的方法時:
void UploadSmallAttach(Byte[] attachment)
客戶端調用該Web Service,只需要發出下面這樣的SOAP請求即可:
<?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <UploadSmallAttach xmlns="http://tempuri.org/"> <attachment>D0CF11E0A1B11AE100000000000000000000000003E0000300FEFF09000600000000000000000000000600000000000000000000DE0200000000000000000000001000000000000000FEFFFFFFFF00000000000000000000D80200000000000D9020000DA02000DB02000000DC020000DD0200000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF</attachment> </UploadSmallAttach> </soap:Body> </soap:Envelope>
如上所示,其中<attachment>節點下的一大堆字符,就是某個文件的字節流。通過這種方式,確實是可以實現傳送二進制附件的功能的,但這樣的處理過於粗略,且傳輸沒有任何優化。W3C為此特別指定了XOP規范。
XOP(XML-binary Optimized Packages)意為XML二進制打包,它把二進制數據流從SOAP消息中分離出來,進行單獨打包。上述的客戶端請求如果使用XOP規范的話,將轉變為如下結果:
<?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <UploadSmallAttach xmlns="http://tempuri.org/"> <attachment>
<xop:Include xmlns="http://www.w3.org/2015/10/02/xop/include" href="cid:http://www.book.com/attachment.png" />
</attachment> </UploadSmallAttach> </soap:Body> </soap:Envelope>
可以看到,原本出現在二進制字節流的地方,被轉換成了一個引用:
<attachment> <xop:Include xmlns="http://www.w3.org/2015/10/02/xop/include" href="cid:http://www.book.com/attachment.png" /> </attachment>
這樣整個SOAP信封節點下就不再包含任何二進制直接,而福建則被安放在另一個MIME體中:
Content-Type: image/png Content-Transfer-Encoding: binary Content-ID: <sample@book.com> D0CF11E0A1B11AE100000000000000000000000003E0000300FEFF09000600000000000000000000000600000000000000000000DE0200000000000000000000001000000000000000FEFFFFFFFF00000000000000000000D80200000000000D9020000DA02000DB02000000DC020000DD0200000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
二、使用.NET開發Web Service
.NET為Web Service提供了全面的支持,無論是創建Web Service還是訪問Web Service,使用.NET都能快速有效地完成需求。
2.1 如何在.NET中創建Web Service?
(1)使用WebMethod特性創建Web Service
在.NET中,所有Web Service的資源被定義為asmx文件,而在ASP.NET被安裝時,asmx文件也會在IIS中被注冊成由ASP.NET組件來處理。也就是說,一個asmx文件和其后台代碼asmx.cs組成了一個Web Service資源。
為了讓我們能夠把注意力集中在邏輯的處理上,而忽略SOAP通信的工作,.NET提供了Web Service類型和WebMethod特性。在繼承自Web Service類型的公共方法上添加WebMethod特性,就可以申明為一個Web Service方法。
① 創建一個Web服務

② asmx文件只是簡單地聲明了后台代碼的位置,而不包含任何工作代碼。后台代碼都在asmx.cs中:
/// <summary> /// MySimpleService 的摘要說明 /// </summary> [WebService(Namespace = "http://tempuri.org/")] [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)] [System.ComponentModel.ToolboxItem(false)] // 若要允許使用 ASP.NET AJAX 從腳本中調用此 Web 服務,請取消注釋以下行。 // [System.Web.Script.Services.ScriptService] public class MySimpleService : System.Web.Services.WebService { [WebMethod] public string GetSumString(int para1, int para2) { int result = para1 + para2; return result.ToString(); } }
Luckily,WebService和WebMethod為我們提供了完全包裝好的SOAP處理功能,而在大多數情況下,我們所要做的就是繼承和使用它們。
(2)創建自定義的類型來處理對asmx文件的請求
在ASP.NET的處理機制中,所有的HTTP請求通道都通過管道來尋找處理程序。我們所熟悉的WebForm和WebService,都是實現了IHttpHandler接口的Http處理程序,這導致了它們有能力處理特定的Http請求。事實上,我們可以通過配置Web.config來自定義Http處理程序和資源的映射匹配關系,如同下面的配置所展示的一樣:
<httpHandlers> <add verb="*" path="*.ashx" type="System.Web.UI.SimpleHandlerFactory"/> <add verb="*" path="*.aspx" type="System.Web.UI.PageHandlerFactory"/> <add verb="*" path="*.asmx" type="System.Web.Services.Protoclos.WebServiceHandlerFactory"/> </httpHandlers>
實現IHttpHandler接口很簡單,必須的工作就僅僅是實現一個ProcessRequest方法和一個只讀屬性:
public void ProcessRequest(HttpContext context) public bool IsReusable
在HttpContext類型的上下文對象中包含了Http請求(HttpRequest),也包含了Http返回類型對象(HttpResponse),並且允許程序員往里面寫入希望的返回內容。IsReusable屬性則返回當前對象是否可被重用來應對所有類似的Http請求。
鑒於此,我們可以自己實現一個實現IHttpHandler接口的處理程序,在配置文件中將其綁定到.asmx文件上,就可以實現Web Service方法了。當然,為了符合SOAP規范,我們需要在ProcessRequest方法中解析SOAP請求,並且把返回值放入一個SOAP包中。
下面的代碼示例展示了如何自定義asmx處理程序(這里只展示了如何編寫實現IHttpHandler接口的類型並使其工作,省略了繁瑣的SOAP解析和組織工作)
① 新建一個ashx程序,實現IHttpHandler接口
/// <summary> /// MySimpleHandler 的摘要說明 /// </summary> public class MySimpleHandler : IHttpHandler { public void ProcessRequest(HttpContext context) { context.Response.Write("<h1>Hello Web Service!</h1>"); } public bool IsReusable { get { return true; } } }
② 修改Web.config文件,加入自定義HttpHandler類型
<add verb="*" path="*.asmx" type="MyWebApp.MySimpleHandler,MyWebApp"/>
(3)自定義Web Service資源文件和處理程序
事實上,我們完全可以定義一種新的資源文件而不是采用asmx文件名,只要我們為其定制HttpHandler程序。需要做的工作為:
① 定義一個新的文件格式如asnew,在IIS中匹配asnew和aspnet_isapi.dll處理程序;
② 自定義一個實現了IHttpHandler接口的類型,在這個類型中實現SOAP;
③ 在需要使用asnew文件的站點配置文件中綁定asnew和新的Http處理類型;
這樣的方案顯然可以為系統帶來更大的靈活性,但同時也意味着更大的代碼量。下圖展示了三種實現Web Service的方法之間的關系:

2.2 WebMethod特性包含哪些屬性,各有神馬用處?
WebMethod特性在Web Service中被用來申明一個公開方法,了解其使用方法是在正確編寫Web Service的基礎。在WebMethod特性中,一共包含了6個屬性,這6個屬性對WebMethod的使用非常重要。
(1)BufferResponse屬性
該屬性表明是否啟用對Web Service方法響應的緩沖。當設置為true時,Web Service方法將響應序列化到內存緩沖區中,直到緩存區被用滿或者響應結束后,響應才會被發送給客戶端。相反,設置為false時,.NET默認以16KB的塊區緩沖響應,響應在被序列化的同時將會被不斷發送給客戶端,無論該響應是否已經完全結束。
PS:默認BufferResponse被設置為true。當Web Service要發送大量數據流給客戶端時,設置BufferResponse為false時可以防止大規模數據一次性刷新到內存,而對於小量數據,設置為true則可以有效地提高性能。
(2)EnableSession屬性
該屬性指定是否啟用會話狀態。如果為true,則啟用,為fasle則禁用。默認被設置為false。
public class MySimpleService : System.Web.Services.WebService { [WebMethod(EnableSession = true)] public string WithSession() { return TryGetSession(); } [WebMethod(EnableSession = false)] public string WithoutSession() { return TryGetSession(); } private string TryGetSession() { if (Session == null) { return "Session is Forbidden"; } if (Session["number"] == null) { Session["number"] = 0; } Session["number"] = (int)Session["number"] + 1; return Session["number"].ToString(); } }
分別訪問WithSession和WithoutSession方法,結果如下圖所示:

(3)CacheDuration屬性
該屬性指示啟用對Web Service方法結果的緩存。服務端將會緩存每個唯一參數集的結果,該屬性的值指定服務器端應該對結果進行多少秒的緩存處理。如果該值為0,則禁用對結果進行緩存;如果不為零,則啟用緩存,單位為秒,意為設置多少秒的緩存時間。默認該值被設為0。
[WebMethod(CacheDuration = 10, EnableSession = true)] public string WithCache() { if (Session["number"] == null) { Session["number"] = 0; } Session["number"] = (int)Session["number"] + 1; return Session["number"].ToString(); }
上面的WithCache方法設置了10秒的緩存時間,即10秒內的訪問都會得到一樣的結果。
(4)Description屬性
該屬性很簡單,提供了對某個Web Service方法的說明,並且會顯示在服務幫助頁上面。
(5)MessageName屬性
該屬性是Web Service能夠唯一確定使用別名的重載方法。除非另外指定,默認值是方法名稱。當指定MessageName時,結果SOAP消息將反映該名稱,而不是實際的方法名稱。
當Web Service提供了兩個同名的方法時,MessageName屬性會很有用,這一點將會體現在WSDL中:
[WebMethod(MessageName="HelloWorld1")] public string HelloWorld(int num) { return num.ToString(); } [WebMethod(MessageName = "HelloWorld2")] public string HelloWorld() { return "Hello World!"; }
(6)TransactionOption屬性
該屬性用以設置Web Service方法的事務特性,在.NET中事務模型是基於聲明性的,而不是編寫特定的代碼來處理提交和回滾事務。在Web Service中,可以通過TransactionOption屬性來設置該方法是否需要被放入一個事務之中。如果申明了事務屬性,執行Web Service方法時引發異常會自動終止事務,相反如果未發生任何異常,則自動提交事務。
事務最常用的一個場景就是數據庫訪問,所以該屬性在利用Web Service實現的分布式數據庫訪問中就特別有用。
2.2 如何生成Web Service代理類型?
(1)Web Service代理類的概念
所謂的代理類,就是SOAP協議的代理類型,它使得我們可以通過調用本地的類型方法(代理類),來達到訪問Web Service方法的目的。代理類的最終目的就是將程序員從繁瑣的SOAP消息處理和XML解析中解放出來,而專注於邏輯工作。下圖說明了代理類的作用:

(2)如何生成Web Service代理類
在Visual Studio中提供了一個很簡單的生成Web Service代理類的方法就是Web引用,如下圖所示:

當Web引用被添加后,一個代理類型也會自動生成。並且,當服務端的Web Service更新后,我們只需要簡單地更新一下Web引用,就可以方便地更新代理類型。

在客戶端邏輯中,只需要調用代理類的對應接口就OK,十分簡單:
class Program { static void Main(string[] args) { using (MySimpleServiceSoapClient proxy = new MySimpleServiceSoapClient()) { string result = proxy.GetSumString(250, 250); Console.WriteLine("250+250={0}", result); } Console.ReadKey(); } }
執行結果為:

2.3 簡述.NET中Web Service的異常機制
即使有了本地的代理類,調用Web Service方法還是調用本地方法有所區別,如果Web Service出現了異常,那么這些異常信息就需要被封裝在SOAP信息中發送回客戶端。
(1)SOAP中對異常的規定
SOAP規定了異常信息的攜帶方式,那就是全被放入fault節點中。fault節點必須是Body節點的子節點,而且一個SOAP消息只能出現一個fault節點。
| 子節點 | 描述 |
| <faultcode> | 識別故障的代碼 |
| <faultstring> | 供認閱讀的有關故障的說明 |
| <faultactor> | 是誰引發異常 |
| <detail> | 存留設計Body元素的應用程序專用錯誤信息 |
其中faultcode是一個錯誤碼,其取值和每個值所代表的含義都在SOAP中有所定義,下表列出了所有faultcode及其含義:
| faultcode節點值 | 描述 |
| VersionMismatch | SOAP Envelop元素的無效命名空間被發現 |
| MustUnderstand | Header元素的一個直接子元素無法被理解 |
| Client | 消息被不正確地構成,或包含了不正確的信息 |
| Server | 服務器有問題,因此無法處理進行下去 |
(2)服務端對未捕獲異常的處理
在使用WebService類型和WebMethod特性創建Web Service的情況下,服務器端的異常都會被捕捉,並且所有異常都會被放入到SoapException類型中,並且返回給客戶端。我們可以在服務端代碼中直接使用SoapException異常,通過設置其屬性來告知客戶端:
① Message:原始異常的Message屬性
② Code:服務器異常碼
③ Actor:Web Service方法的URL
④ Detail:空引用,但有一個空的詳細信息元素存在於故障元素之中
服務端會把SoapException放入Fault節點之中並返回給客戶端,以此來告知服務端發生的異常。
(3)客戶端代理類對fault節點的處理
如果使用.NET自動生成的Web Service代理類,那么它將能夠自動地識別fault節點,並且還原為SoapException異常。這里可以通過下面的一段代碼示例來直觀地了解這一點:
① 首先在Web Service方法中直接拋出一個異常,如下代碼所示:
[WebMethod] public string HelloException() { // 直接拋出一個異常,該異常會被包裝為SoapException throw new Exception("發生了一個異常!"); }
② 其次根據這個Web Service在本地生成對應代理類,並且通過try-catch捕捉從服務端發送來的SoapExcetpion:
class ServiceClient { static void Main(string[] args) { using (MySimpleServiceSoapClient proxy = new MySimpleServiceSoapClient()) { try { // 這里異常將會被代理類拋出 proxy.HelloException(); } catch (SoapException ex) { // 打印異常信息內容 Console.WriteLine("Actor:{0}", ex.Actor); Console.WriteLine("CodeName:{0}", ex.Code.Name); Console.WriteLine("Detail:{0}", ex.Detail.InnerText); Console.WriteLine("Message:{0}", ex.Message); } } Console.ReadKey(); } }
參考資料
(1)朱毅,《進入IT企業必讀的200個.NET面試題》
(2)張子陽,《.NET之美:.NET關鍵技術深入解析》
(3)王濤,《你必須知道的.NET》

