DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> XML學習教程 >> XML詳解
Castor 資料綁定實戰(三):用映射檔案打通 Java 類與 XML
編輯:XML詳解     

本系列前兩篇帶你走過 Castor 的安裝設定、編組(marshalling)與解組(unmarshalling)。那些範例都跑在一個很乾淨的環境裡:XML 元素名叫 title、authorAddress,Java 類名整齊、欄位型別得當。真實專案很少這麼美好。這一篇要談的,就是當兩邊都不肯妥協時,映射檔案(mapping file)如何救場。

開始之前:你該具備的基礎

延續前面的假設:請先依第一篇的說明下載並安裝最新版 Castor,設定好 classpath 與相關 Java 函式庫;接著依第二篇熟悉基本的編組與解組流程。也就是說,你應該已經能把 XML 文件的內容讀進自己的 Java 物件(解組),也能把 Java 物件的欄位寫回成 XML(編組)。如果這兩件事還不熟,請先回頭看第二篇,否則本文的映射設定會顯得沒有依據。

理想環境與真實世界的落差

在理想世界裡,每個人都寫出結構漂亮的 XML,Java 類命名有條有理,型別選擇也很恰當——不會有人把 price 宣告成 int,也不會用字元陣列來存字串。

但多數工程師面對的是另一種風景:XML 裡的元素名與屬性名隨意,命名空間纏成一團,該當元素的資料塞在屬性裡,甚至有些欄位是拿管道符或分號串起來的單一字串。Java 這邊也一樣難看——類別已經靠繼承長成一棵深樹,重新整理的成本遠高於收益;類名可能不符合你的領域模型;變數名甚至帶著 Hungarian 表示法的尾巴,像 mTitle 這種。

更麻煩的是,你往往沒有選擇權。幻想「XML 設計者與 Java 工程師各退一步」通常不現實,而即使雙方願意配合,也不可能每一個類、每一個欄位都對得上。當兩邊結構硬碰硬,預設的對應規則就無能為力了。若拿不到想要的資料、也無法用想要的方式操作它,資料綁定框架的意義也就蕩然無存。

映射的價值在哪裡

先誠實說清楚成本:映射檔案有自己的一套語法要學(多數框架都用 XML 描述),要寫測試驗證雙向轉換的結果符合預期,而且既然是你親手指定對應關係,出錯的機會自然比交給框架自動處理時更高。把 XML 裡的 fiddler 映到 Java 的 violin 屬性,卻把類名打成 player(正確應是 Player),這種錯就得靠仔細核對拼字、大小寫、底線與引號來避免。

所以第一件事是確認你真的需要映射。學了卻不用,那是白費工夫。但一旦你的專案符合下列任一情況,映射帶來的彈性就很難被取代。

Java 程式碼不必再遷就 XML 的命名習慣

XML 圈常見的命名法是全小寫加連字號,例如 first-name,偶爾也會看到 first_name。這種名字直接對應成 Java 屬性會很難看,畢竟沒人想寫出 getFirst-name()。工程師寫的 XML 通常會用駝峰式(camel-case)的 firstName,但那只是巧合。有了映射檔案,把 first-name 對到 firstName 只是一行設定的事,而且不必強迫 XML 那邊的人改用 Java 的思考方式——那往往比學會映射語法還難。

XML 也不必遷就 Java 的結構

反過來當然也成立:Java 轉 XML 時,名稱一樣可以改寫。但這裡有個更微妙的好處——你不再被 Java 的類名與套件結構綁住。

一般情況下,XML 的嵌套元素會對應成類別結構,最內層的元素則變成屬性。看看這份 XML:

清單 1. 代表一本書的 XML

<?XML version="1.0" encoding="UTF-8"?>
<book>
  <authors total-sales="0">
    <last-name>Finder</last-name>
    <first-name>Joseph</first-name>
  </authors>
  <isbn>9780312347482</isbn>
  <title>Power Play</title>
</book>

Castor 之類的框架可能會推測你需要一個 Book 類,裡頭引用若干 Author 實例,而 Author 有 lastName 與 firstName 兩個欄位。但如果你的領域模型裡,作家、研討會講者與教授共用一個 Person 或 Professional 類呢?這時你大概不會想為了遷就工具而改寫 XML 的結構與名稱。想原封不動保留這份 XML,映射幾乎是唯一解。

映射讓我們可以在轉換的兩端各自指定命名方式:不必為了 XML 去改 Java,也不必為了 Java 去改 XML。套件(package)也是同理——雖然 Castor 對套件不算敏感,但編組時仍得把類別與套件的資訊寫進 XML,這對「業務邏輯歸 Java、資料歸 XML」的關注點分離並不利。映射正好把這些問題一次收拾乾淨。

讓資料綁定走進既有系統

前兩點其實指向同一個更大的問題:多數專案裡,Java 物件已經存在,XML 文件也已經存在,你沒有前兩篇那種「從零生成兩邊」的自由。你不是要讓 Castor 依自己的規則生出一整套類別,而是要把資料綁定這項新技術,嫁接到既有結構上。

這正是映射檔案的關鍵角色:當「現有的物件模型」與「現有的 XML 結構」這兩個端點都被固定住,映射讓我們仍然能把兩邊的資料接起來。一套好用的映射機制,才是讓資料綁定能在真實環境落地、而不只是投影片上好看的原因。

動手做一個映射案例

延續上一篇的 Book 與 Author 兩個類,我們來看一個具體的對應任務。

清單 2. Book 類

package ibm.XML.castor;

import java.util.LinkedList;
import java.util.List;

public class Book {

    /** The book's ISBN */
    private String isbn;

    /** The book's title */
    private String title;

    /** The authors' names */
    private List<Author> authors;

    public Book() { }

    public Book(String isbn, String title, List<Author> authors) {
        this.isbn = isbn;
        this.title = title;
        this.authors = authors;
    }

    public Book(String isbn, String title, Author author) {
        this.isbn = isbn;
        this.title = title;
        this.authors = new LinkedList<Author>();
        authors.add(author);
    }

    public void setIsbn(String isbn) {
        this.isbn = isbn;
    }

    public String getIsbn() {
        return isbn;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public String getTitle() {
        return title;
    }

    public void setAuthors(List<Author> authors) {
        this.authors = authors;
    }

    public List<Author> getAuthors() {
        return authors;
    }

    public void addAuthor(Author author) {
        authors.add(author);
    }
}

清單 3. Author 類

package ibm.XML.castor;

public class Author {

    private String firstName, lastName;

    public Author() { }

    public Author(String firstName, String lastName) {
        this.firstName = firstName;
        this.lastName = lastName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    public String getFirstName() {
        return firstName;
    }

    public String getLastName() {
        return lastName;
    }
}

補充一句:相較於上一篇,這裡唯一的差異是把 Author 裡的總銷售額(totalSales)欄位移除了,因為它在後續示範中沒有實際意義。

一份有點難纏的 XML

這次換一份不太聽話的文件,看看預設規則會在哪裡卡住。

清單 4. 待綁定的 XML

<?XML version="1.0" encoding="UTF-8"?>
<book>
  <author>
    <name first="Douglas" last="Preston" />
  </author>
  <author>
    <name first="Lincoln" last="Child" />
  </author>
  <book-info>
    <isbn>9780446618502</isbn>
    <title>The Book of the Dead</title>
  </book-info>
</book>

三個不順眼的地方立刻浮現:作者姓名被塞進 name 元素的兩個屬性裡,而不是兩個獨立元素;書名與 ISBN 藏在 book-info 底下,多了一層;而且沒有 authors 這種包裹元素,看不出多個 author 屬於同一個集合。

先想清楚要映射什麼

在碰語法與 API 之前,先把對應關係用白話寫下來,這一步能省掉後面很多 debug:

  • book 元素對應一個 Book 實例。
  • 每個 author 元素對應一個 Author 實例。
  • 產生的 Author 實例要加進 Book 的 authors 清單。
  • Author 的 firstName 取自 name 元素的 first 屬性。
  • Author 的 lastName 取自 name 元素的 last 屬性。
  • Book 的 ISBN 取自 book-info 底下嵌套的 isbn 元素。
  • Book 的書名取自 book-info 底下嵌套的 title 元素。

其中 book 對 Book 這一條,Castor 預設就做得到。真正需要動手的是屬性對元素、多層嵌套、以及集合這三件事。

寫出映射檔案

Castor 的映射就是一份普通的 XML 文件,內容描述 Java 與 XML 之間該怎麼互相轉換。既然你已經熟悉 XML,撰寫門檻其實很低;單純改名稱的映射,幾分鐘就能搞定。完成後,編組與解組的流程不變,只是在程式裡多一次 API 呼叫,把這份檔案載入進去。

mapping 根元素

映射檔案以 XML 宣告開頭,根元素是 mapping。建議把 Castor 的映射 DTD 一起帶上,這樣編輯器就能驗證結構與語法,除錯時省下不少力氣。

清單 5. 最基本的映射檔案骨架

<?XML version="1.0"?>
<!DOCTYPE mapping PUBLIC "-//EXOLAB/Castor Mapping DTD Version 1.0//EN"
    "https://castor.org/mapping.dtd">

<mapping>
    <!-- 所有映射定義都寫在這裡 -->
</mapping>

這個檔案沒有任何實質內容,但它是所有映射的起點。

用 class 元素映射類別

建立骨架後,第一件事幾乎總是把某個 Java 類對應到某個 XML 元素。這裡先把 Book 類對應到 book 元素:加上 class 元素,並在 name 屬性裡寫入完全限定的類名(含套件)。

清單 6. 加入類別映射

<mapping>
    <class name="ibm.XML.castor.Book">
    </class>
</mapping>

接著用嵌套其中的 map-to 元素指定這個類要對應到哪個 XML 元素:

<mapping>
    <class name="ibm.XML.castor.Book">
        <map-to XML="book" />
    </class>
</mapping>

到目前為止,這段設定做的只是 Castor 預設就會做的事。之所以還要寫出來,有兩個理由:一是後續得指定書名與 ISBN 怎麼填;二是既然已經動用映射檔案,乾脆把所有對應關係都寫明白,讓 XML 與 Java 之間的配合一目了然,也避免日後有人誤判哪些地方是靠預設規則撐著的。

用 field 元素映射屬性

類對元素搞定後,就把 Book 的欄位對到 XML 裡的特定元素。Castor 用 field 元素指定要處理的 Java 屬性,再用嵌套的 bind-xml 元素指定對應的 XML 節點。下面把 Book 的 title 對到 title 元素:

<mapping>
    <class name="ibm.XML.castor.Book">
        <map-to XML="book" />
        <field name="Title" type="java.lang.String">
            <bind-xml name="title" node="element" />
        </field>
    </class>
</mapping>

這裡有兩個細節值得盯緊。

第一,name 寫的是屬性名(property),不是成員變數名。Castor 會據此去呼叫 set<PropertyName>()。所以寫 Title 會觸發 setTitle();若誤寫成 foo,Castor 就會去找 setfoo(),那顯然不是你想要的。大小寫務必留意。

第二,type 屬性告訴 Castor 資料是什麼型別。字串範例很單純,但當 XML 裡的數字要以整數、小數或字串形式落地時,這個屬性就變成關鍵。型別請使用完全限定的 Java 類名,例如 java.lang.String。

而在 bind-xml 裡,name 指出要綁定的 XML 節點名稱,node 則決定綁的是元素還是屬性。僅僅切換這個屬性值,就能在元素資料與屬性資料之間自由取用。

用 location 指定元素的位置

現在遇到真正的障礙:書名與 ISBN 不在 book 底下,而是嵌在 book-info 裡。

當某個欄位並不直接對應類別所映射元素底下的資料時,就在 bind-xml 加上 location 屬性。它的值是「含有目標資料的那個元素」:若綁的是元素資料,就填目標元素的父元素;若綁的是屬性資料,就填帶有該屬性的元素。

所以書名的映射寫成這樣:

<field name="Title" type="java.lang.String">
    <bind-xml name="title" node="element" location="book-info" />
</field>

ISBN 依樣畫葫蘶,再補一個欄位映射:

<field name="Isbn" type="java.lang.String">
    <bind-xml name="isbn" node="element" location="book-info" />
</field>

至此 Book 的屬性都設定完成,接下來處理 Author。

映射其他類別

作法相同,唯一差別是其他類別不需要再寫 map-to——它們不是文件中的獨立頂層元素。

要對應的 XML 片段是這樣:

<author>
    <name first="Lincoln" last="Child" />
</author>

這裡的差異是姓名不是兩個元素,而是一個帶兩個屬性的元素。所幸剛才提過的工具都已經齊備:location 用來指出資料在 name 元素上,node 用來宣告要讀的是屬性而非元素。

<class name="ibm.XML.castor.Author">
    <field name="FirstName" type="java.lang.String">
        <bind-xml name="first" node="attribute" location="name" />
    </field>
    <field name="LastName" type="java.lang.String">
        <bind-xml name="last" node="attribute" location="name" />
    </field>
</class>

讀起來應該很順了:指定類別、指定要映射的屬性,然後為每個屬性指出該看哪個 XML 元素、取的是屬性值。

把元素映射到集合

還缺一塊:上面並沒有說明 Author 類該對應到哪個 XML 元素。Castor 不會替你猜,既然用了映射檔案,就把話說清楚。

如果每本書只有一位作者,Book 裡放一個 Author 屬性即可,映射寫成 <field name="Author" type="ibm.XML.castor.Author"> 搭配 <bind-xml name="author" /> 就足夠。但 Book 類裡實際上是一個 authors 清單,要裝多個 Author 實例,因此得告訴 Castor 兩件事:每個 author 元素產生一個 Author 實例,然後把這些實例收攏進 Book 的 Authors 屬性。

第一步,用 field 元素(因為確實要映射 Book 的欄位),name 填 Authors:

<field name="Authors">
</field>

第二步,指定型別。這裡容易誤判——要填的不是集合型別,而是集合中每個成員的型別,也就是 ibm.XML.castor.Author。Castor 會造出這些實例並放進 Authors 屬性裡。

<field name="Authors" type="ibm.XML.castor.Author">
</field>

第三步是關鍵:加上 collection 屬性,宣告這是一個集合。Castor 目前支援兩個值——vector(清單型,透過標準 Java 集合 API 存取)與 array(陣列型,用索引存取,例如 ar[2])。本例的 Java 端是 List,所以選 vector。

<field name="Authors" type="ibm.XML.castor.Author" collection="vector">
</field>

有了 collection,Castor 就知道要依 type 指定的型別來組出這個集合:Authors 屬性會是若干 ibm.XML.castor.Author 實例組成的清單。

最後一步,用 bind-xml 指定這些實例的來源節點:

<field name="Authors" type="ibm.XML.castor.Author" collection="vector">
    <bind-xml name="author" />
</field>

完整的映射檔案

清單 7. 完成版映射檔案

<?XML version="1.0"?>
<!DOCTYPE mapping PUBLIC "-//EXOLAB/Castor Mapping DTD Version 1.0//EN"
    "https://castor.org/mapping.dtd">

<mapping>
    <class name="ibm.XML.castor.Book">
        <map-to XML="book" />

        <field name="Title" type="java.lang.String">
            <bind-xml name="title" node="element" location="book-info" />
        </field>

        <field name="Isbn" type="java.lang.String">
            <bind-xml name="isbn" node="element" location="book-info" />
        </field>

        <field name="Authors" type="ibm.XML.castor.Author" collection="vector">
            <bind-xml name="author" />
        </field>
    </class>

    <class name="ibm.XML.castor.Author">
        <field name="FirstName" type="java.lang.String">
            <bind-xml name="first" node="attribute" location="name" />
        </field>

        <field name="LastName" type="java.lang.String">
            <bind-xml name="last" node="attribute" location="name" />
        </field>
    </class>
</mapping>

在程式中載入映射檔案

剩下的事是在解組過程中把這份檔案掛上去。前面我們用靜態呼叫 Unmarshaller.unmarshal() 完成轉換;現在需要建立 Unmarshaller 實例並設定選項。

清單 8. 使用映射檔案進行解組

package ibm.XML.castor;

import java.io.FileReader;
import java.util.Iterator;
import java.util.List;

import org.exolab.castor.mapping.Mapping;
import org.exolab.castor.xml.Unmarshaller;

public class BookMapUnmarshaller {

    public static void main(String[] args) {
        Mapping mapping = new Mapping();
        try {
            mapping.loadMapping("book-mapping.xml");

            FileReader reader = new FileReader("book.xml");

            Unmarshaller unmarshaller = new Unmarshaller(Book.class);
            unmarshaller.setMapping(mapping);

            Book book = (Book) unmarshaller.unmarshal(reader);

            System.out.println("Book ISBN: " + book.getIsbn());
            System.out.println("Book Title: " + book.getTitle());

            List authors = book.getAuthors();
            for (Iterator i = authors.iterator(); i.hasNext(); ) {
                Author author = (Author) i.next();
                System.out.println("Author: " + author.getFirstName()
                        + " " + author.getLastName());
            }
        } catch (Exception e) {
            System.err.println(e.getMessage());
            e.printStackTrace(System.err);
        }
    }
}

和前面幾篇的解組程式相比,改動其實很小。首先建立 Unmarshaller 實例並傳入 Book.class,這告訴解組器頂層類別是哪一個——它對應到映射檔案裡帶有 map-to 的那個 class 定義。接著呼叫 setMapping() 掛上映射,最後改為呼叫 unmarshal() 的實例版本。

就這麼多。當作練習,你可以照著前一篇的 BookMarshaller 類,加上映射設定,把編組方向也跑通,讓資料在 XML 與 Java 之間往返一趟,確認雙向結果都符合預期。

結語

資料綁定關心的始終是資料本身,而不是承載資料的格式。對 Java 工程師來說,操作 Java 物件是日常;資料綁定的價值在於讓來自各種來源(尤其是 XML)的資料也能同樣輕鬆地變成物件。映射機制在此之上再往前一步:填裝物件時,你對來源格式有了近乎完全的掌控權。喜歡資料綁定的人,大概也會喜歡映射——它讓你能馴服那些命名習慣不合、結構也不對味的 XML 文件。

對負責資料與 XML 那一側的人,好處同樣明顯:不必為了呼叫 Java 方法而扭曲 XML 的命名,也不必因為多個元素對應同一個類而額外搭一層中間物件。核心價值就兩個字——彈性,讓你能對資料做想做的事,而不被框架或工具 conventions 綁死。

下一篇

到目前為止,我們看到的還只是 Castor 在 XML 場景下的一小部分能力。下一篇要把同樣的簡單 XML 綁定擴展到 SQL:把資料從 Java 類搬進關聯式資料庫、再搬回來,全程不寫一行 JDBC。建議先複習一下 XML 與 SQL 的基礎,下個月我們繼續往資料綁定的深處走。

學完系列最後一篇,你就能用同一套 API 在 XML、Java 與 SQL 之間轉換,彈性比單靠映射檔案又更大一層:面對資料庫、Java 物件與 XML 文件,用的是單一 API 與相似的呼叫方式。熟悉 C# 的讀者可能會覺得這 conceptually 很像 LINQ——相似的能力在 Java 這邊早有實現,而且 API 相當穩定。繼續玩 Castor 吧,看看你能綁出什麼東西來。

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