在深入探討資料綁定的種種細節、尤其是動手把資料綁定工具包套用到一般程式設計問題之前,你得先決定要用哪一套工具包。我的原則一向是:軟體要自己親自挑選,因為每個人的程式設計需求都獨一無二。話雖如此,程序員在做這類決策時所依據的資訊,卻是具有普遍性的。本文就依據這些通用原則來剖析 JAXB,並幫助你判斷它是否適合自己的資料綁定需求。
不過在正式展開 JAXB 的討論前,我想先快速回顧上一篇文章中介紹過的幾個關鍵定義:
本文對這些術語的使用會稍微寬鬆一些,但務必真正掌握每個概念的內涵。
還有一點要牢記:本文乃至後續幾篇,重點往往不在「基本功能」本身,而在「功能的實作品質」。每套資料綁定工具包都能編組與解組資料,但許多工具包在執行這項任務時並不夠嚴謹,結果反而破壞了往返的語義等價性。實作上的瑕疵(或功能不完整)正是本系列前幾篇的核心關注點——因此我會花上幾篇篇幅來說明工具包的基本用法。想想看,如果不確定一個工具包是否「真正」有效,那用它又有什麼意義呢?
最後,我假設你已經安裝並跑得起 JAXB。developerWorks 上有大量文章詳述安裝流程,而且有了新版 Sun Java Web Services Developer Toolkit,安裝變得非常簡單。只要工具包就位、classpath 設定正確,就萬事俱備了。
在使用 JAXB 之前,你得先產生代表 XML 資料的 Java 類別。以下範例會用到一份非常簡單的 XML 文件,如清單 1 所示——這是一份吉他清單,吉他正好是我的嗜好之一。
清單 1. 簡單的 XML 文件:吉他清單
<guitars>
<guitar id="10021">
<builder luthier="true">Ryan</builder>
<model>Mission Grand Concert</model>
<back-sides>Brazilian Rosewood</back-sides>
<top>Adirondack Spruce</top>
<notes>
<![CDATA[
Just unbelievable... this guitar has all the tone &
resonance you could ever want. I mean, <<WOW!!!>> This
is a lifetime guitar.
]]>
</notes>
</guitar>
<guitar id="0923">
<builder smallShop="true">Bourgeois</builder>
<model>OMC</model>
<back-sides>Bubinga</back-sides>
<top>Adirondack Spruce</top>
</guitar>
<guitar id="11091">
<builder>Martin & Company</builder>
<model>OM-28VR</model>
<back-sides>Indian Rosewood</back-sides>
<top bearclaw="true">Sitka Spruce</top>
<notes>It's certainly true that Martin isn't the only game in town anymore.
Still, the OM-28VR is one of their best models... and this one
has some fabulous bearclaw to boot. Nice specimen of a
still-important guitar manufacturer.
</notes>
</guitar>
</guitars>
使用 JAXB 時,還需要一份 XML Schema 才能產生類別與資料結構。清單 1 對應的 Schema 如清單 2 所示。
清單 2. 清單 1 的 XML Schema
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="https://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<xs:element name="back-sides" type="xs:string"/>
<xs:element name="builder">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="luthier" default="false">
<xs:simpleType>
<xs:restriction base="xs:NMTOKEN">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="smallShop" default="false">
<xs:simpleType>
<xs:restriction base="xs:NMTOKEN">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name="guitar">
<xs:complexType>
<xs:sequence>
<xs:element ref="builder"/>
<xs:element ref="model"/>
<xs:element ref="back-sides"/>
<xs:element ref="top"/>
<xs:element ref="notes" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="id" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
<xs:element name="guitars">
<xs:complexType>
<xs:sequence>
<xs:element ref="guitar" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="model" type="xs:string"/>
<xs:element name="notes" type="xs:string"/>
<xs:element name="top">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="bearclaw" default="false">
<xs:simpleType>
<xs:restriction base="xs:NMTOKEN">
<xs:enumeration value="true"/>
<xs:enumeration value="false"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
</xs:schema>
有了 XML 與 Schema,產生 JAXB 類別就很簡單了。確認命令列與環境設定就緒後,輸入以下指令:
xjc -p com.ibm.dw guitars.xsd -d src
請務必在與 guitars.xsd 相同的目錄下執行上述指令,並在工作目錄中先建立一個 src 目錄。否則就會出現某種 java.io.IOException 錯誤。一切順利的話,你應該會看到一長串輸出,如清單 3 所示。
清單 3. JAXB 類別產生的輸出
C:\developerworks>xjc -p com.ibm.dw guitars.xsd -d src
parsing a schema...
compiling a schema...
com\ibm\dw\impl\runtime\MSVValidator.java
com\ibm\dw\impl\runtime\SAXUnmarshallerHandlerImpl.java
com\ibm\dw\impl\runtime\ErrorHandlerAdaptor.java
...(其餘 runtime 類別略)
著實有點多——請注意,即使面對的是相當簡單的 XML Schema,JAXB 也一口氣產生了大量類別。
介紹完基本步驟,接下來我們實際分析一下其中究竟發生了什麼。不必浪費時間複習 JAXB 基礎(其他文章已講得很好),這裡只說重點:每個元素都會對應到兩個原始檔,一個與元素同名(例如 Guitar.java),另一個則在元素名後面加上「Type」(如 GuitarType.java)。這兩者都是介面,類別的實作則放在 impl 子目錄下。如此一來就產生了大量類別——我認為確實有些誇張。
但真正有意思的,是這些類別本身。要知道,資料綁定實作的主要難題之一就是往返——也就是從 XML 到 Java 程式碼、再回到 XML 的過程中,資料不會出現意料之外的變化。換句話說,進去的是什麼,出來的也該是什麼。目前你還沒準備好透過「解組—編組」循環來測試輸出(之後才會做),因此先來看看原始碼裡可能潛藏的問題。
第一個問題,出現在幾乎所有資料綁定工具包都容易出包的地方:型別對應。即使有 XML Schema 從旁協助,XML 也未必能與 Java 型別完美對接。這通常意味著會流失部分型別資訊,甚至摻入非法資料。有時問題出在 Schema 本身,有時則源於 XML 到 Java 映射的先天限制,因此必須仔細檢視。原始碼中就有這麼一個例子——top 元素的表示方式。請留意清單 4 中粗體那一行,它來自 TopType 類別的原始碼。
清單 4. TopType.java 的原始碼
package com.ibm.dw;
public interface TopType {
java.lang.String getValue();
void setValue(java.lang.String value);
java.lang.String getBearclaw(); // 注意:這裡用的是 String 而非 boolean
void setBearclaw(java.lang.String value);
}
回頭對照原始文件與它的 Schema 就會發現,bearclaw 屬性的值理應只能是「true」或「false」。可惜 JAXB 並未察覺這點而改用布林型別,於是 TopType 類別的這個屬性可以接受任何字串值,結果就可能產生錯誤資料。最終,欄位裡可能出現「True」、「true」、「tRUe」或任何變化形式,讓使用該 XML 的應用程式無所適從。換句話說,你碰上了一個必須設法解決的問題域。
這類問題通常有以下幾種解法:
前兩種做法顯而易見;第三種也很簡單,儘管 W3C 那幫人其實早就該把這一點寫進規範裡。清單 5 給出了一個簡單的布林型別定義:
清單 5. Schema 中的布林型別
<xsd:simpleType name="xsd:boolean">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="true"/>
<xsd:enumeration value="True"/>
<xsd:enumeration value="TRUE"/>
<xsd:enumeration value="false"/>
<xsd:enumeration value="False"/>
<xsd:enumeration value="FALSE"/>
</xsd:restriction>
</xsd:simpleType>
看起來挺美,是吧?但問題是,它並沒有真正解決問題。由於 JAXB 是依據 Schema 中 xsd:string 的用法來運作,牠仍然會產生接受字串參數的類別。
在你急著告訴我這算不上問題之前,先讓我說明 JAXB 是靠什麼來保護你的資料。當從 Java 類別編組回 XML 時,會呼叫依據 Schema(以及像清單 2、清單 5 那樣的受限型別)產生的驗證方法。也就是說,如果你替 bearclaw 屬性填入「foobar」這種值,它會被抓出來。不過像「TRUe」、「fAlSe」、「tRue」這類值——這當然不是你想要的——在驗證過程中同樣會被揪出來。於是你就得動用清單 5 中那個定義繁瑣的型別,還得時時留意「true」與「false」因大小寫而生的種種變化。這種瑣碎工作看著就令人頭痛,而正是這類問題,讓往返變得格外複雜——說起來容易,真正實作起來卻難得多。這也恰恰是選擇與使用資料綁定工具包時最該列入考量的那類問題。
更值得警惕的是(至少對我而言如此),這可能衍生出超出單次往返範圍的麻煩。要知道,錯誤檢查只在編組時進行,這意味著只要資料還留在記憶體中,錯誤值就能在各成員變數裡安然存在、靜待編組。此外,凡是具有有限值集合的屬性都有這種隱憂,而不只是布林值。但最棘手的莫過於:有些時候 XML 文件被讀入、處理後是供其他應用程式使用,而不會被編組回 XML。因此,任何應用程式都可能往這些欄位裡塞入錯誤資料,而後續所有使用該資料的程式都會一併中招。除非你願意每次存取資訊時都重新編組一遍,否則這個問題便如影隨形。順帶一提,這些現象也反映出資料綁定技術整體仍不夠成熟,而不單是 JAXB 一家之過。
那麼,你能做些什麼呢?首先,請持續關注這些文章。我會逐一剖析 JAXB,之後還會探討 Castor,並標示出那些需要特別留神的地方。唯有先弄清問題的癥結所在,才能寫出滴水不漏的防護程式與錯誤檢查——這正是本文乃至後續幾篇的核心所在。更重要的是,你要認清一件事:即便是最優秀的資料綁定工具包,也往往需要一兩個高手再補上額外的保護措施,才能真正跑得穩當。
最後還要記住,資料綁定並非萬靈丹。我並不想澆熄你對它的興趣,恰恰相反,我認為它是個了不起的應用。但有時候,一段簡單的 SAX 程式或一棵 DOM 樹就足以滿足全部需求,實在不必為此引入資料綁定帶來的那份複雜。在往後的專欄中,我將分析使用資料綁定的最佳時機、何時改用 SAX 或 DOM 更划算,並透過大量實例幫助你做出決策。
顯然,這裡對 JAXB 的分析還算不上完整,但你已經見識到一套研究資料綁定工具包時極具價值的分析方法。挑選一個資料綁定工具包,遠比挑選喜歡的網站、點擊連結要複雜得多;務必確保你選的應用程式能夠妥善處理像往返這樣的課題。
就現階段而言,JAXB 仍不夠成熟,它是一款新興技術的早期主要版本。還要記得,JAXB 過去的幾個版本基本上已被淘汰(還記得當初它只吃 DTD 嗎?如今則只支援 XSD),因此 1.x 版算是對這類問題的第一次真正嘗試。這並不是說你不該用 JAXB,而是提醒你必須小心謹慎。
下一篇,我將從類別產生過渡到解組與編組,示範它究竟如何運作,並深入探討空白、CDATA 區段等諸多細節的處理。敬請期待——下一篇會有更多程式碼、更多細節,也更多樂趣。我們下回線上見!