XML 正迅速成為資料存儲與交換的標準格式。市面上現成的完整 Java XML 解析器雖然功能強大,但強大的背後往往伴隨等量甚至更多的資源消耗。舉例來說,流行的 Apache Xerces-J 解析器超過 1.7 MB,而最新的完整 Sun JAXP(Java 應用程式介面,用於 XML 處理)實作套件更是超過 3MB。因此,在某些情境下採用功能完整的解析器反而顯得過於浪費。如果執行環境是 Java 小程式(applet)或 J2ME 應用程式,受限於網路頻寬或系統記憶體,甚至可能根本無法使用完整的 XML 解析器。本文將說明如何打造一個輕量級的 XML DOM 解析器。
SimpleDOMParser 是一個以 Java 撰寫、高度精簡的超輕量級 XML DOM 解析器。你可以把整個解析器打包成一個小於 4KB 的 .jar 檔,原始碼還不到 400 行。
顧名思義,以這麼小的程式碼量,SimpleDOMParser 並不支援 XML 名稱空間,無法理解多字符集編碼,也不具備以 DTD 或 schema 進行驗證的能力;但它勝在能把符合語法規則的 XML 標記解析成一棵類似 DOM 的元素樹,讓你執行從 XML 格式化文字中提取資料的常見任務。
那麼,為何選擇 DOM 作為模型,而非 SAX 呢?主要是因為 DOM 提供了比 SAX 更易用的程式介面。與 SAX 不同,當你把一份 XML 文件當作 DOM 樹來處理時,文件內的所有資訊都能隨取隨用。雖然 SAX 在效能與記憶體佔用上通常更優,但多數開發者在實作 SAX 時,往往會發現自己其實正在建立一棵完整或部分的 DOM 樹。使用 SAX 時,應用程式每次只能處理一條標記,若其他標記的內容在處理過程中也需要用到,就必須全程維護某種全域狀態——而維護全域狀態,恰恰是 DOM 模型的核心精神所在。當然,許多小型 XML 應用並不需要完整的 DOM 模型,因此 SimpleDOMParser 只提供對標記名稱、層次與內容的存取,而不牽涉完整 W3C DOM 中大量用不上的功能。
DOM 樹由解析 XML 文件所產生的節點組成。標準的 W3C DOM 模型定義了多種類型的節點,例如:文字節點表示文件中的一段文字,元素節點表示一個 XML 元素,屬性節點則表示元素內部的屬性名與值。
DOM 之所以是一棵樹,是因為除了根(文件)節點以外,每個節點都有一個父節點。舉例來說,屬性節點總是與某個元素節點相關聯,而元素起始標記與結束標記之間的文字則對應到一個文字節點,且該文字節點是元素節點的子節點。因此,即使是簡單的 XML 文件,其表示也可能需要多種節點類型。
DOM 模型使用一個 document 型別節點來封裝整份 XML 文件,因此標準 DOM 通常會用到多種節點。SimpleDOMParser 則把所有的節點型別抽象成單一型別 SimpleElement,盡可能簡化模型。一個 SimpleElement 保存一個 XML 元素的關鍵資訊,例如標識名、元素屬性,以及所封裝的文字或 XML。此外,SimpleDOMParser 不使用任何特殊節點來表示最高層級的文件,於是 DOM 樹被大幅簡化為只包含 SimpleElement 節點。
下面給出 SimpleElement 類別的完整原始碼:
public class SimpleElement {
private String tagName;
private String text;
private HashMap attributes;
private LinkedList childElements;
public SimpleElement(String tagName) {
this.tagName = tagName;
attributes = new HashMap();
childElements = new LinkedList();
}
public String getTagName() { return tagName; }
public void setTagName(String tagName) { this.tagName = tagName; }
public String getText() { return text; }
public void setText(String text) { this.text = text; }
public String getAttribute(String name) { return (String)attributes.get(name); }
public void setAttribute(String name, String value) { attributes.put(name, value); }
public void addChildElement(SimpleElement element) { childElements.add(element); }
public Object[] getChildElements() { return childElements.toArray(); }
}
為了把 XML 文件處理成前述的簡化 DOM 樹,我們必須先定義幾個基本的解析規則,讓解析器能輕易地從輸入的 XML 檔中提取標記或文字塊。
第一個是 peek,它回傳輸入 XML 檔案中的下一個字符,但實際上並不真正從底層串流中取走該字符。透過維持輸入串流的完整性,諸如 readTag 與 readText 這類高階函式便能更輕鬆地依據接下來預期的字符取得所需內容。
private int peek() throws IOException {
reader.mark(1);
int result = reader.read();
reader.reset();
return result;
}
下一個方法是 skipWhitespace,用來跳過輸入 XML 串流中的空格、定位符或換行符。
private void skipWhitespace() throws IOException {
while (Character.isWhitespace((char) peek())) {
reader.read();
}
}
有了這兩個方法後,我們就能撰寫一個從輸入檔中讀取 XML 標記的函式。
private String readTag() throws IOException {
skipWhitespace();
StringBuffer sb = new StringBuffer();
int next = peek();
if (next != '<') {
throw new IOException("Expected < but got " + (char) next);
}
sb.append((char)reader.read());
while (peek() != '>') {
sb.append((char)reader.read());
}
sb.append((char)reader.read());
return sb.toString();
}
與 peek 搭配使用時,readTag 只取得單一標記的內容,把其他部分留給別的函式處理。最後一個是 readText,用來讀取標記之間的文字。
private String readText() throws IOException {
int[] cdata_start = {'<', '!', '[', 'C', 'D', 'A', 'T', 'A', '['};
int[] cdata_end = {']', ']', '>'};
StringBuffer sb = new StringBuffer();
int[] next = new int[cdata_start.length];
peek(next);
if (compareIntArrays(next, cdata_start) == true) {
// CDATA
reader.skip(next.length);
int[] buffer = new int[cdata_end.length];
while (true) {
peek(buffer);
if (compareIntArrays(buffer, cdata_end) == true) {
reader.skip(buffer.length);
break;
} else {
sb.append((char)reader.read());
}
}
} else {
while (peek() != '<') {
sb.append((char)reader.read());
}
}
return sb.toString();
}
這裡使用的是前面 peek 方法的變體,可回傳一段字符序列,讓解析器判斷即將處理的文字是否被裝進 CDATA 區塊中。compareIntArrays 則是一個對兩個整數陣列進行深度比較的小工具。
與一般的純文字文件不同,語法完整的 XML 文件有幾個能促進解析工作的特點:
在一份 XML 文件中,所有標記都必須成對匹配。每個起始標記都要有對應的結束標記,除非標記本身即是起始與結束的合併寫法,例如 <parser/> 就等同於 <parser></parser>。標記與屬性名稱則區分大小寫。
在一份 XML 文件中,所有標記都必須正確嵌套,不得交叉嵌套。例如,包含 <t1><t2>...</t1></t2> 的文件就是錯誤的,因為結束標記 </t1> 出現在了 </t2> 之前。
依據這些規則,SimpleDOMParser 的解析策略可歸納為以下模式:遍歷輸入文件時,取出下一個標記,與堆疊頂端(最後一個起始標記)比對。若為起始標記,則將它作為目前元素的子元素加入,再壓入堆疊;若為結束標記,則檢查它是否與堆疊頂端的起始標記匹配,若匹配就彈出堆疊,若堆疊見底則解析完成,若不匹配則回報錯誤。
這套演算法的關鍵在於「標記堆疊」,它能保存那些已讀取但尚未找到對應結束標記的起始標記,堆疊頂端永遠是最近一次的起始標記。每個新的起始標記都會成為上一個起始標記的子節點:解析器先把新標記掛到目前元素之下,再將它壓入堆疊成為新的「目前元素」。反之,若讀到結束標記,它就必須與堆疊頂端的起始標記匹配;依據正確嵌套規則,不匹配的結束標記即代表 XML 語法錯誤。當結束標記成功匹配,解析器便彈出堆疊頂端的起始標記,因為該標記的解析已告完成。這個過程持續進行,直到堆疊為空,整份文件的解析便告完成。以下提供 SimpleDOMParser.parse 方法的完整原始碼,供讀者深入研究其屬性解析、CDATA 處理與堆疊操作等細節。