J2EE/XML 開發者多半熟悉 DOM 與 SAX 這兩套 API,但它們各有明顯短板。DOM 的問題是吃記憶體——必須先把整份文件建成完整的記憶體結構,才能開始導航。SAX 的問題則在於它是「推」模型:解析事件由解析器主動產生,應用程式只能被動接收。
StAX 走的是另一條路——「拉」模型。本文會示範如何建立自己的 XML 文件,再用多種方式解析它,最後聚焦在事件導向的 StAX 拉式做法。
相比推式,拉式有幾個實質優勢:
Streaming API for XML(StAX)出自 2004 年 3 月的 JSR 173 規範,是一套針對 XML 的流式拉式解析 API,也是 JDK 6.0 的新特性之一。
推式解析器會不間斷產生事件直到文件解析完畢;拉式解析則由應用程式節制節奏,事件何時產生取決於應用程式何時索取。這意味著你能延後解析、在分析途中跳過元素,甚至同時分析多份文件。相比之下,DOM 一定要把整份文件解析成樹狀結構,效率自然打折。
StAX 的實作隨 Java Web 服務開發套件(JWSDP)1.6 釋出,位於 javax.xml.stream 套件中,核心由 Sun Java 串流 XML 解析器(SJSXP)提供。其中 XMLStreamReader 負責解析,XMLStreamWriter 負責生成;XMLEventReader 則以事件迭代子的方式解析,與 XMLStreamReader 的光標機制形成對照。
順帶一提,StAX 只是 JDK 6.0 XML 新特性之一,同期還包含 JAX-WS 2.0、JAXB 2.0、XML 數位簽章 API,甚至 SQL:2003 的 XML 資料型別支援。
使用 JDK 6.0 時,StAX API 預設已在 CLASSPATH 中。若使用 JWSDP 1.6,需把 <jwsdp-1.6>\sjsxp\lib\jsr173_api.jar 與 <jwsdp-1.6>\sjsxp\lib\sjsxp.jar 加入 CLASSPATH。前者對應 JSR-173 API,後者對應 SJSXP 實作。
先建立待解析的文件。要注意的是,XMLStreamWriter 不保證產出的文件一定格式良好或有效,這部分責任在呼叫端。
import javax.xml.stream.*;
import javax.xml.stream.events.*;
import javax.xml.stream.XMLOutputFactory;
XMLOutputFactory outputFactory = XMLOutputFactory.newInstance();
FileWriter output = new FileWriter(new File("C:/STAX/catalog.xml"));
XMLStreamWriter writer = outputFactory.createXMLStreamWriter(output);
writer.writeStartDocument("UTF-8", "1.0");
writer.writeComment("A OReilly Journal Catalog");
writer.writeProcessingInstruction("catalog", "journal='OReilly'");
writer.writeStartElement("journal", "catalog", "https://OnJava.com/Journal");
writer.writeNamespace("journal", "https://OnJava.com/Journal");
writer.writeNamespace("xsi", "https://www.w3.org/2001/XMLSchema-instance");
writer.writeAttribute("xsi:noNamespaceSchemaLocation", "file://c:/Schemas/catalog.xsd");
writer.writeAttribute("publisher", "OReilly");
writer.writeStartElement("journal", "journal", "https://OnJava.com/Journal");
writer.writeAttribute("date", "July 2003");
writer.writeAttribute("title", "Data Binding");
writer.writeStartElement("journal", "article", "https://OnJava.com/Journal");
writer.writeStartElement("journal", "title", "https://OnJava.com/Journal");
writer.writeCharacters("Data Binding with XMLBeans");
writer.writeEndElement();
writer.writeEndElement();
writer.writeEndElement();
writer.flush();
writer.close();
幾個要點:writeStartDocument 中的編碼參數寫的是「宣告中的編碼」,並非實際檔案編碼;每呼叫一次 writeStartElement 時,前一個元素的 > 括號會被補上;writeEndElement 不必指定元素前綴與命名空間 URI。
XMLStreamReader 以光標方式前進,next() 推進到下一個事件,getEventType() 回傳事件型別:
import javax.xml.stream.*;
import javax.xml.stream.events.*;
import javax.xml.stream.XMLInputFactory;
XMLInputFactory inputFactory = XMLInputFactory.newInstance();
InputStream input = new FileInputStream(new File("C:/STAX/catalog.xml"));
XMLStreamReader reader = inputFactory.createXMLStreamReader(input);
while (reader.hasNext()) {
int event = reader.next();
if (event == XMLStreamConstants.ENTITY_DECLARATION) {
// 可以決定要處理這個事件,或直接跳過
event = reader.next();
}
}
與 SAX 相比,StAX 最大的優勢就在這裡:事件可以跳過。只要不去呼叫 next(),解析就能暫停;反過來,呼叫 next() 就前進一格。next() 回傳的 int 值對應 XMLStreamConstants 中的常數。
不同事件型別搭配不同取值方法:START_DOCUMENT 時用 getEncoding()、getVersion();START_ELEMENT 時用 getPrefix()、getNamespaceURI()、getLocalName()、getAttributesCount(),再用 getAttributePrefix(i)、getAttributeLocalName(i)、getAttributeValue(i) 逐一取屬性;CHARACTERS 或 COMMENT 則用 getText()。
XMLEventReader 以事件物件迭代子的方式工作,每個事件對應一個 XMLEvent 物件。它和 XMLStreamReader 的關鍵差異在於 peek()——你可以「偷看」下一個事件而不真的把它讀出來,據此決定要不要處理。
XMLInputFactory inputFactory = XMLInputFactory.newInstance();
InputStream input = new FileInputStream(new File("C:/STAX/catalog.xml"));
XMLEventReader eventReader = inputFactory.createXMLEventReader(input);
while (eventReader.hasNext()) {
XMLEvent event = eventReader.nextEvent();
if (event.isStartElement()) {
StartElement startElement = event.asStartElement();
Iterator attributes = startElement.getAttributes();
while (attributes.hasNext()) {
Attribute attribute = (Attribute) attributes.next();
// getName() 取屬性名,getValue() 取屬性值
}
}
}
XMLEvent 介面另外提供了 isStartDocument() 這類布林方法,讓型別判斷比比較整數常數更直覺。
總結來說,拉式解析把事件規則的決定權交還給應用程式,而不是交給解析器——這正是 StAX 相對於 DOM 與 SAX 的核心價值。