DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> XML學習教程 >> XML詳解
實用資料綁定:深入 JAXB 第二部分——往返能力的實測驗證
編輯:XML詳解     

資料綁定 API 之所以實用,在於它能讓我們用程式碼輕鬆操作 XML。一句 someElement.addAttribute("name", "value");,比起手動解析檔案、緩衝輸出、拼湊屬性宣告字元、關閉並刷新串流這一整套流程,實在輕鬆太多了。但如果無法把變動正確地寫回檔案,這些操作終究只是徒勞。本文的焦點,正是資料綁定世界中所謂的「編組」(marshalling)歷程,特別是 JAXB 的編組能力——具體來說,你將看到 JAXB 在「往返」這件事上的實際表現究竟如何。

名詞回顧

在本系列第一篇中,我們介紹過幾個關鍵術語:「編組」與「解組」(unmarshalling)是資料綁定世界裡固有的概念;此外還有兩個新詞值得留意——「往返」與「語義等價」。往返,指的是從 XML 轉換成 Java 程式碼、再轉換回 XML 的整個過程;而衡量資料綁定往返能力好壞的標準,正是輸入與輸出文件之間的吻合程度。語義等價則讓這種比對成為可能:它容許我們忽略 XML 中無關緊要的成分(例如可略去的空白),從而進行有效的比較。

在第二篇裡,我曾中介一份簡單的 XML 文件,這裡再次列出,如清單 1 所示。

清單 1. 吉他清單的基本 XML(guitars.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>

我同樣為這份文件準備了一個結構描述(Schema),為了精簡篇幅這裡不再重複列出。要說明的是如何從這個 Schema 產生 Java 原始碼,如清單 2 所示。

清單 2. 產生的 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 類別略)

請務必確認這些 Java 原始碼已產生並編譯完成,以便後續使用;詳細步驟可參閱本系列的前一篇文章。

從 XML 到 Java 程式碼

只要這些類別準備就緒,就能把清單 1 的 XML 文件解組成 JAXB 在記憶體中的模型。這是檢驗 JAXB 往返能力的第一步。由於本文並非 JAXB 入門教學,我把程式碼直接列在下方,如清單 3 所示。

清單 3. 將 XML 解組為 Java 程式碼

import java.io.FileInputStream;
import javax.xml.bind.*;
// 匯入產生的類別
import com.ibm.dw.*;
public class RoundTripper {
 private String inputFilename;
 private String outputFilename;
 private JAXBContext jc;
 private final String PACKAGE_NAME = "com.ibm.dw";
 public RoundTripper(String inputFilename, String outputFilename) throws Exception {
 this.inputFilename = inputFilename;
 this.outputFilename = outputFilename;
 jc = JAXBContext.newInstance(PACKAGE_NAME);
 }
 public Guitars unmarshal() throws Exception {
 Unmarshaller u = jc.createUnmarshaller();
 return (Guitars) u.unmarshal(new FileInputStream(inputFilename));
 }
 public static void main(String[] args) {
 if (args.length < 2) {
 System.err.println("Incorrect usage: java RoundTripper"
 + "[input XML filename] [output XML filename]");
 return;
 }
 try {
 RoundTripper rt = new RoundTripper(args[0], args[1]);
 Guitars guitars = rt.unmarshal();
 } catch (Exception e) {
 e.printStackTrace();
 return;
 }
 }
}

註:若設定或執行這些類別時遇到問題,請參閱本文最後的「執行範例程式」一節。

或許有人會想:是不是該先把記憶體中的版本印出來看看?其實不必——因為用來列印記憶體內容的 API,本身也能把資料寫入輸出串流,所以這一步可以直接省略。

從 Java 程式碼回到 XML

接著,我們可以要求 JAXB 把記憶體中的表示再度寫回 XML,藉此觀察輸入與輸出文件的差異。我已在 RoundTripper 類別中補上了一些程式碼來完成這項工作,如清單 4 所示。

清單 4. 將 Java 編組為 XML

import java.io.FileInputStream;
import java.io.FileOutputStream;
import javax.xml.bind.*;
// 匯入產生的類別
import com.ibm.dw.*;
public class RoundTripper {
 private String inputFilename;
 private String outputFilename;
 private JAXBContext jc;
 private final String PACKAGE_NAME = "com.ibm.dw";
 public RoundTripper(String inputFilename, String outputFilename) throws Exception {
 this.inputFilename = inputFilename;
 this.outputFilename = outputFilename;
 jc = JAXBContext.newInstance(PACKAGE_NAME);
 }
 public Guitars unmarshal() throws Exception {
 Unmarshaller u = jc.createUnmarshaller();
 return (Guitars) u.unmarshal(new FileInputStream(inputFilename));
 }
 public void marshal(Guitars guitars) throws Exception {
 Marshaller m = jc.createMarshaller();
 m.marshal(guitars, new FileOutputStream(outputFilename));
 }
 public static void main(String[] args) {
 if (args.length < 2) {
 System.err.println("Incorrect usage: java RoundTripper"
 + "[input XML filename] [output XML filename]");
 return;
 }
 try {
 RoundTripper rt = new RoundTripper(args[0], args[1]);
 Guitars guitars = rt.unmarshal();
 rt.marshal(guitars);
 } catch (Exception e) {
 e.printStackTrace();
 return;
 }
 }
}

同樣地,這段程式碼相當直觀。我以 guitars.xml 作為輸入執行這個程式,並指定 output.xml 作為輸出檔名。執行過程沒有什麼值得一提的畫面,一切就像寫到終端機上的文字一樣;但跑完之後,你會得到一個新檔案(output.xml)。理論上,由於記憶體中的內容並未被更動,這個檔案應該是 guitars.xml 的完整複本。

拿蘋果比蘋果

產生 output.xml 之後把它打開,即使不完全相同,內容也應該和清單 5 類似。

清單 5. output.xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<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>
 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 在往返過程中的實際表現(原始文件見清單 1)。

自動加上 XML 宣告

首先你會注意到,輸入檔原本並沒有 XML 宣告(也就是以 <?xml version=... 開頭的那一行),而 JAXB 卻自動在輸出中補上了這一行。這看似小事,其實相當關鍵——如今我們常常需要把一份 XML 文件嵌進另一份 XML 文件裡,特別是在使用 SOAP 或其他傳輸技術時。問題在於,一份 XML 文件只能有一個宣告。把 guitars.xml 嵌進另一份文件並不違反規則;但若換成 output.xml,麻煩就來了。因此,這成了 JAXB 又一項必須留意的特性。

CDATA 區段被移除

另外要留意,原始文件中的 CDATA 區段被拿掉了。嚴格來說,這並未違反語義等價原則——兩份文件的內容在語義上是一致的:前者用 CDATA 來避開實體參照,後者則改以實體參照取代 CDATA。這與其說是語義等價問題,不如說是文件的「事實等價」問題。雖然無傷大雅,但仍值得留意。

空白的處理

令人欣慰的是,空白處理得相當到位。儘管 CDATA 區段被移除了,空白卻被正確地保留了下來;此外,那段關於 Martin OM-28VR 吉他描述裡的長段空白也原樣留存,這點處理得很漂亮。

再跑一遍以確認

檢驗往返能力最好、也最有效的方法,就是「重新測試往返」。但要注意,我說的並不是簡單地再跑一次,而是把這次的輸出檔(output.xml)作為下一次往返的輸入檔。如果這個過程往 XML 裡引入了任何不該有的東西,那麼每多跑一趟,產生的輸出就會離原始檔(guitars.xml)更遠一些。這是隔離問題的絕佳手法。一套好的資料綁定工具,應該能一遍又一遍地產出相同的檔案,尤其是在最初的往返之後。

在這個步驟中,我要求 RoundTripper 以 output.xml 為來源,產生 retest.xml,結果如清單 6 所示。

清單 6. retest.xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<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>
 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>

好消息是:清單 5 與清單 6 完全相同,這代表 JAXB 在經歷最初的往返步驟之後,能夠穩定且可靠地運作。

整體而言,JAXB 表現不俗。雖然我認為自動加上 XML 宣告確實是個問題,但相較於那些會實質影響內容的 API,這還算無傷大雅。JAXB 對 CDATA 區段的處理方式雖與預期略有出入,但確實守住了語義等價。下一篇中,我將介紹更多能影響輸出文件的各種選項,並動手修正 JAXB 造成的一些問題。總的來說,JAXB 已證明自己能很好地按期望保留輸入文件。

執行範例程式

最後,來分享我的一個小絕活——用來輕鬆搞定 classpath 與 JAXB 範例的 Ant 設定。清單 7 就是我在本文中使用的 Ant 建置檔。你只要把裡面的路徑改成自己的 XML 輸入檔與 JAXB JAR 檔即可。

清單 7. Ant 建置檔

<?xml version="1.0"?>
<project basedir="." default="roundtrip">
 <property name="jwsdp.home" value="c:\jwsdp-1.3"/>
 <property name="xml.inputFile" value="guitars.xml"/>
 <property name="xml.outputFile" value="output.xml"/>
 <property name="xml.retestFile" value="retest.xml"/>
 <path id="classpath">
 <pathelement path="build"/>
 <fileset dir="${jwsdp.home}" includes="jaxb/lib/*.jar"/>
 <fileset dir="${jwsdp.home}" includes="jwsdp-shared/lib/*.jar"/>
 <fileset dir="${jwsdp.home}" includes="jaxp/lib/**/*.jar"/>
 </path>
 <taskdef name="xjc" classname="com.sun.tools.xjc.XJCTask">
 <classpath refid="classpath"/>
 </taskdef>
 <target name="compile">
 <xjc schema="guitars.xsd" package="com.ibm.dw" target="src"/>
 <javac srcdir="src" destdir="build" debug="on">
 <classpath refid="classpath"/>
 </javac>
 <copy todir="build">
 <fileset dir="src">
 <exclude name="**/*.java"/>
 </fileset>
 </copy>
 </target>
 <target name="roundtrip" depends="compile">
 <java classname="RoundTripper">
 <arg value="${xml.inputFile}"/>
 <arg value="${xml.outputFile}"/>
 <classpath refid="classpath"/>
 </java>
 </target>
 <target name="roundtrip-retest" depends="roundtrip">
 <java classname="RoundTripper">
 <arg value="${xml.outputFile}"/>
 <arg value="${xml.retestFile}"/>
 <classpath refid="classpath"/>
 </java>
 </target>
</project>

預設情況下,這個檔案會從 Schema 產生原始碼、編譯這些原始碼並複製所需的 JAXB 屬性檔,接著編譯並執行 RoundTripper 類別。你也可以手動執行 roundtrip-retest 目標,以 output.xml 為輸入再跑一趟往返。這支腳本能讓日子輕鬆不少,希望你也會喜歡!

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