如何理解.asmx處理程序提供的XML映射功能

本篇文章為大家展示了如何理解.asmx處理程序提供的XML映射功能，內(nèi)容簡明扼要并且容易理解，絕對能使你眼前一亮，通過這篇文章的詳細(xì)介紹希望你能有所收獲。

將 XML映射到對象
在 WebMehod 處理程序確定了要調(diào)用的方法之后，它需要將 XML 消息反序列化為可在方法調(diào)用過程中提供的 .NET 對象。如同消息調(diào)度一樣，該處理程序通過以下方法來實(shí)現(xiàn)上述目標(biāo)：通過反射來檢查該類，以便確定如何處理傳入的 XML 消息。XmlSerializer 類在 System.Xml.Serialization 命名空間中自動(dòng)完成 XML 和對象之間的映射。

XmlSerializer 使將任何公共的 .NET 類型映射到 XML 架構(gòu)類型成為可能，在建立了這樣的映射之后，它可以在 .NET 對象和 XML 實(shí)例文檔之間自動(dòng)映射（請參閱圖 4）。目前，XmlSerializer 被限制于 XML 架構(gòu)所支持的模型中，因此無法處理當(dāng)今所有復(fù)雜的現(xiàn)代對象模型，例如，復(fù)雜的非樹型對象圖、雙重指針等。不過，XmlSerializer 能夠處理開發(fā)人員傾向使用的大多數(shù)復(fù)雜類型。

對于上面說明的 Add 示例，XmlSerializer 會(huì)將 x 和 y 元素映射為 .NET 雙精度值，這些值隨后會(huì)在調(diào)用 Add 時(shí)提供。Add 方法向調(diào)用方返回一個(gè)雙精度值，該值隨后將需要重新序列化為 SOAP 響應(yīng)中的一個(gè) XML 元素。

圖 4. 將 XML映射到對象
XmlSerializer 還可以自動(dòng)處理復(fù)雜的類型（除了上面描述的限制）。例如，下面的 WebMethod 計(jì)算兩個(gè) Point 結(jié)構(gòu)之間的距離：

using System;   using System.Web.Services;   public class Point {   public double x;    public double y;   }   [WebService(Namespace="urn:geometry")]   public class Geometry {   [WebMethod]   public double Distance(Point orig, Point dest) {   return Math.Sqrt(Math.Pow(orig.x-dest.x, 2) +   Math.Pow(orig.y-dest.y, 2));   }   }

此操作的 SOAP 請求消息將包含一個(gè) Distance 元素，該元素中包含兩個(gè)子元素，一個(gè)叫做 orig，另一個(gè)叫做 dest，它們都應(yīng)當(dāng)包含 x 和 y 子元素，如下所示：

< soap:Envelope    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"   >   < soap:Body>   < Distance xmlns="urn:geometry">   < orig>   < x>0< /x>   < y>0< /y>   < /orig>   < dest>   < x>3< /x>   < y>4< /y>   < /dest>   < /Distance>   < /soap:Body>   < /soap:Envelope>

在本例中，SOAP 響應(yīng)消息將包含一個(gè) DistanceResponse 元素，該元素包含一個(gè)雙精度類型的 DistanceResult 元素：

< soap:Envelope    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"   >   < soap:Body>   < DistanceResponse    xmlns="urn:geometry">   < DistanceResult>5< /DistanceResult>    < /DistanceResponse>   < /soap:Body>   < /soap:Envelope>

默認(rèn)的 XML映射將方法的名稱用作請求元素的名稱，將參數(shù)的名稱用作請求元素的子元素的名稱。每個(gè)參數(shù)的結(jié)構(gòu)都取決于類型的結(jié)構(gòu)。公共字段和屬性的名稱只是映射到子元素（在本例中是 Point 中的x 和 y）。在默認(rèn)情況下，響應(yīng)元素的名稱是請求元素的名稱后面加上 "Response"。響應(yīng)元素也包含一個(gè)子元素，名稱是請求元素的名稱后面加上 "Result"。

您可以通過使用大量的內(nèi)置映射屬性從標(biāo)準(zhǔn)的 XML 映射中解放出來。例如，可以使用 [XmlType] 屬性來自定義類型的名稱和命名空間?？墒褂?[XmlElement] 和 [XmlAttribute] 屬性來控制參數(shù)或類成員分別映射到元素或?qū)傩缘姆绞健＿€可以使用 [SoapDocumentMethod] 屬性來控制方法本身如何映射到請求/響應(yīng)消息中的元素名稱。例如，使用散布于下面程序片段中的多種屬性檢查如下版本的 Distance：

using System;   using System.Web.Services;   using System.Web.Services.Protocols;   using System.Xml.Serialization;   public class Point {   [XmlAttribute]   public double x;   [XmlAttribute]    public double y;   }   [WebService(Namespace="urn:geometry")]   public class Geometry {   [WebMethod]   [SoapDocumentMethod(RequestElementName="CalcDistance",   ResponseElementName="CalculatedDistance")]   [return: XmlElement("result")]   public double Distance(   [XmlElement("o")]Point orig, [XmlElement("d")]Point dest) {   return Math.Sqrt(Math.Pow(orig.x-dest.x, 2) +   Math.Pow(orig.y-dest.y, 2));   }   }

這個(gè)版本的 Distance 希望傳入具有如下外觀的 SOAP 消息：

< soap:Envelope    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"   >   < soap:Body>   < CalcDistance xmlns="urn:geometry">   < o x="0" y="0" />   < d x="3" y="4" />   < /CalcDistance>   < /soap:Body>   < /soap:Envelope>

而且，它將生成一個(gè)如下所示的 SOAP 響應(yīng)消息：

< soap:Envelope    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"   >   < soap:Body>   < CalculatedDistance xmlns="urn:geometry">   < result>5< /result>   < /CalculatedDistance>   < /soap:Body>   < /soap:Envelope>

.asmx 處理程序使用 SOAP document/literal 樣式來實(shí)現(xiàn)和描述上面顯示的默認(rèn)映射。這意味著該 WSDL 定義將包含用來描述 SOAP 消息中所使用的請求和響應(yīng)元素的字面上的 XML 架構(gòu)定義（例如，不使用 SOAP 編碼規(guī)則）。

.asmx 處理程序還可以使用 SOAP rpc/encoded 樣式。這意味著 SOAP 正文中包含一個(gè) RPC 調(diào)用的 XML 表示形式，而且參數(shù)都使用 SOAP 編碼規(guī)則（例如，不需要 XML 架構(gòu)）進(jìn)行了序列化。為了實(shí)現(xiàn)這個(gè)目標(biāo)，可以使用 [SoapRpcService] 和 [SoapRpcMethod] 屬性，而不使用 [SoapDocumentService] 和 [SoapDocumentMethod] 屬性。有關(guān)這些樣式之間的區(qū)別的更多信息，請查看 Understanding SOAP。

正如您所看到的一樣，可以完全自定義給定方法映射到 SOAP 消息的方式。XmlSerializer 提供一個(gè)功能強(qiáng)大的序列化引擎，以及許多我們在本文中沒有時(shí)間進(jìn)行討論的功能。有關(guān) XmlSerializer 如何工作的更多信息，請查看 Moving to .NET and Web Services。在我的每月 MSDN Magazine 的 XML Files 專欄（可在聯(lián)機(jī)存檔中查看專欄列表）中，我還介紹了 XmlSerializer 的許多不易察覺的細(xì)微差別。

除了對參數(shù)的反序列化進(jìn)行處理以外，.asmx 處理程序還能夠?qū)?SOAP 頭進(jìn)行反序列化/序列化。SOAP 頭的處理方法與參數(shù)不同，因?yàn)樗鼈兺ǔ１灰暈閹庑畔ⅲ⑽粗苯雨P(guān)聯(lián)到某個(gè)特定的方法。因此，SOAP 頭的處理通常是通過偵聽層完成的，從而使得 WebMethod 完全無須對 SOAP 頭進(jìn)行處理。

但是，如果您希望親自處理 WebMethod 中的頭信息，則必須提供一個(gè)從 SoapHeader 派生的 .NET 類，此類代表該頭的 XML 架構(gòu)類型（遵循上面描述的同一映射準(zhǔn)則）。然后定義該類型的成員變量，以便讓其充當(dāng)頭實(shí)例的占位符。***，批注每個(gè)需要訪問該頭的 WebMethod，以便指定您想要到達(dá)的字段的名稱。

例如，考慮下面的 SOAP 請求，其中包含有一個(gè)用于進(jìn)行身份驗(yàn)證的 UsernameToken 頭：

< soap:Envelope    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"   >   < soap:Header>   < x:UsernameToken xmlns:x="http://example.org/security">   < username>Mary< /username>   < password>yraM< /password>   < /x:UsernameToken>   < /soap:Header>   < soap:Body>   < CalcDistance xmlns="urn:geometry">   ...

為了使 .asmx 處理程序能夠反序列化該頭，首先需要定義一個(gè)表示隱含的 XML 架構(gòu)類型的 .NET 類（注：如果您實(shí)際上已經(jīng)知道了該頭的 XML 架構(gòu)，則可以使用 xsd.exe /c 來生成該類）。在本例中，相應(yīng)類的外觀如下所示：

[XmlType(Namespace="http://example.org/security")]   [XmlRoot(Namespace="http://example.org/security")]   public class UsernameToken : SoapHeader {   public string username;   public string password;   }

接著，只需在 WebMethod 類中定義一個(gè)用來保存頭類的實(shí)例的成員變量，并用 [SoapHeader] 屬性批注 WebMethod，如下所示：

using System;   using System.Web.Services;   using System.Web.Services.Protocols;   [WebService(Namespace="urn:geometry")]   public class Geometry {   public UsernameToken Token;   [WebMethod]   [SoapHeader("Token")]   public double Distance(Point orig, Point dest) {   if (!Token.username.Equals(Reverse(Token.password)))   throw new Exception("access denied");   return Math.Sqrt(Math.Pow(orig.x-dest.x, 2) +   Math.Pow(orig.y-dest.y, 2));   }   }

然后，您可以在 WebMethod 中訪問 Token 字段并提取在該頭中提供的信息。您也可以使用同樣的方法將頭重新發(fā)送到客戶端 — 您只需在 [SoapHeader] 屬性中指定頭的方向。有關(guān)在 WebMethod 框架中處理 SOAP 頭的更多信息，請查看 Digging into SOAP Headers with the .NET Framework。

.asmx 處理程序也提供了 .NET 異常的自動(dòng)序列化。由 .asmx 處理程序捕獲的任何未經(jīng)處理的異常都自動(dòng)序列化為響應(yīng)中的 SOAP Fault 元素。例如，在上例中，如果用戶名與反轉(zhuǎn)密碼不匹配，代碼將引發(fā)一個(gè) .NET 異常。.asmx 處理程序隨后將捕獲該異常，并將它序列化為 SOAP 響應(yīng)，如下所示：

< soap:Envelope    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"   >   < soap:Body>   < soap:Fault>   < faultcode>soap:Server< /faultcode>       < faultstring>Server was unable to process request. --&gt; access denied< /faultstring>   < detail />   < /soap:Fault>   < /soap:Body>   < /soap:Envelope>

如果您希望對 SOAP Fault 元素進(jìn)行更多的控制，則還可以顯式引發(fā) SoapException 對象，以便指定所有的 SOAP Fault 元素細(xì)節(jié)，例如，faultcode、faulstring、faultactor 和 detail 元素。有關(guān)更多信息，請查看 Using SOAP Faults。

正如您所看到的一樣，要知曉 WebMethod 如何工作必須了解基礎(chǔ)序列化引擎及其各種選項(xiàng)。序列化引擎的好處在于，它隱藏了所有的基礎(chǔ) XML API 代碼，而在自定義處理程序中，您通常必須編寫這些代碼。盡管多數(shù)開發(fā)人員發(fā)現(xiàn)這很好，但是，有一些開發(fā)人員卻認(rèn)為它是一個(gè)缺陷，因?yàn)樗麄內(nèi)韵ＭH自處理 WebMethod 實(shí)現(xiàn)中的原始 SOAP 消息。

上述內(nèi)容就是如何理解.asmx處理程序提供的XML映射功能，你們學(xué)到知識(shí)或技能了嗎？如果還想學(xué)到更多技能或者豐富自己的知識(shí)儲(chǔ)備，歡迎關(guān)注億速云行業(yè)資訊頻道。