大家為什麼喜歡用 xsd:any?我聽過的理由還真不少:為了鬆耦合、為了支援版本演進、為了取得完全自由的多型。但追根究柢,這些理由最後都指向同一件事——不必修改 API。這聽起來相當誘人,然而在實務上,xsd:any 既不恰當也不實際。
如果你所處的是動態環境、手上處理的只有 XML,那麼 xsd:any 確實很合適(也的確如此)。但大多數人並不喜歡動態存取 XML(也就是 SAX、DOM 或 SAAJ 那套程式設計模型)的複雜度;就算他們不介意,動態性本身也有上限。更關鍵的是,XML 幾乎從不「真空」存在,它總是會被映射到別的物件,或與其他物件互動。例如某份 XML 模式可能是 Web 服務的一部分,這就意味著語言綁定的問題避不開。因此,語言綁定會把 xsd:any 映射成該語言中的什麼東西,值得你事先留意。本文就以 JAX-RPC 的 Java 語言綁定為例來談。
先看清單 1 這份 WSDL。這是一個簡單的寵物醫院 Web 服務,定義了一個名為 registerPet 的操作,其輸入訊息包含一個 xsd:any;同時也定義了兩種寵物型別:cat 與 fish。
清單 1. 使用 xsd:any 的獸醫服務 WSDL
<?xml version="1.0" encoding="UTF-8"?>
<definitions
targetNamespace="urn:any"
xmlns:soap="https://schemas.xmlsoap.org/wsdl/soap/"
xmlns:tns="urn:any"
xmlns:wsdl="https://schemas.xmlsoap.org/wsdl/"
xmlns="https://schemas.xmlsoap.org/wsdl/">
<types>
<schema
targetNamespace="urn:any"
xmlns:tns="urn:any"
xmlns:xsd="https://www.w3.org/2001/XMLSchema"
xmlns="https://www.w3.org/2001/XMLSchema">
<complexType name="Cat">
<sequence>
<element name="name" type="xsd:string"/>
<element name="breed" type="xsd:string"/>
</sequence>
</complexType>
<complexType name="Fish">
<sequence>
<element name="name" type="xsd:string"/>
<element name="saltWater" type="xsd:boolean"/>
</sequence>
</complexType>
<element name="registerPet">
<complexType>
<sequence>
<any namespace="##any"/>
</sequence>
</complexType>
</element>
<element name="registerPetResponse">
<complexType>
<sequence/>
</complexType>
</element>
</schema>
</types>
<message name="registerPetRequest">
<part name="registerPetRequest" element="tns:registerPet"/>
</message>
<message name="registerPetResponse">
<part name="registerPetResponse" element="tns:registerPetResponse"/>
</message>
<portType name="Vet">
<operation name="registerPet">
<input message="tns:registerPetRequest"/>
<output message="tns:registerPetResponse"/>
</operation>
</portType>
<binding name="VetSOAP" type="tns:Vet">
<soap:binding style="document"
transport="https://schemas.xmlsoap.org/soap/http"/>
<operation name="registerPet">
<soap:operation/>
<input><soap:body use="literal"/></input>
<output><soap:body use="literal"/></output>
</operation>
</binding>
<service name="VetService">
<port name="VetSOAP" binding="tns:VetSOAP">
<soap:address location="https://localhost:9080/VetService/services/Vet"/>
</port>
</service>
</definitions>
registerPet 的 xsd:any 參數,實際上可以是下列二者之一:
請注意,上面這兩點並沒有寫在 WSDL 裡,是我自己推敲出來的。WSDL 是 Web Services Description Language(Web 服務描述語言)的縮寫,它主要的用途就是盡可能完整地描述服務的介面。一旦用了 xsd:any,你就背離了這個初衷。
第一點說這個參數會是 cat 或 fish——但 WSDL 並沒告訴你這件事,它只說「可以是任何東西」。考慮到這是一個獸醫服務,大概不會去處理訂單、保險理賠或報稅表;但你也可能猜錯,因為 WSDL 根本沒說。
第二點說其他型別會在別處定義,這等於承認這份 WSDL 並不是該服務的完整介面。有人會覺得「這樣就能改服務而不動 API」,但既然 WSDL 本身不完整,這個說法就站不住腳。對於拿這份 WSDL 的用戶端來說,光靠它並不足以成功與服務溝通。客戶能不能送一隻鱷魚來看診?只看 WSDL 你無從得知(能替鱷魚看病的獸醫,我認識的也不多)。你需要一些額外的、介面之外的補充定義。
更好的做法是定義真正的多型:建立一個基底型別 Pet,再讓 Cat 與 Fish 去擴充它。
最後,要真正用上這個服務,你還是得把 WSDL 映射到某個語言綁定。這裡來看 JAX-RPC 的情況。依 JAX-RPC 規範,xsd:any 會被映射成 javax.xml.soap.SOAPElement,這是 SAAJ 規範中定義的型別。SAAJ 是一組類似 DOM 的 API,用來存取 SOAP 訊息中的 XML 執行個體,屬於相當動態的低階做法,算不上友善。清單 2 是清單 1 那份 WSDL 產生的 Java 介面:
清單 2. 使用 xsd:any 的 WSDL 所對應的 Java 介面
package any;
public interface Vet extends java.rmi.Remote {
public void registerPet(javax.xml.soap.SOAPElement any)
throws java.rmi.RemoteException;
}
對習慣動態寫法的人來說,這或許是個很不錯的映射;但其他大部分人寧願拿到自動產生的 Cat 與 Fish 類別,也不想面對 SOAPElement。如果能把 Cat 或 Fish 直接放進 SOAPElement 裡,那也還好,偏偏 SAAJ 並沒有提供這種轉換方式。JAX-RPC 雖然規定 xsd:any 映射到 SOAPElement,卻沒有給你在類別執行個體與 SOAPElement 之間來回轉換的方法。
如果你本來就習慣 DOM、SAX 或 SAAJ,xsd:any 對你不是問題。但請替你的 WSDL 使用者想一想:僅僅因為你習慣這種層級的程式設計,你的介面消費者是否也同樣熟悉?
xsd:any 還有一個替代品:xsd:anyType(清單 3 是對應的 WSDL,與清單 1 的差異以粗體標示;清單 4 是 Java 介面)。它的缺點在於 JAX-RPC 並未為它定義映射,因此即使某個供應商實作了這個 XML 型別的映射,你仍然寫不出可攜的程式碼。
話雖如此,這個型別還是有個優勢:部分供應商(例如 IBM)把它映射成 java.lang.Object 這類實用的型別。對 WebSphere Application Server 的 SOAP 引擎來說,如果某個方法接受 java.lang.Object 型別的參數,你就能把任何 Java 物件送進去,只要該物件符合 XML 標準,就能序列化進 SOAP 訊息。另一方面,如果接收端的 SOAP 引擎知道怎麼把 XML 執行個體反序列化回 Java 物件,它就會照做;若不知道,接收方拿到的會是一個 SOAPElement,跟使用 xsd:any 時的結果一樣。
請記住:即使 xsd:anyType 看起來比 xsd:any 好用,缺乏 JAX-RPC 映射支援仍是硬傷。只有在下列條件成立時,它才真的佔優勢:
xsd:anyType 的某種映射。清單 3. 使用 xsd:anyType 的獸醫服務 WSDL
<?xml version="1.0" encoding="UTF-8"?>
<definitions
targetNamespace="urn:any"
xmlns:soap="https://schemas.xmlsoap.org/wsdl/soap/"
xmlns:tns="urn:any"
xmlns:wsdl="https://schemas.xmlsoap.org/wsdl/"
xmlns="https://schemas.xmlsoap.org/wsdl/">
<types>
<schema
targetNamespace="urn:any"
xmlns:tns="urn:any"
xmlns:xsd="https://www.w3.org/2001/XMLSchema"
xmlns="https://www.w3.org/2001/XMLSchema">
<complexType name="Cat">
<sequence>
<element name="name" type="xsd:string"/>
<element name="breed" type="xsd:string"/>
</sequence>
</complexType>
<complexType name="Fish">
<sequence>
<element name="name" type="xsd:string"/>
<element name="saltWater" type="xsd:boolean"/>
</sequence>
</complexType>
<element name="registerPet">
<complexType>
<sequence>
<element name="pet" type="xsd:anyType"/>
</sequence>
</complexType>
</element>
<element name="registerPetResponse">
<complexType>
<sequence/>
</complexType>
</element>
</schema>
</types>
<message name="registerPetRequest">
<part name="registerPetRequest" element="tns:registerPet"/>
</message>
<message name="registerPetResponse">
<part name="registerPetResponse" element="tns:registerPetResponse"/>
</message>
<portType name="Vet">
<operation name="registerPet">
<input message="tns:registerPetRequest"/>
<output message="tns:registerPetResponse"/>
</operation>
</portType>
<binding name="VetSOAP" type="tns:Vet">
<soap:binding style="document"
transport="https://schemas.xmlsoap.org/soap/http"/>
<operation name="registerPet">
<soap:operation/>
<input><soap:body use="literal"/></input>
<output><soap:body use="literal"/></output>
</operation>
</binding>
<service name="VetService">
<port name="VetSOAP" binding="tns:VetSOAP">
<soap:address location="https://localhost:9080/VetService/services/Vet"/>
</port>
</service>
</definitions>
清單 4. 使用 xsd:anyType 的 WSDL 所對應的 Java 介面
package any;
public interface Vet extends java.rmi.Remote {
public void registerPet(java.lang.Object pet)
throws java.rmi.RemoteException;
}
雖然在 Web 服務的 XML 模式中使用 xsd:any 乍看是個不錯的主意,但它確實有兩處缺陷:你會背離 WSDL 描述介面的初衷,而它的語言映射也未必好用。我不會說用 xsd:any 絕對是壞做法,但希望這篇文章能讓你在問題真正爆發之前,對即將出現的狀況有更好的心理準備。