概念上 WebService 講起來可能很複雜,但宏觀地看就一句話:它是一個對外的接口,裡面有些函式開放給外部客戶端呼叫(當然也有不開放的函式)。
如果我們是服務端,寫好一個 WebService 交給客戶端並附上呼叫規則,客戶端在取得資料時就處於一種相對透明的狀態——他們不需要了解、也不應該需要了解內部過程,他們只要拿到資料。
另外要記住一條硬規則:WebService 傳遞的資料只能是序列化的資料,最典型的就是 XML。HashTable 這類非序列化型別是傳不了的。所以本文也只討論 XML 資料的傳輸。
用一個簡單的分布式課件搜尋系統來說明。環境是 VS2003、C#、SQL Server 2000。
整個系統拆成四個角色:
關鍵在最後一點:服務只負責提供查詢介面並回傳資料,回傳的資料要怎麼處理,服務本身完全不管,全由呼叫方決定。
在 VS2003 裡開一個 Web 服務應用程式專案(檔案 → 新增 → 專案 → C# → Web 服務應用程式),你會看到 Service1.asmx,這就是標準的 WebService 檔案。它也有 UI 的概念,但通常不必理會,直接看它的 code-behind 檔案。
什麼都還沒動的時候,你會看到一個被註解掉的 HelloWorld WebMethod。把註解拿掉執行,就得到最簡單的 WebService 實例;點一下「HelloWorld」就會執行那個方法。它的意義僅止於讓你宏觀理解 Web 服務長什麼樣子。
寫好一個函式後,若希望它成為外部可呼叫的接口,必須在函式上方加上這行宣告:
[WebMethod(Description="最簡單的方法")]
public string HelloWorld()
{
return "HelloWorld";
}
沒有這個宣告的函式,用戶端是引用不到的。加上之後,這個函式對用戶而言就等同一個 API——客戶端引用服務並呼叫 HelloWorld(),就會拿到 "HelloWorld" 這個回傳值。
看到這裡應該會發現,WebService 一點都不神秘,它就是個接口。我們的側重點依然是介面函式的撰寫。
[WebMethod(Description="查詢以獲取需要的課件信息")]
public XmlDataDocument GetSiteAData(string AssignName)
{
XmlDataDocument xd = new XmlDataDocument();
DataSet ds = new DataSet();
CStoreProc cp = new CStoreProc("SearchAssign");
cp.AddParIn("@keyWords", SqlDbType.VarChar, 30, AssignName);
cp.AddParOut("@res", SqlDbType.Int);
if (cp.SelectProc()) // 若預儲程序執行成功
{
cp.myData.EnforceConstraints = false; // 不做嚴格格式檢查
if ((int)cp.GetReturnValue("@res") == -1)
{
string XML = "";
xd.LoadXml(XML); // 查無結果,回傳空記錄
return xd;
}
xd = new XmlDataDocument(cp.myData);
XmlNode root1 = xd.DocumentElement;
XmlNodeList roots = root1.SelectNodes("list");
foreach (XmlNode roota in roots) // 為每筆元素加上站點名稱標記
{
XmlElement Link = xd.CreateElement("SiteName");
Link.InnerText = ConfigurationSettings.AppSettings["SiteName"].ToString();
roota.AppendChild(Link);
}
return xd;
}
else return null;
}
這裡的 CStoreProc 是自己封裝的預儲程序類別,主要功能是執行各種類型的預儲程序。程式碼大半對有 ASP.NET 基礎的人來說一望即知。
值得注意的是回傳型別是 XmlDataDocument——這正是前面講的那條規則:WebService 只能傳序列化資料,XML 完全符合,而且跨平台支援最好。
函式邏輯是這樣的:查詢成功就把 DataSet 轉成 XmlDataDocument;因為專案需要,額外跑一個迴圈,為每筆記錄補上 DataSet 裡沒有的「站點名稱」節點。這樣就得到一份符合預期格式的 XML 文件,回傳出去。
先把 WebService 專案編譯完成。假設這個服務針對資源站 A,就叫它 ServiceA。單獨執行 asmx 檔、觸發 GetSiteAData,系統會提示輸入參數,輸入關鍵字按確認,就會回傳一段 XML 並在 IE 上顯示出來——那就是你搜到的內容。
右鍵「引用」→「新增 Web 參考」,輸入服務網址,例如:
https://localhost/ASPxproject/WebServiceSolution/SiteBService/service1.asmx
務必確認網址存在。引用後,Web 參考的名稱會成為這個服務的名稱空間。也就是說如果你輸入的是 SiteA,那實例化就寫成:
SiteA.Service1 serviceA = new SiteA.Service1();
其中 Service1 是服務的類別名稱。完成這一步,遠端實例化就搞定了,後續的遠端呼叫一樣容易。
public void BindData()
{
serviceA = new SiteA.Service1();
DataSet ds = new DataSet();
XmlNode xmlNode1;
XmlDataDocument xd = new XmlDataDocument();
StringBuilder xmlString1;
xmlNode1 = serviceA.GetSiteAData(strSearch);
if (xmlNode1 == null) // 預儲程序執行失敗
return;
xmlString1 = new StringBuilder(xmlNode1.OuterXML);
if (xmlString1.ToString().Equals(""))
return;
xd.LoadXml(xmlString1.ToString());
ds.ReadXml(new XmlNodeReader(xd));
DataGrid1.DataSource = ds.Tables["list"].DefaultView;
DataGrid1.DataBind();
}
流程是:實例化 ServiceA → 用 XmlNode 接回傳值 → 構造 XML 字串 → 轉成 DataSet → 綁定到 DataGrid。
這段「XML 轉 DataSet」的寫法並非唯一途徑,但在 ASP.NET 裡 DataSet 的地位舉足輕重,剛入門的朋友值得把這個模式記下來。
有了兩個服務之後,最自然的問題是:能不能同時呼叫,而不是一個等一個?答案是 async 呼叫。
public void BindData()
{
IAsyncResult ar1;
IAsyncResult ar2;
serviceA = new SiteA.Service1();
serviceB = new SiteB.Service1();
DataSet ds = new DataSet();
XmlNode xmlNode1, xmlNode2;
XmlDataDocument xd = new XmlDataDocument();
StringBuilder xmlString1, xmlString2;
// 兩個請求同時丟出去
ar1 = serviceA.BeginGetSiteAData(strSearch, null, null);
ar2 = serviceB.BeginGetSiteAData(strSearch, null, null);
// 再回頭收結果
xmlNode1 = serviceA.EndGetSiteAData(ar1);
xmlNode2 = serviceB.EndGetSiteAData(ar2);
if (xmlNode1 == null && xmlNode2 == null) // 兩邊都失敗
return;
xmlString1 = new StringBuilder(xmlNode1.OuterXML);
xmlString2 = new StringBuilder(xmlNode2.OuterXML);
xmlString1 = MakeNewXmlString(xmlString1, xmlString2); // 合併成新 XML
if (xmlString1.ToString().Equals(""))
return;
xd.LoadXml(xmlString1.ToString());
ds.ReadXml(new XmlNodeReader(xd));
DataGrid1.DataSource = ds.Tables["list"].DefaultView;
DataGrid1.DataBind();
}
// 把兩份 XML 併成一份
public StringBuilder MakeNewXmlString(StringBuilder str1, StringBuilder str2)
{
str1 = str1.Replace("<?xml ... ?>", "");
str2 = str2.Replace("<?xml ... ?>", "");
str1.Append(str2.ToString());
return str1;
}
這裡有兩個要自己領悟的地方:XML 的合併方式(去掉各自的 XML 宣告,把第二份的內容接到第一份的根節點內),以及Begin/End 異步呼叫的配對。
異步呼叫的價值很直接:兩個資源站的查詢若各需兩秒,同步執行要四秒,異步則接近兩秒。資源站越多,差距越明顯。
如果不想用 Web 參考,也可以自己產生代理類別,流程如下:
https://www.xxx.com/service.asmxhttps://www.xxx.com/service.asmx?wsdl 取得 WSDL 描述xxx.wsdlwsdl /namespace:SiteA ServiceA.wsdlcsc /out:ServiceA.dll /t:library Service1.cs兩種方式最終都得到同一個代理類別,Web 參考只是把這些步驟在 IDE 裡自動做掉了。正式部署時,把服務封成 DLL 會比即時產生 Web 參考更可控。
這個系統示範了 WebService 最典型的使用情境:把分散在各處的資料來源,透過統一的介面聚合起來。服務端只負責回傳 XML,聚合端負責決定怎麼呈現——職責界線清楚,兩邊可以各自獨立演進。
這也是為什麼 WebService 只能傳序列化資料這件事其實不是限制:只要雙方約定好 XML 結構,跨語言、跨平台的整合就成立了。