DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> XML學習教程 >> XML詳解
XML WebService 完整實例詳解(上)
編輯:XML詳解     

先搞懂 WebService 是什麼

概念上講,WebService 可能顯得抽象,但可以這樣宏觀理解:它就是一個對外的接口,裡面有若干函數供外部客戶端調用(當然,也存在客戶端不能調用的函數)。如果我們是服務端,寫好一個 WebService 並交付給客戶(同時附上調用規則),客戶端在從服務端獲取資訊時就處於一種相對透明的狀態——他們不了解、也不需要了解內部過程,只取得數據。

WebService 傳遞的數據只能是序列化後的數據,最典型的就是 XML。本文也只討論 XML 數據的傳輸。

示例架構:分布式課件搜索系統

與其空談概念,不如看一個具體例子。這裡用一個簡單的分布式課件搜索系統來說明,開發環境為 VS2003、語言 C#、資料庫 SQL Server 2000。

先明確要做什麼。整個系統由幾塊組成:

  • ServiceGatherSite:面向客戶的接口站點。它可以是任何形式,本身甚至不需要資料庫,只負責提供查詢入口,真正的服務普通使用者接觸不到。
  • 資源站 WebSiteA / WebSiteB:真正提供服務的站點。為簡化起見假設有兩個,它們可以不完全對外公開,存在的目的是豐富查詢數據。
  • SiteAService / SiteBService:資源站提供給 ServiceGatherSite 的服務,也是我們最關注的部分。

兩個服務之間沒有任何關係,內部方法也毫不相干。它們只需要把「方法怎麼用」告訴 ServiceGatherSite——也就是說,服務只提供查詢接口,返回的數據該如何處理,服務本身不管,全由調用方決定。

動手寫一個 WebService

在 VS2003 中開發 WebService 並不難:新建一個 Web 服務應用程式專案(檔案 → 新建 → 專案 → C# → Web 服務應用程式)。建立完成後會看到一個 Service1.asmx,這就是 WebService 的標準檔。它也有 UI 的概念,但一般不必關注,直接看它的 C# 代碼檔即可。

如果什麼都還沒改,你會看到一個被註解掉的 Hello World 方法。把註解去掉並執行,就得到了一個最簡單的 WebService 實例,點擊 helloworld 就會執行該方法。這個函數的意義僅止於讓你宏觀了解 Web 服務的寫法。

WebMethod:決定哪些函數對外開放

關鍵來了:如果你寫了一個函數,希望它成為外部可調用的接口,必須在函數上方加上一行宣告:

[WebMethod(Description="函數的描述信息")]

少了這個宣告,它就無法被外部引用。例如:

[WebMethod(Description="最簡單的方法")]
public string HelloWorld()
{
    return "Hello World";
}

這個函數就是對外開放的接口,對使用者而言等同一個 API。使用者引用該服務後調用 HelloWorld(),就會拿到 "Hello World" 這個回傳值。

看到這裡應該發現,WebService 並不神秘——它就是一個接口,我們的側重點依然是接口函數的編寫。

實際的查詢接口

[WebMethod(Description="查詢以獲取需要的課件信息")]
public XmlDataDocument GetSiteAData(string AssignName)
{
    XmlDataDocument xd = new XmlDataDocument();
    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;
}

這是獲取資源站資訊的接口函數。裡面大部分代碼對有 ASP.NET 基礎的人來說一望即知,只需說明 CStoreProc——這是我封裝的存儲過程類,主要功能是執行各種類型的存儲過程。

值得留意的是回傳型別:XmlDataDocument。前面說過,WebService 只能傳輸序列化數據,XML 顯然符合條件;而像 HashTable 這類非序列化數據就無法傳輸。加上 XML 應用最廣、便於跨平台,所以這裡以 XML 傳輸作為示範。

函數邏輯拆解

GetSiteAData(string AssignName) 的作用很單純:回傳查詢結果,格式為 XmlDataDocument。查詢失敗(無匹配結果)時,構造一個空 XML 並返回空記錄;成功時,把查到的 DataSet 轉成 XmlDataDocument,接著因為本專案的需要,加一個迴圈補上 DataSet 裡沒有的節點——站點名稱。完成後,這份符合期望格式的 XML 文檔就返回給調用方。

測試與調用

先把 WebService 專案編譯完成。假設這個服務針對資源站 A,稱之為 ServiceA。單獨執行 asmx 檔並觸發 GetSiteAData(string AssignName),系統會提示輸入參數;輸入關鍵字並確認,就會回傳一段 XML 並在 IE 中顯示出來,這就是你搜到的內容。

再說清楚 ServiceA 的定位:在本專案中,它是資源站 A 提供的服務,查詢的數據全部來自站點 A,而站點 A 的資源維護在本專案裡另有專門的專案負責。

方法一:Web 引用

這種方式在除錯時非常方便,強烈建議使用。右擊「引用」→「添加 Web 引用」,輸入你的 WebService 位址,例如:

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();
}

這段代碼給出了 XML 轉成 DataSet 的方案。這步並非強制,但在 ASP.NET 裡 DataSet 的地位舉足輕重,值得記下這個寫法。流程很直白:實例化 ServiceA(與一般類別無異)→ 用 xmlNode1 接收回傳值 → 構造 XML 並轉為 DataSet → 綁定到 DataGrid。

方法二:異步調用多個服務

// 綁定數據
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,需要去掉各自的 XML 宣告後再拼接,否則會產生格式錯誤;二是異步調用的實現,用 Begin/End 配對讓兩個請求並行發出,再依序收結果,能有效縮短總等待時間。

方法三:透過 DLL 引用

流程如下:

  1. 在瀏覽器輸入服務位址,如 https://www.xxx.com/service.asmx
  2. 接著輸入 https://www.xxx.com/service.asmx?wsdl
  3. 開啟後「另存新檔」為 xxx.wsdl
  4. 用 VS 命令提示字元編譯:wsdl /namespace:SiteA ServiceA.wsdl,產生命名空間為 SiteA 的代理類
  5. 再用 csc /out:ServiceA.dll /t:library Service1.cs 編譯(Service1.cs 為代理類檔案)
  6. 最後在專案中引用這個 DLL 即可

這種方式適合服務位址固定、需要跨專案共用的場合;缺點是服務一有變動就得重新產生代理類並重新發佈 DLL。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved