DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> XML學習教程 >> XML詳解
XML Web Service 實戰全解析:從概念到分布式課件搜索系統
編輯:XML詳解     

先把 WebService 想成一個「對外接口」

很多人第一次接觸 WebService,會被層層名詞擋在門外。其實換一個角度想就很清楚:它就是一個對外開放的接口,裡面準備了一些函數供外部的客戶端調用。當然,並不是所有函數都對外公開,服務內部還留有客戶端看不到、也調不到的實現細節。

站在服務端的立場,我們把 WebService 寫好、部署上線,再把調用規則(也就是接口說明)交給客戶端。此後客戶端取數據時,處於一種近乎透明的狀態——他不必知道數據是怎麼查詢、怎麼拼裝出來的,只需要拿到結果。

還有一個前提要記住:WebService 傳遞的只能是可序列化的數據,最典型的就是 XML。哈希表這類無法序列化的結構是傳不出去 的。基於跨平台與通用性的考慮,本文也只討論 XML 數據的傳輸。

示例場景:分布式課件搜索系統

概念說再多,不如一個能跑的例子。我們用「分布式課件搜索系統」來貫穿全文,環境是 VS2003、C# 語言、SQL Server 2000 數據庫。

系統分為幾個角色:

  • ServiceGatherSite:面向普通用戶的匯集站。它本身可以完全沒有數據庫,職責只是提供一個統一的查詢入口。
  • WebSiteA、WebSiteB:資源站。它們可以並不對外公開,存在的意義就是充實可檢索的數據。
  • SiteAService、SiteBService:兩個資源站各自對外暴露的服務。

兩個服務彼此之間沒有任何耦合,內部方法也毫不相干。它們唯一需要承諾的是:提供查詢接口並返回數據。至於返回的 XML 該怎麼解釋、怎麼展示,服務一概不管,全部交給調用方安排。

動手寫第一個 WebMethod

在 VS2003 裡建立一個 Web 服務應用程序項目(檔案 → 新增 → 項目 → C# → Web 服務應用程序),你會看到標準的 Service1.asmx。切到它的 C# 代碼behind,預設有一段被註釋掉的 HelloWorld。把註釋還原、執行,你就得到了最樸素的一個 WebService 實例——點擊 helloworld,方法就會執行。它的價值僅僅在於讓你宏觀地看到服務長什麼樣子。

關鍵規則只有一條:想讓某個函數成為外部可調用的接口,必須在函數上方加上 WebMethod 特性。少了這行宣告,客戶端根本引用不到它。

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

對客戶端而言,這個函數就等同於一個 API。引用服務之後呼叫 HelloWorld(),就能拿到 "Hello World"。看到這裡你大概會發現,WebService 並不神秘,側重點始終落在接口函數的設計上。

核心接口:把查詢結果變成 XML

下面是我們示例中真正乾活的接口,負責從資源站 A 取出符合關鍵字的課件資料:

[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;
}

這裡的 CStoreProc 是我自己封裝的存儲過程調用類,負責執行各種類型的存儲過程,有 ASP.NET 基礎的人掃一眼就懂。

邏輯說穿了很簡單:查詢成功就把 DataSet 轉成 XmlDataDocument;查不到結果就構造一個空 XML 返回;由於項目需要,中間加了一個循環,為每條記錄補上 DataSet 裡沒有的「站點名稱」節點。最後得到的就是符合約定格式的 XML 文檔。

注意返回型別。正因為 WebService 只能傳序列化數據,這裡特意選了 XML 文檔,而不是自定義對象或哈希表。

怎麼調用?三條路徑

路徑一:Web 引用(調試首選)

先把服務編譯完成,單獨執行 asmx 文件,呼叫 GetSiteAData,系統會提示輸入參數,填入關鍵字並確認,瀏覽器上就會顯示返回的 XML——這正是你搜到的內容。

在 VS 中右擊「引用」→「添加 Web 引用」,填入服務地址,例如 https://localhost/ASPxproject/WebServiceSolution/SiteBService/service1.asmx。地址必須真實存在。引用名會成為命名空間,假如填 SiteA,實例化就寫成:

SiteA.Service1 serviceA = new SiteA.Service1();

完成這一步,遠程實例化與遠程調用都變得跟本地對象一樣自然。下面是匯集站的數據綁定代碼,示範如何把返回的 XML 還原成 DataSet 再交給 DataGrid:

public void BindData()
{
    serviceA = new SiteA.Service1();
    DataSet ds = new DataSet();
    XmlNode xmlNode1 = serviceA.GetSiteAData(strSearch);
    if (xmlNode1 == null) return;

    StringBuilder xmlString1 = new StringBuilder(xmlNode1.OuterXml);
    if (xmlString1.ToString().Equals("")) return;

    XmlDataDocument xd = new XmlDataDocument();
    xd.LoadXml(xmlString1.ToString());
    ds.ReadXml(new XmlNodeReader(xd));

    DataGrid1.DataSource = ds.Tables["list"].DefaultView;
    DataGrid1.DataBind();
}

XML 轉 DataSet 這套寫法在 ASP.NET 裡非常通用,剛入門的朋友建議直接記下來。

路徑二:異步調用多個服務

當服務從一個變成兩個,串行等待就顯得浪費。利用 .NET 自動生成的 Begin/End 方法對,可以讓兩個資源站並行查詢:

public void BindData()
{
    IAsyncResult ar1, ar2;
    serviceA = new SiteA.Service1();
    serviceB = new SiteB.Service1();

    ar1 = serviceA.BeginGetSiteAData(strSearch, null, null);
    ar2 = serviceB.BeginGetSiteAData(strSearch, null, null);
    XmlNode xmlNode1 = serviceA.EndGetSiteAData(ar1);
    XmlNode xmlNode2 = serviceB.EndGetSiteAData(ar2);

    if (xmlNode1 == null && xmlNode2 == null) return;

    StringBuilder xmlString1 = new StringBuilder(xmlNode1.OuterXml);
    StringBuilder xmlString2 = new StringBuilder(xmlNode2.OuterXml);
    xmlString1 = MakeNewXmlString(xmlString1, xmlString2);

    if (xmlString1.ToString().Equals("")) return;

    XmlDataDocument xd = new XmlDataDocument();
    xd.LoadXml(xmlString1.ToString());
    DataSet ds = new DataSet();
    ds.ReadXml(new XmlNodeReader(xd));

    DataGrid1.DataSource = ds.Tables["list"].DefaultView;
    DataGrid1.DataBind();
}

public StringBuilder MakeNewXmlString(StringBuilder str1, StringBuilder str2)
{
    str1 = str1.Replace("<?xml ...?>", "");
    str2 = str2.Replace("<?xml ...?>", "");
    str1.Append(str2.ToString());
    return str1;
}

兩個細節值得留意:一是多份 XML 合併時必須去掉各自的聲明頭,否則會產生非法文檔;二是異步調用的 Begin 與 End 必須成對出現,且順序對應。

路徑三:用 WSDL 生成代理 DLL

如果不想在項目裡維護 Web 引用,也可以走代理類的路子,流程如下:

  1. 瀏覽器打開服務地址,例如 https://www.xxx.com/service.asmx。
  2. 在後面加上 ?wsdl,即 https://www.xxx.com/service.asmx?wsdl。
  3. 頁面另存為 ServiceA.wsdl。
  4. 用 VS 命令提示字元執行 wsdl /namespace:SiteA ServiceA.wsdl,生成命名空間為 SiteA 的代理類。
  5. 再執行 csc /out:ServiceA.dll /t:library Service1.cs 把代理類編譯成類庫。
  6. 最後在項目中引用這個 DLL 即可。

三種方式各有適用場景:調試階段用 Web 引用最省事,需要分發給第三方時用代理 DLL 更乾淨,異步則是聚合多站點數據的必備手段。理解它們背後共享的同一套 SOAP/XML 約定,比記住語法更重要。

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