GHawk

內(nèi)容： 引言 RPC/編碼 RPC/文字 文檔/編碼 文檔/文字 文檔/文字包裝模式 為什么不始終采用文檔/文字包裝的樣式 SOAP 響應消息 結(jié)束語 參考資料 關(guān)于作者 對本文的評價 相關(guān)內(nèi)容： Web services with WSDL Handle namespaces in SOAP messages you create by hand 訂閱: developerWorks 時事通訊

Russell Butek
Web 服務顧問, IBM
2003 年 10 月 31 日
2005 年 6 月 29 日 更新

WSDL 綁定樣式可以是 RPC 樣式或文檔樣式。用法可以是編碼的，也可以是文字的。您如何決定使用哪一種樣式/用法的組合呢？本文將幫助您解決這個問題。

引言
Web 服務是通過 WSDL 文檔來描述的。WSDL 綁定描述了如何把服務綁定到消息傳遞協(xié)議（特別是 SOAP 消息傳遞協(xié)議）。WSDL SOAP 綁定可以是 RPC 樣式的綁定，也可以是文檔樣式的綁定。同樣，SOAP 綁定可以有編碼的用法，也可以有文字的用法。這給我們提供了四種樣式/用法模型：

1. RPC/編碼
2. RPC/文字
3. 文檔/編碼
4. 文檔/文字

除了這些樣式之外，還有一種樣式也很常見，它稱為文檔/文字包裝的樣式，算上這一種，在創(chuàng)建 WSDL 文件時您就有了五種綁定樣式可以從中選擇。您應該選擇哪一種呢？

在我進一步討論以前，讓我闡明一些容易混淆的地方。這里，這些術(shù)語是非常不合適的：RPC 與文檔。這些術(shù)語意味著 RPC 樣式應該用于 RPC 編程模型，文檔樣式應該用于文檔或消息編程模型。 但事實完全不是這樣。樣式對于編程模型沒有任何意義。它只是指明了如何將 WSDL 綁定轉(zhuǎn)化為 SOAP 消息。其他就沒什么了。你可以將任一種樣式用于任何編程模型。

同樣，術(shù)語編碼和文字只對于 WSDL 到 SOAP 映射有意義，可是，至少這里，這兩個單詞的字面意思更容易理解一些。

對于這篇討論，讓我們從清單 1 中的 Java 方法開始，并且應用 JAX-RPC Java-to-WSDL 規(guī)則（參閱參考資料查看 JAX-RPC 1.1 規(guī)范）。

public void myMethod(int x, float y);

RPC/編碼
采用清單 1 中的方法并且使用你喜歡的 Java-to-WSDL 工具來運行，指定您想讓它生成 RPC/編碼的 WSDL。您最后應該得到如清單 2 所示的 WSDL 片斷。

<message name="myMethodRequest">
    <part name="x" type="xsd:int"/>
    <part name="y" type="xsd:float"/>
</message>
<message name="empty"/>

<portType name="PT">
    <operation name="myMethod">
        <input message="myMethodRequest"/>
        <output message="empty"/>
    </operation>
</portType>

<binding .../>  
<!-- I won't bother with the details, just assume it's RPC/encoded. -->

現(xiàn)在用“5”作為參數(shù) x 的值，“5.0”作為參數(shù) y 的值來調(diào)用這個方法。發(fā)送一個如清單 3 所示的SOAP 消息。

<soap:envelope>
    <soap:body>
        <myMethod>
            <x xsi:type="xsd:int">5</x>
            <y xsi:type="xsd:float">5.0</y>
        </myMethod>
    </soap:body>
</soap:envelope>

關(guān)于前綴和命名空間的注意事項 為了簡單起見，在本文的大部分 XML 示例中，我省略了命名空間和前綴。不過，我還是使用了少數(shù)前綴，您可以假定它們是用下列名稱空間進行定義的： xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 關(guān)于命名空間和 WSDL-to-SOAP 映射的討論，請參考文章“Handle namespaces in SOAP messages you create by hand”（參閱 參考資料）。

關(guān)于 RPC/編碼例子中的 WSDL 和 SOAP 消息有一些需要注意的地方：

優(yōu)點

• WSDL 盡可能的簡單明了。
• 操作名出現(xiàn)在消息中，因此接收者可以很容易的將消息分派到操作的實現(xiàn)。

缺點

遵照 WS-I 各種 Web 服務規(guī)范有時候是不一致和不明確的。WS-I 組織成立用來解決這些規(guī)范上的問題。它已經(jīng)定義了許多概要，指明了你應該如何編寫 Web 服務來實現(xiàn)互操作性。要獲取 WS-I 的更多信息，請參閱參考資料中的 WS-I 鏈接。

• 類型編碼信息（xsi:type="xsd:int"）通常就是降低吞吐量性能的開銷。
• 你不能很容易的驗證這個消息的有效性，因為只有 <x ...>5</x> 和 <y ...>5.0</y> 行包含 Schema 中定義的內(nèi)容；soap:body 內(nèi)容的其余部分來自于 WSDL 定義。
• 雖然它是合法的 WSDL，但 RPC/encoded 是不遵守 WS-I 的。

有沒有一種方法可以取其精華，棄其糟粕呢？可能有。讓我們看一下 RPC/文字樣式。

RPC/文字
用于這個方法的 RPC/文字樣式的 WSDL 看起來與 RPC/編碼的 WSDL（清單 4）幾乎一樣。綁定的用法從 編碼 變?yōu)?文字。僅此而已。

<message name="myMethodRequest">
    <part name="x" type="xsd:int"/>
    <part name="y" type="xsd:float"/%gt;
</message>
<message name="empty"/>

<portType name="PT">
    <operation name="myMethod">
        <input message="myMethodRequest"/>
        <output message="empty"/>
    </operation>
</portType>

<binding .../>  
<!-- I won't bother with the details, just assume it's RPC/literal. -->

RPC/文字的 SOAP 消息又是怎樣的呢（參閱清單 5）？這里的更改要多一點。去掉了類型編碼。

<soap:envelope>
    <soap:body>
        <myMethod>
            <x>5</x>
            <y>5.0</y>
        </myMethod>
    </soap:body>
</soap:envelope>

關(guān)于 xsi:type 和文字用法的注意事項 雖然在一般情況下，xsi:type 沒有出現(xiàn)在文字 WSDL 的 SOAP 消息中，但是仍然有一些情況，類型信息是必須的，并且它將以多種形式出現(xiàn)。如果 API 期望一個基礎類型，并且發(fā)送一個擴展實例，則必須提供這個實例的類型以便正確的反序列化該對象。

這里是這種方法的優(yōu)點和缺點：

優(yōu)點

• WSDL 盡可能的簡單明了。
• 操作名仍然出現(xiàn)在消息中。
• 去掉了類型編碼。
• RPC/文字是遵循 WS-I 的。

缺點

• 你仍然不能很容易的驗證這個消息的有效性，因為只有 <x ...>5</x> 和 <y ...>5.0</y> 行中包含定義在 Schema 中的內(nèi)容；soap:body 內(nèi)容的其余部分來自于 WSDL 定義。

文檔樣式如何呢？它們能夠幫助克服這些困難嗎？

文檔/編碼
沒有人使用這個樣式。它不遵循 WS-I。因此此處略過。

文檔/文字
文檔/文字的 WSDL 在 RPC/文字的 WSDL 基礎上做了一些修改。其不同點已經(jīng)在清單 6 中指出。

<types>
    <schema>
        <element name="xElement" type="xsd:int"/>
        <element name="yElement" type="xsd:float"/>
    </schema>
</types>

<message name="myMethodRequest">
    <part name="x" element="xElement"/>
    <part name="y" element="yElement"/>
</message>
<message name="empty"/>

<portType name="PT">
    <operation name="myMethod">
        <input message="myMethodRequest"/>
        <output message="empty"/>
    </operation>
</portType>

<binding .../>  
<!-- I won't bother with the details, just assume it's document/literal. -->

用于這個 WSDL 的 SOAP 消息如清單 7 所示：

<soap:envelope>
    <soap:body>
        <xElement>5</xElement>
        <yElement>5.0</yElement>
    </soap:body>
</soap:envelope>

關(guān)于消息組成部分的注意事項 我本來可以只更改綁定，就像我從 RPC/編碼轉(zhuǎn)到 RPC/所做的那樣。它將是合法的 WSDL。然而，WS-I 基本概要（WS-I Basic Profile）規(guī)定文檔/文字的消息的組成部分引用元素而不是類型，所以我遵循了 WS-I（并且此處使用元素部分可以很好地把我們帶到關(guān)于文檔/文字包裝的樣式的討論）。

下面是這種方法的優(yōu)點和缺點：

優(yōu)點

• 沒有類型編碼信息。
• 您可以在最后用任何 XML 檢驗器檢驗此消息的有效性。soap:body 里面的所有內(nèi)容都定義在 schema 中。
• 文檔/文字是遵循 WS-I 的，但是有限制（參閱缺點）。

缺點

• WSDL 有一點復雜。不過，這是一個非常小的缺點，因為 WSDL 并沒有打算由人來讀取。
• SOAP 消息中缺少操作名。而如果沒有操作名，發(fā)送就可能比較困難，并且有時變得不可能。
• WS-I 僅僅允許 SOAP 消息中 soap:body 的一個子元素。正如你在清單 7 中所見的那樣，該消息的 soap:body 有兩個子元素。

文檔/文字樣式似乎只是重新排列了一下 RPC/文字模型中的優(yōu)點和缺點。你可以驗證該消息，但是你已經(jīng)失去了操作名。有沒有什么辦法可以改進這一點呢？是的，它就是文檔/文字包裝模式。

文檔/文字包裝模式
在我描述文檔/文字包裝模式的規(guī)則之前，讓我先向您展示 WSDL 和 SOAP 消息，如清單 8 和 清單 9 所示。

<types>
    <schema>
        <element name="myMethod">
            <complexType>
                <sequence>
                    <element name="x" type="xsd:int"/>
                    <element name="y" type="xsd:float"/>
                </sequence>
            </complexType>
        </element>
        <element name="myMethodResponse">
            <complexType/>
        </element>
    </schema>
</types>
<message name="myMethodRequest">
    <part name="parameters" element="myMethod"/>
</message>
<message name="empty">
    <part name="parameters" element="myMethodResponse"/>
</message>

<portType name="PT">
    <operation name="myMethod">
        <input message="myMethodRequest"/>
        <output message="empty"/>
    </operation>
</portType>

<binding .../>  
<!-- I won't bother with the details, just assume it's document/literal. -->

WSDL Schema 現(xiàn)在把參數(shù)放在包裝中（參閱清單 9）。

<soap:envelope>
    <soap:body>
        <myMethod>
            <x>5</x>
            <y>5.0</y>
        </myMethod>
    </soap:body>
</soap:envelope>

注意這個 SOAP 消息同 RPC/文字的 SOAP 消息（清單 5）非常相似。您可能會說，它看起來與 RPC/文字的 SOAP 消息是完全一樣的，不過，這兩種消息之間存在著微妙的區(qū)別。在 RPC/文字的 SOAP 消息中，<soap:body> 的 <myMethod> 子句是操作的名稱。在文檔/文字包裝的 SOAP 消息中，<myMethod> 子句是單個輸入消息的組成部分引用的元素的名稱。因此，包裝的樣式具有這樣的一個特征，輸入元素的名稱與操作的名稱是相同的。此樣式是把操作名放入 SOAP 消息的一種巧妙方式。

文檔/文字包裝的樣式的特征有：

• 輸入消息只有一個組成部分。
• 該部分是一個元素。
• 該元素同操作有相同的名稱。
• 該元素的復雜類型沒有屬性。

下面是該種方法的優(yōu)缺點：

優(yōu)點

• 沒有類型編碼信息。
• soap:body 中出現(xiàn)的所有內(nèi)容都定義在 schema 中，所以您可以很容易地檢驗此消息的有效性。
• 方法名又出現(xiàn)在 SOAP 消息中。
• 文檔/文字是遵守 WS-I 的，并且包裝模式符合了 WS-I 的限制，即 SOAP 消息的 soap:body 只有一個子元素。

缺點

• WSDL 更加復雜。

文檔/文字包裝的樣式還是有一些缺點，不過與優(yōu)點比起來，它們都顯得微不足道。

RPC/文字包裝？ 從 WSDL 的角度來考慮，沒有理由只是把把包裝的樣式和文檔/文字綁定聯(lián)系在一起。它可以很容易地應用于 RPC/文字綁定。但是這樣做是相當不明智的。SOAP 將包含操作的一個 myMethod 元素和元素名稱的子 myMethod 元素。另外，即使它是一個合法的 WSDL，RPC/文字元素部分也不遵循 WS-I。

文檔/文字的樣式在哪里定義？
這種包裝類型來源于 Microsoft?。并沒有任何規(guī)范來定義這個類型；因此雖然這個類型是一個好東西，但不幸的是，為了與 Microsoft 和其他公司的實現(xiàn)進行互操作，現(xiàn)在惟一的選擇就是根據(jù) Microsoft WSDL 的輸出來猜測它是如何工作的。該模式已經(jīng)出現(xiàn)了一段時間，并且業(yè)界也很好的理解了它，雖然該模式在例子中是非常明顯的，但是也有一些內(nèi)容不夠清晰。我們希望一個獨立的組織比如 WS-I 來幫助穩(wěn)定和標準化這一模式。

為什么不始終采用文檔/文字包裝的樣式
至此，本文已經(jīng)給了您這樣的一個印象，文檔/文字包裝的樣式是最好的方法。而實際的情況往往確實如此。不過，仍然存在著一些情況，在這些情況下，您最好是換一種別的樣式。

采用文檔/文字非包裝的樣式的理由
如果您已經(jīng)重載了操作，就不能采用文檔/文字包裝的樣式。

想象一下，除了我們一直在使用的方法之外，還有另一種方法，請參見清單 10。

public void myMethod(int x, float y);
public void myMethod(int x);

關(guān)于重載的操作的注意事項 WSDL 2.0 不會允許重載的操作。這對于一些允許該操作的語言（比如 Java）來說是不幸的。一些規(guī)范（比如 JAX-RPC）將不得不定義一個名稱轉(zhuǎn)換模式（name mangling scheme）來將重載的方法映射到 WSDL 中。WSDL 2.0 只不過將問題從 WSDL-to-SOAP 映射轉(zhuǎn)移到 WSDL-to-language 映射中。

WSDL 允許重載的操作。但是當你向 WSDL 上添加包裝模式的時候，需要元素有與操作相同的名稱，并且在 XML 中不能有兩個名稱相同的元素。所以您必須采用文檔/文字非包裝的樣式或某種 RPC 樣式。

采用 RPC/文字的樣式的理由
由于文檔/文字非包裝的樣式?jīng)]有提供操作名，所以在有些情況下，您將需要采用某種 RPC 樣式。比如說清單 11 中的一組方法。

public void myMethod(int x, float y);
public void myMethod(int x);
public void someOtherMethod(int x, float y);

現(xiàn)在假設你的服務器接收到了文檔/文字的 SOAP 消息，你可以回頭看一下清單 7。服務器應該發(fā)送哪一種方法呢？所有您能確切知道的就是，它一定不是 myMethod(int x)，因為消息有兩個參數(shù)，而這種方法只需要一個參數(shù)。它可能是其他兩種方法中的一種。采用文檔/文字的樣式，您沒有辦法知道是哪一種方法。

假定服務器接收到一個 RPC/文字的消息，而不是文檔/文字的消息，如清單 5 所示。對于這種消息，服務器很容易決定把它發(fā)送到哪一種方法。你知道該操作名稱是 myMethod，并且你知道你有兩個參數(shù)，因此肯定是 myMethod(int x, float y)。

采用 RPC/編碼的理由
使用 RPC/編碼樣式最重要的原因是為了數(shù)據(jù)圖表。設想你有一個二進制樹，如清單 12 所示。

<complexType name="Node">
    <sequence>
        <element name="name" type="xsd:string"/>
        <element name="left" type="Node" xsd:nillable="true"/>
        <element name="right" type="Node" xsd:nillable="true"/>
    </sequence>
</complexType>

根據(jù)這種節(jié)點定義，你可以構(gòu)建一個樹，其根節(jié)點 -- A -- 通過左/右鏈接指向節(jié)點 B（參閱圖 1）。

圖 1. 編碼樹。

發(fā)送數(shù)據(jù)圖表的標準方式是使用 href 標簽，它是 RPC/編碼的樣式（清單 13）的一部分。

<A>
    <name>A</name>
    <left href="12345"/>
    <right href="12345"/>
</A>
<B id="12345">
    <name>B</name>
    <left xsi:nil="true"/>
    <right xsi:nil="true"/>
</B>

在任何文字樣式中，href 屬性都是不可用的，這樣圖形鏈接就不再起作用了（參閱清單 14 和 圖 2）。你仍然有一個根節(jié)點 A，其指向左邊的節(jié)點 B和右邊的另一個節(jié)點 B。這些節(jié)點 B 都是一樣的，但是它們不是相同的節(jié)點。數(shù)據(jù)被復制而不是引用兩次。

<A>
    <name>A</name>
    <left>
        <name>B</name>
        <left xsi:nil="true"/>
        <right xsi:nil="true"/>
    </left>
    <right>
        <name>B</name>
        <left xsi:nil="true"/>
        <right xsi:nil="true"/>
    </right>
</A>

圖 2. 文字樹

在文字樣式中，您可以通過各種方法構(gòu)造圖表，但是卻沒有標準的方法；所以您做的任何事情很可能不能與網(wǎng)絡中其他端點上的服務進行互操作。

SOAP 響應消息
到目前為止我已經(jīng)討論了請求消息。但是響應消息呢？它們是怎樣的呢？現(xiàn)在你應該很清楚一個文檔/文字消息的響應消息應該是怎樣的。soap:body 的內(nèi)容是由 schema 定義的，因此你所需要做的就是查看該 schema 來了解響應消息的內(nèi)容。比如，參考清單 15 來查看清單 8 中的 WSDL 文件的響應消息。

<soap:envelope>
    <soap:body>
        <myMethodResponse/>
    </soap:body>
</soap:envelope>

但是用于 RPC 樣式響應的 soap:body 的子元素是什么呢？WSDL 1.1 規(guī)范并不是很清楚。但是 WS-I 解決了這個問題。WS-I 的 Basic Profile 指明了在 RPC/文字響應消息中，soap:body 子元素的名稱是“... 相應的 wsdl:operation 名稱加上字符串 'Response' 作為后綴。”奇怪！這正是常規(guī)包裝模式的響應元素的名稱。因此清單 15 可以應用到 RPC/文字消息和文檔/文字包裝的消息。（因為 RPC/編碼并不是遵守 WS-I 的，WS-I Basic Profile 并不關(guān)心 RPC/編碼的響應是怎樣的，但是你可以假設應用在這里的約定也可以應用在其他任何地方。）因此響應消息的內(nèi)容并不神秘。

結(jié)束語
這里有四種綁定樣式（其實是五個，但是文檔/編碼的樣式是沒有意義的）。雖然每種樣式都有自己的用處，但是在大多數(shù)情況下，最好的樣式是文檔/文字包裝的樣式。

參考資料

• 您可以參閱本文在 developerWorks 全球站點上的 英文原文。
  
  
• 通過指南“Web services with WSDL”（developerWorks，2003 年 2 月），獲得對 WSDL 目的和語義的完整理解，并且了解如何通過 WSDL 實現(xiàn) Web 服務之間的互操作。
  
  
• 閱讀文章“Handle namespaces in SOAP messages you create by hand” （developerWorks，2005 年 5 月），了解關(guān)于手動創(chuàng)建 SOAP 消息的方法，以及不使用工具來處理命名空間問題的方法。
  
  
• 閱讀 Web Services Description Language (WSDL) 1.1，WSDL 規(guī)范.
  
  
• 閱讀 WSDL 2.0 規(guī)范草案 以了解 WSDL 的發(fā)展情況。
  
  
• 閱讀 SOAP 1.2 Primer，SOAP 1.2 規(guī)范的介紹。
  
  
• Java API for XML-Based RPC (JAX-RPC) Downloads & Specifications 提供了到 JAX-RPC 1.1 規(guī)范的鏈接，以及 javadocs、類文件和 Sun 的 JAX-RPC 參考實現(xiàn)。
  
  
• 瀏覽 WS-I（Web Services Interoperability） 組織的 Web 頁面。
  
  
• 閱讀 the WS-I's profiles。特別是基本概要。
  
  
• 訪問 Developer Bookstore，獲取技術(shù)書籍的完整列表，包含數(shù)百篇 Web 服務 主題的文章。
  
  
• 通過加入 developerWorks blogs 加入到 developerWorks 社區(qū)。
  
  
• 更多信息？developerWorks SOA and Web services 專區(qū)有數(shù)百篇文章以及關(guān)于如何開發(fā) Web 服務應用程序入門級、中級和高級教程。