XML 是依據 Unicode 字元來定義的。在現代電腦的傳輸與儲存過程中,那些 Unicode 字元必須以位元組形式存放,再由解析器解碼。能實現這件事的編碼方案有很多:UTF-8、UTF-16、ISO-8859-1、Cp1252 與 SJIS 等。
一般情況下——但也未必總是如此——你其實並不關心底層編碼。XML 解析器會把寫入 Unicode 字串與字元陣列的文檔完成轉換,程式只需對解碼後的字串操作即可。本文要討論的,正是那些真正需要關注底層編碼的「不常出現」的情況。
最常見的一種,是想為輸出結果保留輸入時的編碼。
另一種情況,是不解析文檔,而是把它當作字串或字元大物件(CLOB)直接存進資料庫。
類似的,有些系統透過 HTTP 傳輸 XML 文檔時,並未完整讀取文檔,卻需要設定 HTTP 的 Content-type 標頭以指定正確編碼。這種情況下,你就必須知道文檔究竟是如何編碼的。
大多數時候,對於自己撰寫的文檔,你自然清楚它的編碼。但如果不是你寫的文檔——只是從別處接收到的文檔(例如來自某個 Atom 摘要)——那麼最好的做法是使用串流式 API,例如 Simple API for XML(SAX)、Streaming API for XML(StAX)、System.Xml.XmlReader 或 Xerces Native Interface(XNI)。此外也可以使用樹狀 API,例如文件物件模型(DOM)。但樹狀 API 需要讀取整個文檔,而判斷編碼往往只需讀取前 100 個位元組(甚至更少)。串流式 API 則能只讀取需要的部分,一旦取得結果便可停止解析,效率自然更高。
目前大多數 SAX 解析器,包括與 Sun 公司 Java™ 軟體開發套件(JDK)6 綁定的那一個,都能用來偵測編碼。這項技術並不難實作,只是不太容易理解,可以簡單歸納為:
下面的程式用一個簡單的範例,輸出命令列中所有指定 URL 的編碼。
清單 1. 使用 SAX 判定文檔編碼
import org.xml.sax.*;
import org.xml.sax.ext.*;
import org.xml.sax.helpers.*;
import java.io.IOException;
public class SAXEncodingDetector extends DefaultHandler {
public static void main(String[] args) throws SAXException, IOException {
XMLReader parser = XMLReaderFactory.createXMLReader();
SAXEncodingDetector handler = new SAXEncodingDetector();
parser.setContentHandler(handler);
for (int i = 0; i < args.length; i++) {
try {
parser.parse(args[i]);
}
catch (SAXException ex) {
System.out.println(handler.encoding);
}
}
}
private String encoding;
private Locator2 locator;
@Override
public void setDocumentLocator(Locator locator) {
if (locator instanceof Locator2) {
this.locator = (Locator2) locator;
}
else {
this.encoding = "unknown";
}
}
@Override
public void startDocument() throws SAXException {
if (locator != null) {
this.encoding = locator.getEncoding();
}
throw new SAXException("Early termination");
}
}
這個方法大約要花費九成時間,甚至可能再多一些。不過,SAX 解析器並不保證支援 Locator 介面,更不用說 Locator2 等其他介面了。如果你確定自己用的是 Xerces,那麼還有第二種做法:使用 XNI。
用 XNI 的方式與 SAX 非常相似(實際上,在 Xerces 中,SAX 解析器只是本機 XNI 解析器之上很薄的一層)。總體來說,這種做法更簡單一些,因為編碼會作為參數直接傳入 startDocument(),你只要把它讀出來即可,如下所示。
清單 2. 使用 XNI 判定文檔編碼
import java.io.IOException;
import org.apache.xerces.parsers.*;
import org.apache.xerces.xni.*;
import org.apache.xerces.xni.parser.*;
public class XNIEncodingDetector extends XMLDocumentParser {
public static void main(String[] args) throws XNIException, IOException {
XNIEncodingDetector parser = new XNIEncodingDetector();
for (int i = 0; i < args.length; i++) {
try {
XMLInputSource document = new XMLInputSource("", args[i], "");
parser.parse(document);
}
catch (XNIException ex) {
System.out.println(parser.encoding);
}
}
}
private String encoding = "unknown";
@Override
public void startDocument(XMLLocator locator, String encoding,
NamespaceContext context, Augmentations augs)
throws XNIException {
this.encoding = encoding;
throw new XNIException("Early termination");
}
}
請注意,由於某些不明原因,這項技術只能使用 org.apache.xerces 中真正的 Xerces 類,而無法使用與 Sun JDK 6 綁定、重新打包於 com.sun.org.apache.xerces.internal 中的那些 Xerces 類。
XNI 還提供了 SAX 所不具備的一項功能。在少數情況下,XML 宣告裡所聲明的編碼並非實際編碼。SAX 只會回報實際編碼,而 XNI 還能透過 XMLDecl() 方法告訴你「宣告的編碼」,如下所示。
清單 3. 使用 XNI 同時取得文檔宣告的編碼與實際的編碼
import java.io.IOException;
import org.apache.xerces.parsers.*;
import org.apache.xerces.xni.*;
import org.apache.xerces.xni.parser.*;
public class AdvancedXNIEncodingDetector extends XMLDocumentParser {
public static void main(String[] args) throws XNIException, IOException {
AdvancedXNIEncodingDetector parser = new AdvancedXNIEncodingDetector();
for (int i = 0; i < args.length; i++) {
try {
XMLInputSource document = new XMLInputSource("", args[i], "");
parser.parse(document);
}
catch (XNIException ex) {
System.out.println("Actual: " + parser.actualEncoding);
System.out.println("Declared: " + parser.declaredEncoding);
}
}
}
private String actualEncoding = "unknown";
private String declaredEncoding = "none";
@Override
public void startDocument(XMLLocator locator, String encoding,
NamespaceContext namespaceContext, Augmentations augs)
throws XNIException {
this.actualEncoding = encoding;
this.declaredEncoding = "none"; // reset
}
@Override
// 若沒有 XML 宣告,此方法不會被呼叫
public void XMLDecl(String version, String encoding,
String standalone, Augmentations augs) throws XNIException {
this.declaredEncoding = encoding;
}
@Override
public void startElement(QName element, XMLAttributes attributes,
Augmentations augs) throws XNIException {
throw new XNIException("Early termination");
}
}
通常情況下,若宣告的編碼與實際的編碼不一致,往往代表伺服器有 bug。最常見的原因,是 HTTP Content-type 標頭指定的編碼與 XML 宣告中的編碼不同。此時若嚴格遵守規範,應以 HTTP 標頭的值為準;但在實務上,很可能 XML 宣告裡的值才是正確的。
一般情況下,你不需要了解輸入文檔的編碼,只要用解析器處理輸入,再以 UTF-8 編碼輸出結果即可。但有些時候確實需要知道輸入編碼,此時 SAX 與 XNI 都能提供快速而有效的方式來解決這個問題。