本文示例源代碼或素材下載
文檔對象模型(Document Object Model,DOM)是公認的 W3C 標準,用於以平台與語言無關的方式動態訪問和更新 XML 文檔的內容、結構與樣式。它為表示文檔定義了一套標準接口,也為訪問和操縱文檔定義了標準方法。DOM 獲得廣泛支持,並以 Java、Perl、C、C++、VB、Tcl、Python 等多種語言實現。
正如本文將演示的,當基於流的模型(例如 SAX)無法滿足需求時,DOM 是極佳的選擇。然而,規範的某些設計——語言無關的接口,以及「一切都是節點」的抽象——讓它不易使用、容易寫出脆弱的代碼。這一點在對多個大型 DOM 項目的研究中尤其明顯。以下將討論常見問題與其補救之道。
DOM 規範被設計成可與任何編程語言搭配,因此它採用一套在所有語言都通用的核心功能,並在接口定義上保持語言無關。這讓 Java 開發者的 DOM 知識得以在 Visual Basic 或 Perl 中沿用,反之亦然。
該規範把文檔的每個部分都看作由型別與值組成的節點,為處理文檔各個層面提供了完美的概念框架。例如 XML 片段「the Italicized portion.」會以下面的 DOM 結構表示:
圖 1:XML 文檔的 DOM 表示

樹中的每個 Document、Element、Text 與 Attr 都是 DOM Node。
完美的抽象也付出了代價。以 XML 片段「Value」為例,您可能以為文字值可用普通的 Java String 表示,透過簡單的 getValue 呼叫取得。實際上,文字被當成 tagname 節點下的一個或多個子節點,因此要取得文字值,就必須遍歷 tagname 的子節點並把每個值拼成字串。這樣做有其道理:tagname 可能包含其他嵌入元素,此時取文字值意義不大;但在實務中,缺乏便利函數導致的頻繁編碼錯誤,占了約八成的比例。
DOM 語言無關性的缺點,是無法使用各語言慣用的一整套工作方法與模式。例如不能用熟悉的 Java new 來建立新 Element,必須改用工廠構造器方法;節點集合被表示為 NodeList,而非慣用的 List 或 Iterator。這些瑣碎的不便,造成非典型的編碼實踐、更多的程式碼行數,也迫使開發者去學習 DOM 的做事方式而非憑直覺操作。
DOM 採用「一切都是節點」的抽象,意味著幾乎每個部分(Document、Element、Attr)都繼承自 Node 接口。這不僅概念上完美,也讓各種 DOM 實現能透過標準接口暴露自身的類別,而不必因中間包裝類別而損失效能。但由於節點類型繁多、訪問方法缺乏一致性,這種抽象的意義被削弱了:例如設定 CharacterData 節點用 insertData,設定 Attr 節點卻用 setValue。不同節點走不同接口,降低了模型的一致性、增加了學習曲線。
JDOM 是一項讓 DOM API 適配 Java 的研究計劃,提供更自然、易用的接口。它體認到語言無關 DOM 構造的棘手本質,改用內嵌的 Java 表示與物件,並為常見任務提供便利函數。JDOM 直接解決了「一切都是節點」與 NodeList 等 DOM 特有構造:把不同節點類型定義為不同 Java 類別,可用 new 建立、避免頻繁型別轉換,字串用 Java String、集合用 List 與 Iterator 表示。
JDOM 已被接受為正式的 JSR,未來很可能納入核心 Java 平台。但因它尚未成為核心 API,一些人仍有所顧慮,也有關於 Iterator 與頻繁建立物件所帶來效能問題的報告。如果您能接受 JDOM、且没有把 Java 代碼與人員轉移到其他語言的需求,它是值得探索的好選擇;但在本文探討的專案所在的公司仍選用了普遍的 DOM,本文亦然。
對多個大型 XML 專案的分析,揭示了使用 DOM 的一些常見問題,以下逐一說明。
我們檢視的所有專案都出現一個突出問題:花了大量程式碼行去做簡單的事。某例中,檢查一個屬性的值用了 16 行,而加上更完善的健壯性與錯誤處理,其實 3 行就能完成。DOM API 的低階本質、方法與模式的不當使用,以及對完整 API 缺乏了解,都會讓程式碼行數暴增。
最常見的任務是遍歷或搜尋 DOM。清單 1 展示了在 config 節中尋找名為「header」節點的精簡版代碼:
清單 1 從根開始,取得頂端元素、其第一個子節點(configNode),再逐一檢查 configNode 的子節點。這種做法不僅冗長,還伴隨脆弱性與潛在錯誤。例如以 getFirstChild 取得中間的 config 節點時,根節點的第一個子節點未必是您要找的節點;當根節點後帶有空格或換行時,第一個子節點其實是 TEXT_NODE,而非期望的元素節點,程式碼便會異常終止。要正確導航,就必須逐一檢查每個子節點、核對名稱,並在每一步確認方法呼叫回傳有效值。此外,若 root 沒有子節點,configNode 會是 null,第三行便會出錯。事實上,若原始開發者了解,清單 1 的所有功能都能用一次 getElementsByTagName 呼叫達成。
第二項最常見的任務,是取得元素內含的文字值。考量 XML 片段「The Value」,若已導航到 sometag 節點,直觀的寫法可能是:
sometagElement.getData();
如你所料,這不會產生期望結果。由於文字被存為一個或多個子節點,不能對元素直接呼叫 getData。更好的嘗試是:
sometag.getFirstChild().getData();
但值未必在第一個子節點中;sometag 內可能有處理指令或其他嵌入節點,或文字分散在多個子節點。由於空格常以文字節點表示,getFirstChild() 可能只取到標記與值之間的換行。實際上,您需要遍歷所有子節點、核對 TEXT_NODE 類型並拼接其值。JDOM 已用便利的 getText 解決此問題,DOM 級別 3 也規劃了 getTextContent。教訓是:盡可能使用較高階的 API。
DOM 級別 2 提供依名稱查找子節點的方法,例如:
NodeList names = someElement.getElementsByTagName("name");
它會回傳 someElement 中所有名為 name 的節點,比手動遍歷方便許多,卻也是常見錯誤來源。問題在於 getElementsByTagName 會遞歸遍歷,回傳所有符合的節點。若一個文檔同時含客戶、公司與產品資訊,三者都可能有 name 標記,那麼搜尋客戶名稱時,程式很可能連產品與公司名稱一起取回。在子樹上呼叫可降低風險,但由於 XML 的彈性,要確保子樹結構符合預期、且沒有同名的假性子節點,本身就相當困難。
考量 DOM 設計所強加的限制,如何有效又高效地使用它?以下是幾條基本原則與方針:
這些原則直接源自對常見問題的研究。DOM 遍歷是出錯主因,卻也是最常被需要的功能——那要如何不用 DOM 來遍歷?答案是 XPath。
XPath 是尋址、搜尋與匹配文檔各部分的語言,是 W3C 推薦標準,並在多數語言與 XML 套件中實現。您的 DOM 套件可能直接或透過附加元件支援 XPath;本文示例使用 Xalan 套件。XPath 使用類似檔案系統與 URL 的路徑標記法,例如 /x/y/z 會搜尋根節點 x 下的 y 下的 z,並回傳所有符合該路徑結構的節點。
更複雜的匹配可同時考量結構與節點及屬性的值:/x/y/* 回傳父節點為 x 的 y 下的任何節點;/x/y[@name='a'] 匹配父節點為 x、屬性 name 值為 a 的所有 y 節點。值得注意的是,XPath 會自動篩掉空白文字節點,只回傳元素節點。深入探討 XPath 超出本文範圍,建議花點時間學習,您處理 XML 會更得心應手。
研究 DOM 專案時令我們驚訝的一點,是拷貝貼上代碼的數量。為什麼有經驗的開發者不建立 helper 庫,反而一再複製貼上?我們認為這是 DOM 的複雜度加深了學習難度,讓開發者只求先弄出能跑的第一段代碼,而歸納出可重用函數所需的專業判斷得花大量時間。以下幾個基本 helper 函數可幫您快速起步。
使用 XML 時最常做的,是查找給定節點的值。用 XPath 簡化遍歷、再把取值邏輯封裝一次即可重用。在兩個低階函數的幫助下——Xalan 提供的 XPathAPI.selectSingleNode(查找並回傳第一個符合 XPath 的節點),以及 getTextContents(非遞歸地回傳節點內連續的文字值)——我們實作了 getValue。您也可用 JDOM 的 getText,或 DOM 級別 3 規劃的 getTextContent 取代 getTextContents。呼叫 findValue 時,傳入起始節點與指定搜尋範圍的 XPath,函數便會找出第一個符合的節點並抽取其文字值。
另一常見操作是把節點值設為指定值。該函數接收起始節點、一條 XPath,以及要設定的字串;它找出目標節點,移除其所有子節點(連同其中的文字與元素),再把文字內容設為傳入的字串。
有些程式只查找與修改值,另一些則透過新增、移除節點來改變文檔結構。這個 helper 簡化了節點的新增:傳入要掛載的父節點、新節點名稱,以及用來定位父節點的 XPath,新節點便會被加到文檔的指定位置。
DOM 的語言無關設計帶來廣泛的可用性,使其在多樣系統與平台上都能實現;代價是它比為單一語言量身打造的 API 更難用、更不直觀。但 DOM 奠定了極有效的基礎,只要遵循幾條簡單原則,就能在其上打造易用的系統。凝聚廣大使用者智慧與經驗的 DOM 未來版本正在設計中,很可能為本文探討的問題提供解答;而像 JDOM 這樣的專案正修改 API 以貼近自然的 Java 風格。善用這些專案並遵循上述用法模式,就能讓 DOM 成為 XML 專案的優秀平台,讓 XML 操作更便利、更簡潔、更不易出錯。