要在 XPath 運算式中使用名稱空間,就必須提供「前綴到 URI」的對應關係。若缺少這個對應,XPath 只會靜靜地回傳空結果,不丟任何錯誤——這是最容易讓人耗上半天的地方。本文說明三種提供對應的方式,並附上可直接使用的程式碼。
以下所有範例都基於同一份 XML:
<?xml version="1.0" encoding="UTF-8"?>
<books:booklist xmlns:books="https://univNaSpResolver/booklist"
xmlns="https://univNaSpResolver/book"
xmlns:fiction="https://univNaSpResolver/fictionbook">
<science:book xmlns:science="https://univNaSpResolver/sciencebook">
<title>Learning XPath</title>
<author>Michael Schmidt</author>
</science:book>
<fiction:book>
<title>Faust I</title>
<author>Johann Wolfgang von Goethe</author>
</fiction:book>
<fiction:book>
<title>Faust II</title>
<author>Johann Wolfgang von Goethe</author>
</fiction:book>
</books:booklist>
這份文件有兩個刻意安排的細節。第一,三個名稱空間在根元素上宣告,第四個(science)則宣告在較深層的元素上——這正好用來示範「查找範圍」帶來的差異。第二,booklist 底下有三個都叫 book 的子元素,但第一個屬於 science 名稱空間,其餘兩個屬於 fiction。在 XPath 眼中,它們是完全不同的元素。
名稱空間是元素或屬性識別碼的一部分。兩個元素可以有相同的本地名稱,只要名稱空間不同,它們就是不同的東西——science:book 與 fiction:book 正是如此。當你需要合併來自不同來源的 XML 時,名稱空間就是用來避免命名衝突的機制。XSLT 檔案是最典型的例子:它同時包含 XSLT 名稱空間的元素、你自己名稱空間的元素,以及 XHTML 名稱空間的元素。
名稱空間由 URI 定義。為了避免每次寫出那一長串網址,我們為 URI 定義一個前綴。請記住:前綴就像變數名稱,本身不具意義。兩個不同的前綴只要指向同一個 URI,加上它們的元素就屬於同一個名稱空間。
XPath 運算式使用前綴(例如 books:booklist/science:book),而你必须為每個前綴提供對應的 URI。這正是 NamespaceContext 的工作。
最直接的做法是自己實作介面,把對應寫死在程式碼裡:
public class HardcodedNamespaceResolver implements NamespaceContext {
public String getNamespaceURI(String prefix) {
if (prefix == null) {
throw new IllegalArgumentException("No prefix provided!");
} else if (prefix.equals(XMLConstants.DEFAULT_NS_PREFIX)) {
return "https://univNaSpResolver/book";
} else if (prefix.equals("books")) {
return "https://univNaSpResolver/booklist";
} else if (prefix.equals("fiction")) {
return "https://univNaSpResolver/fictionbook";
} else if (prefix.equals("technical")) {
return "https://univNaSpResolver/sciencebook";
} else {
return XMLConstants.NULL_NS_URI;
}
}
public String getPrefix(String namespaceURI) { return null; }
public Iterator getPrefixes(String namespaceURI) { return null; }
}
注意我把 sciencebook 綁到了 technical 這個前綴,而不是文件裡的 science。這不是筆誤,而是為了說明一個重點:前綴名稱不重要,URI 相同就找得到節點。
private static void example1(Document example)
throws XPathExpressionException, TransformerException {
XPath xPath = XPathFactory.newInstance().newXPath();
xPath.setNamespaceContext(new HardcodedNamespaceResolver());
NodeList result1 = (NodeList) xPath.evaluate(
"books:booklist/technical:book", example, XPathConstants.NODESET);
// 找到 1 個節點
NodeList result2 = (NodeList) xPath.evaluate(
"books:booklist/fiction:book", example, XPathConstants.NODESET);
// 找到 2 個節點
String result = xPath.evaluate(
"books:booklist/technical:book/:author", example);
// Michael Schmidt
}
好處是你可以隨心所欲重新命名前綴,不必受 XML 檔內容拘束。缺點也很明顯:名稱空間變成要在 XML、XSD、XPath 運算式與這個 resolver 四個地方同步維護,任何一處改了忘了另一處,就會出現找不到節點的狀況。
名稱空間與前綴都存在 XML 檔裡,那就讓 DOM 自己去查:
public class UniversalNamespaceResolver implements NamespaceContext {
private Document sourceDocument;
public UniversalNamespaceResolver(Document document) {
sourceDocument = document;
}
public String getNamespaceURI(String prefix) {
if (prefix.equals(XMLConstants.DEFAULT_NS_PREFIX)) {
return sourceDocument.lookupNamespaceURI(null);
} else {
return sourceDocument.lookupNamespaceURI(prefix);
}
}
public String getPrefix(String namespaceURI) {
return sourceDocument.lookupPrefix(namespaceURI);
}
public Iterator getPrefixes(String namespaceURI) { return null; }
}
使用方式:
XPath xPath = XPathFactory.newInstance().newXPath();
xPath.setNamespaceContext(new UniversalNamespaceResolver(example));
NodeList result1 = (NodeList) xPath.evaluate(
"books:booklist/science:book", example, XPathConstants.NODESET);
// 找不到!拋出 XPathExpressionException
有三點必須注意。第一,若文件在使用 XPath 之前被修改過,這些修改會反映在查找結果上,因為委派是在需要時才發生,讀的是文件的當前狀態。第二,查找是沿著傳入節點的祖先節點進行的——我們傳入的是整個文件,所以只有根元素上宣告的名稱空間找得到。文件裡的 science 是在較深層宣告的,因此解析失敗。第三,查找發生在 XPath 求值過程中,會消耗額外的時間。
要解決 science 的問題,得先從文件裡取出 science:book 節點,把它當成委派對象——但這意味著額外的解析,而且並不優雅。
比較好的做法是提前把名稱空間讀出來放進 Map,之後每次查詢都從快取回應。這樣文件後續的變動就不重要了,因為清單在建構物件時就已固定。
public class UniversalNamespaceCache implements NamespaceContext {
private static final String DEFAULT_NS = "DEFAULT";
private Map<String, String> prefix2Uri = new HashMap<String, String>();
private Map<String, String> uri2Prefix = new HashMap<String, String>();
/**
* 解析文件並存下所有能找到的名稱空間。
*
* @param document 來源文件
* @param toplevelOnly 為 true 時只讀根元素,可提升效能
*/
public UniversalNamespaceCache(Document document, boolean toplevelOnly) {
examineNode(document.getFirstChild(), toplevelOnly);
}
/** 讀取單一節點,抽出並儲存名稱空間屬性 */
private void examineNode(Node node, boolean attributesOnly) {
NamedNodeMap attributes = node.getAttributes();
for (int i = 0; i < attributes.getLength(); i++) {
storeAttribute((Attr) attributes.item(i));
}
if (!attributesOnly) {
NodeList children = node.getChildNodes();
for (int i = 0; i < children.getLength(); i++) {
Node child = children.item(i);
if (child.getNodeType() == Node.ELEMENT_NODE)
examineNode(child, false);
}
}
}
/** 若是 xmlns 相關屬性就存起來 */
private void storeAttribute(Attr attribute) {
if (attribute.getNamespaceURI() != null
&& attribute.getNamespaceURI()
.equals(XMLConstants.XMLNS_ATTRIBUTE_NS_URI)) {
// 預設名稱空間:xmlns="uri"
if (attribute.getNodeName().equals(XMLConstants.XMLNS_ATTRIBUTE)) {
putInCache(DEFAULT_NS, attribute.getNodeValue());
} else {
// 有前綴的宣告
putInCache(attribute.getLocalName(), attribute.getNodeValue());
}
}
}
private void putInCache(String prefix, String uri) {
prefix2Uri.put(prefix, uri);
uri2Prefix.put(uri, prefix);
}
/** XPath 會呼叫這個方法 */
public String getNamespaceURI(String prefix) {
if (prefix == null
|| prefix.equals(XMLConstants.DEFAULT_NS_PREFIX)) {
return prefix2Uri.get(DEFAULT_NS);
} else {
return prefix2Uri.get(prefix);
}
}
public String getPrefix(String namespaceURI) {
return uri2Prefix.get(namespaceURI);
}
public Iterator getPrefixes(String namespaceURI) { return null; }
}
把 toplevelOnly 設為 true,建構式只檢查根元素的屬性,速度最快:
xPath.setNamespaceContext(new UniversalNamespaceCache(example, true));
xPath.evaluate("books:booklist/science:book", example, XPathConstants.NODESET);
// 失敗:快取裡沒有 science
xPath.evaluate("books:booklist/fiction:book", example, XPathConstants.NODESET);
// 成功:找到 2 個節點
輸出會列出快取內容,可以清楚看到只有 DEFAULT、fiction、books 三項:
prefix DEFAULT: uri https://univNaSpResolver/book prefix fiction: uri https://univNaSpResolver/fictionbook prefix books : uri https://univNaSpResolver/booklist
這裡有個 DOM 的細節容易讓人困惑:DOM 中的第一個節點代表整個文件,而該文件節點本身沒有屬性。所以要讓 book 這些元素的名稱空間被讀到,examineNode 必須往下走一層。程式碼裡 document.getFirstChild() 就是在做這件事。
把 toplevelOnly 設為 false,就會遞迴檢查整個文件,這時候 science 也能解析:
xPath.setNamespaceContext(new UniversalNamespaceCache(example, false));
xPath.evaluate("books:booklist/science:book", example, XPathConstants.NODESET);
// 成功:找到 1 個節點
xPath.evaluate("books:booklist/fiction:book", example, XPathConstants.NODESET);
// 成功:找到 2 個節點
有一個潛在陷阱要留意:若同一個前綴在嵌套元素上被重新宣告為不同的 URI,遞迴過程中「最後找到的那個會勝出」。實務上這通常不成問題,但如果你處理的文件裡前綴會被區域性重複定義,就得改用其他策略。
把這個情況講得更具體一點。若 XML 使用了名稱空間,而你沒有提供 NamespaceContext,XPath 運算式會完全失效:
XPath xPath = XPathFactory.newInstance().newXPath();
// 不帶前綴
NodeList result1 = (NodeList) xPath.evaluate(
"booklist/book", example, XPathConstants.NODESET);
// 結果長度為 0
// 帶前綴
NodeList result2 = (NodeList) xPath.evaluate(
"books:booklist/science:book", example, XPathConstants.NODESET);
// 結果長度為 0
兩種寫法都回傳空集合,而且不拋任何例外。原因就在於缺少前綴到 URI 的對應,XPath 引擎根本不知道你要找的是哪個名稱空間下的元素。這個「沒有錯誤訊息」的特性,正是名稱空間問題特別難查的原因。
總的來說,從文件解析出 NamespaceContext,能讓你的程式碼更少、也更通用。這比在每個 XPath 運算式裡硬寫 URI 要可靠得多。
範例中出現了 books:booklist/fiction:book[1]/:author 這樣的運算式,冒號前面是空的。這是在指定「預設名稱空間下的 author 元素」。由於文件在根元素上宣告了 xmlns="https://univNaSpResolver/book",未加前綴的 title 與 author 都屬於這個預設名稱空間,因此必須用這種語法明確指向它,否則同樣會找不到節點。這一點在實際專案中是常見的 confusion 來源,值得特別記住。