XML 正快速成為資料儲存與交換的標準格式。市面上完整的 Java XML 解析器功能強大,但強大的功能往往伴隨可觀的資源消耗。
因此,在許多情境下使用功能完整的解析器顯得過於浪費。如果你的執行環境是 Java Applet 或 J2ME 應用程式,網路頻寬或系統記憶體的限制,可能讓你根本無法載入完整的 XML 解析器。本文示範如何打造一個輕量級的 XML DOM 解析器。
SimpleDOMParser 是一個以 Java 撰寫、高度精簡的超輕量級 XML DOM 解析器。整個解析器可以打包成一個小於 4KB 的 jar 檔,原始碼不到 400 行。
代價很清楚:它不支援 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 文件所產生的節點組成,節點是 XML 實體在記憶體中的表示。標準 W3C DOM 定義了多種節點類型:文字節點表示文件中的一段文字,元素節點表示一個 XML 元素,屬性節點則表示元素內部的屬性名稱與值。
DOM 之所以是「樹」,是因為除了根節點(文件節點)以外的每個節點都有一個父節點。屬性節點總是與某個元素節點關聯,而元素起始標記與結束標記之間的文字則對應到一個文字節點,作為該元素節點的子節點。所以即使是極簡單的 XML 文件,表示起來也可能需要多種節點類型。
例如這份文件:
<parser>SimpleDOMParser</parser>
在標準 W3C DOM 中,它會被表示成一棵用到 document、element、text 三種節點的樹。
SimpleDOMParser 的做法是:把所有 DOM 節點類型抽象成單一類型 SimpleElement,盡可能簡化模型。一個 SimpleElement 只保留 XML 元素的關鍵資訊——標記名稱、元素屬性,以及被它包裹的文字或 XML。此外,它不使用任何特殊節點類型來表示最高層級的文件。結果是 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()——回傳輸入串流中的下一個字元,但實際上不把它從串流中取走。透過保持輸入流的完整性,readTag 與 readText 這類高階函式就能依「接下來預期遇到的字元」來判斷該取什麼內容。
private int peek() throws IOException {
reader.mark(1);
int result = reader.read();
reader.reset();
return result;
}
skipWhitespace()——跳過輸入串流中的空白、定位字元與換行符號。
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()——讀取 XML 標記之間的文字,同時要能辨識 CDATA 區塊。
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() 只是一個對兩個整數陣列做深度比較的小工具函式。
有了 peek、skipWhitespace、readTag、readText 這四塊積木,剩下的工作就是把它們組合成一個遞迴下降的解析迴圈:遇到起始標記就建立 SimpleElement 並往下遞迴,遇到結束標記就回到上層,遇到文字就存進當前元素的 text 屬性——一棵輕量級的 DOM 樹於焉成形。