DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> XML學習教程 >> XML詳解
Web 服務技巧:用 xsd:any 元素實作自訂序列化
編輯:XML詳解     

一般情況下,JAX-RPC 會假設出現在 SOAP 訊息中的 XML 元素都應該映射成 Java 物件。簡單型別與複雜型別各自有對應的映射規則,而 JAX-RPC 的實作通常也會提供產生這些映射所需程式碼的工具。好消息是:當你處理的是應用中的 Java 物件時,完全不必操心型別映射與序列化/反序列化——不用知道 XML 元素該怎麼解析、該交給哪個 Java 物件,也不用想反向的問題。

然而在某些情況下,你可能希望親手掌控(反)序列化的過程,或者乾脆就不想把 XML 資料映射成 Java 物件。幸好 JAX-RPC 留了這樣的後門,本文就示範怎麼做。

SAAJ:JAX-RPC 底下的 SOAP 處理層

JAX-RPC 規範依賴 SAAJ(SOAP with Attachments API for Java)來處理 SOAP 訊息。SAAJ 定義了 SOAP 訊息各個部分的類別與介面:從 javax.xml.soap.SOAPMessage 開始,透過它取得 javax.xml.soap.SOAPEnvelope 執行個體,再由這個執行個體取出 javax.xml.soap.SOAPHeader 與 javax.xml.soap.SOAPBody,以此類推。這些執行個體全都繼承自 javax.xml.soap.SOAPElement 介面,而這個介面本身又擴充了 W3C DOM 的 Node 介面。

換句話說,SAAJ 提供你一個以 XML 為中心的視角來看待 SOAP 訊息中的元素,而 JAX-RPC 把所有訊息處理都委託給了 SAAJ。這裡我不打算全面介紹 SAAJ,只談與本文主題相關的部分。

<xsd:any/> 元素

<xsd:any/> 代表 XML 文件中的任意 XML 內容。顧名思義,它可以是任何一種 XML。這讓你能在 XML Schema 中定義複雜型別時,不必描述其中某些部分的具體結構。清單 1 展示了一個名為 Order 的型別定義,它包含兩個普通元素與一個 <xsd:any/> 元素。

清單 1. 帶有 <xsd:any/> 的 XML Schema

<schema elementFormDefault="qualified"
    targetNamespace="https://anytip.webservices.ibm.com"
    xmlns="https://www.w3.org/2001/XMLSchema">
  <complexType name="Order">
    <sequence>
      <element name="createDate" nillable="true" type="xsd:dateTime"/>
      <element name="customer" nillable="true" type="xsd:string"/>
      <xsd:any maxOccurs="unbounded"/>
    </sequence>
  </complexType>
</schema>

這種型別的執行個體可以帶上任意多個額外的 XML 元素,而不違反 schema 定義。也就是說,你能在不修改 Schema 的前提下,往 Order 元素裡塞進額外資訊。

把一切組合起來

那麼 JAX-RPC 是怎麼處理含 <xsd:any/> 的 XML Schema 呢?依 JAX-RPC 1.1 規範,這個元素會被映射到 SAAJ 的 javax.xml.soap.SOAPElement 介面。這意味著服務端點介面中,凡是 schema 用到 <xsd:any/> 的地方,都會出現一個 javax.xml.soap.SOAPElement 型別的參數或返回值;如果 maxOccurs 大於 1,則是 javax.xml.soap.SOAPElement[]。

因此,JAX-RPC 工具會從上面那份樣本 Schema 產生如下的類別(如常,這個範例只是用來說明概念,完整原始碼請見參考資料):

清單 2. 產生的 Order 類別

public class Order implements java.io.Serializable {
  private java.util.Calendar createDate;
  private java.lang.String customer;
  private javax.xml.soap.SOAPElement[] _any;
  ...
}

這跟自訂序列化有什麼關係?假設你的 Web 服務會用到某些你並不想映射成 Java 類別的資料,而是希望 JAX-RPC 引擎直接以 XML 形式交給實作——實作再自行解析,或者乾脆把它當 XML 轉傳給後端應用做進一步處理。同樣地,你也可以建立一個用戶端代理,讓它以 SOAPElement 而非 Java 物件的形式傳遞資料。

動手做個範例

這個範例的前提是你事先知道 XML 的資料結構。設想你在用一個 OrderManager Web 服務,它會依某些搜尋條件回傳 Order 資料,而每個 Order 執行個體都含有許多行式項目(line items)。清單 3 是 WSDL 的節錄;這是一個刻意簡化的服務,我們只關注 <types> 部分。

清單 3. Web 服務的 WSDL

<?xml version="1.0" encoding="UTF-8"?>
<wsdl:definitions ...>
  <wsdl:types>
    <schema elementFormDefault="qualified"
        targetNamespace="https://any.webservices.ibm.com"
        xmlns="https://www.w3.org/2001/XMLSchema">
      <element name="getOrder">
        <complexType>
          <sequence>
            <element name="searchCriteria"
                nillable="true" type="xsd:string"/>
          </sequence>
        </complexType>
      </element>
      <complexType name="Order">
        <sequence>
          <element name="createDate" nillable="true" type="xsd:dateTime"/>
          <element name="customer" nillable="true" type="xsd:string"/>
          <element name="lineItems" nillable="true" type="impl:LineItem"
              maxOccurs="unbounded"/>
        </sequence>
      </complexType>
      <complexType name="LineItem">
        <sequence>
          <element name="itemDesc" nillable="true" type="xsd:string"/>
          <element name="itemNumber" nillable="true" type="xsd:string"/>
        </sequence>
      </complexType>
      <element name="getOrderResponse">
        <complexType>
          <sequence>
            <element name="getOrderReturn"
                nillable="true" type="impl:Order"/>
          </sequence>
        </complexType>
      </element>
    </schema>
  </wsdl:types>
  ...
</definitions>

現在想像一下:你不想讓 JAX-RPC 引擎依照 schema 產生對應結構的 LineItem Java 類別,而想自己處理這段 XML——或許是因為你打算把它原封不動以 XML 形式存進資料庫,解析反而多此一舉。那麼在產生用戶端程式碼之前,你要先修改 WSDL,把表示 lineItem 的那個元素換成 <xsd:any/>。改完之後,Order 複雜型別的模樣就跟前面清單 2 看到的完全一樣,而 JAX-RPC 工具這次產生的 Order 類別裡,會是一個 SOAPElement 屬性,不再是 LineItem 類別。

接著,你就可以撰寫從 Web 服務取回 Order 的用戶端程式,並以 XML 形式使用那些行式項目資訊。清單 4 是一個範例測試用戶端,由 WebSphere Application Server V5.0.2 產生,大致會長這樣:

清單 4. 範例用戶端程式碼

public class TestMain {
  public static void main(String[] args) throws Exception {
    OrderManager om =
        new OrderManagerServiceLocator().getOrderManager();
    Order order = om.getOrder("whatever");
    SOAPElement lineItem = order.get_any()[0];
    System.out.println("Line item is : " + lineItem.toString());
  }
}

這個用戶端應用拿到的 Order 是 Java 物件,但行式項目資訊則是透過 SOAPElement 陣列、以 XML 的形式回傳。

總結

JAX-RPC 提供的是一個以 Java 為中心的視角來看 Web 服務。如果你想自己掌握 SOAP 訊息中的某些 XML 內容,可以搭配 SAAJ API 與 <xsd:any/> 元素來達成。而未來版本的 JAX-RPC 引擎應該會讓這一切更省事——事實上 JAX-RPC 1.1 規範就要求符合規範的工具,對每個型別都提供「映射成 Java 類別」或「映射成 javax.xml.soap.SOAPElement」的選項。

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