XPath 在工作中被反覆使用,卻又總在關鍵處卡住——軸名記不清、謂詞位置寫錯、相對與絕對路徑混淆,於是每次都要重新翻文件。這篇文章把 XPath 的知識體系做了一次系統性整理,讓它成為可以隨時回查的單一參考點。
XPath 是 W3C 制訂的標準,主要目的在 XML 1.0 或 XML 1.1 文件的節點樹中定位節點。目前有兩個版本:XPath 1.0 於 1999 年成為 W3C 標準,XPath 2.0 則在 2007 年定案。英文原始規格可查閱 https://www.w3.org/TR/xpath20/。
本質上 XPath 是一種表達式語言,它的回傳值可能是節點、節點集合、原子值,或兩者的混合。XPath 2.0 是 1.0 的超集,支援更豐富的資料型別,同時對 1.0 保持良好向後相容——幾乎所有 1.0 的查詢結果在 2.0 中都不變。此外,XPath 2.0 也是 XSLT 2.0 與 XQuery 1.0 用來查詢定位節點的主要表達式語言,而 XQuery 1.0 則是對 XPath 2.0 的進一步擴充。
入門之前,最好先熟悉 XML 的節點類型(元素、屬性、原子值/文字、處理指令、註解、根節點即文件節點、命名空間),以及節點之間的關係:父(Parent)、子(Children)、兄弟(Sibling)、先輩(Ancestor)、後代(Descendant)。這些觀念是後面所有語法的前提。
為了讓範例有一致的參照,先約定一份名為 messages.XML 的文件,其結構大致如下(含寄件者、日期屬性、附件與命名空間下的書籍清單):
<messages>
<message id="0">
<sender>gkt1980@gmail.com</sender>
<datetime date="2008-12-01" />
<body>
<attachments />
</body>
<books xmlns="https://www.amazon.com/books/schema">
<book><name>...</name><year>2007</year></book>
</books>
</message>
<message id="1">...</message>
</messages>
XPath 路徑的組成規則可以濃縮成三行:
路徑 = 相對路徑 | 絕對路徑
XPath 表達式 = 步進表達式 | 絕對路徑 "/" 步進表達式
步進表達式 = 軸 節點測試 謂詞
三個成分各有分工:
and、or 串接,取邏輯非則用 not()。看一個典型的查詢:
/messages/message//child::node()[@id=0]
拆解如下:/messages/message 是絕對路徑(以 / 開頭);child:: 是軸,表示往子節點方向選;node() 是節點測試,代表任意節點;[@id=0] 是謂詞,只保留具備 id 屬性且值為 0 的節點。
/ 出現在表達式開頭時代表文件根,出現在中間時則是步進之間的分隔符。例如 /messages/message/subject 是絕對路徑,意味著「從文件根開始找」。
若把上下文設在第一個 message 節點(/messages/message[1]),那麼單寫 subject(前面沒有 /)就是相對路徑,意味著「從當前節點開始找」。兩者取得的結果可能天差地遠,關鍵就在上下文。
上下文描述的是表達式的執行環境。同一條路徑,放在根節點的環境與放在某個特定子節點的環境執行,結果可能完全不同。也就是說,XPath 的計算結果取決於它所處的上下文。
././sender 選取當前節點下的 sender 節點集合,等同於直接寫 sender。
../../sender 選取當前節點父節點下的 sender 集合。
//messages 從文件根節點往下取 messages 集合。
/* 與 /messages 的等價性* 代表所有節點,但根元素只有一個,因此 /* 實際上就是根節點,結果與 /messages 相同。
//以 messages 節點為上下文,//sender 會沿著整棵子樹往下找:
/messages//sender :
<sender>gkt1980@gmail.com</sender>
<sender>111@gmail.com</sender>
<sender>333@gmail.com</sender>
/messages/message[1]//sender :
<sender>gkt1980@gmail.com</sender>
<sender>111@gmail.com</sender>
由此可見,// 的語義是「從當前節點開始遞歸下降,逐層走訪所有後代,收集符合條件的節點」。
直接寫 sender 等同 ./sender,選的是當前節點的子元素集合。
實務提醒:執行 XPath 時務必先確認「現在站在哪個節點上」。在 XML DOM 中,selectNodes 與 selectSingleNode 都接受一個 XPath 表達式作為參數,此時表達式的上下文就是呼叫該方法的節點及其所在環境。同一條語法換個呼叫對象,答案就換了。
謂詞就是篩選表達式,作用近似 SQL 的 WHERE 子句。而軸描述的是「往哪個方向走」。以下是全部十二條軸:
| 軸名稱 | 選取的內容 |
|---|---|
ancestor | 當前節點的所有先輩(父、祖父……) |
ancestor-or-self | 所有先輩,加上當前節點本身 |
attribute | 當前節點的所有屬性 |
child | 當前節點的所有子元素(預設軸) |
descendant | 當前節點的所有後代(子、孫……) |
descendant-or-self | 所有後代,加上當前節點本身 |
following | 文件中位於當前節點結束標籤之後的所有節點 |
namespace | 當前節點的所有命名空間節點 |
parent | 當前節點的父節點 |
preceding | 逐層向上,依序選出每個父輩節點之前的所有同級節點 |
preceding-sibling | 當前節點之前的所有同級節點 |
self | 當前節點本身 |
| 運算子/字元 | 說明 |
|---|---|
/ | 路徑運算子。出現在模式開頭時表示從根節點開始選取 |
// | 遞歸下降。出現在開頭時表示從根節點開始遞歸下降 |
. | 當前上下文節點 |
.. | 當前上下文節點的父節點 |
* | 萬用字元,選取所有元素節點(不含文字、註解、處理指令;若需納入請用 node()) |
@ | 屬性名前綴 |
@* | 選取所有屬性,不論名稱 |
: | 命名空間分隔符,隔開前綴與元素名或屬性名 |
( ) | 括號運算子,優先級最高,用於強制運算順序 |
[ ] | 套用篩選模式(謂詞),也用作集合的下標索引運算子 |
| | 兩個節點集合的聯集,例如 //messages/message/to | //messages/message/cc |
- | 減法 |
div | 浮點除法 |
and、or | 邏輯運算 |
mod | 取餘數 |
not() | 邏輯非 |
= / != | 等於 / 不等於 |
<、<=、>、>= | 比較運算子;在 XSLT 等 XML 環境中需寫成 <、> 等轉義形式,而在 XMLDOM 的 scripting 環境中不需轉義 |
| 表達式 | 結果 |
|---|---|
/ | 文件根(Document Root) |
/* | 根元素,也就是 XML 文件唯一的根節點 |
/node() | 根元素下的所有節點,含文字節點、註解節點等 |
/text() | 根節點下的所有文字節點 |
/messages/message | messages 下的所有 message 節點 |
/messages/message[1] | messages 下的第一個 message 節點 |
/messages/message[1]/self::node() | 第一個 message 節點本身(self 軸指向自身) |
/messages/message[1]/node() | 第一個 message 節點下的所有子節點 |
/messages/message[1]/*[last()] | 第一個 message 的最後一個子元素 |
/messages/message[1]/[last()] | 錯誤寫法:謂詞前必須是節點或節點集合 |
/messages/message[1]/node()[last()] | 第一個 message 的最後一個子節點 |
/messages/message[1]/text() | 第一個 message 下的所有文字節點 |
/messages/message[1]//text() | 遞歸下降,找出第一個 message 下所有深度的文字節點 |
//message[@id=1]/node() | id 為 1 的 message 之所有子節點 |
//message[@id=1] | //message[@id=0] | 聯集:同時選出 id=1 與 id=0 的 message |
/messages/message[1]/parent::* | messages 節點 |
/messages/message[1]/body/attachments/.. | attachments 的父節點;父節點唯一,所以 ..、parent::*、parent::node() 結果一致 |
//message[@id=0]/ancestor::* | 向上遞歸,取所有先輩元素 |
//message[@id=0]/ancestor-or-self::* | 向上遞歸並包含自身 |
//message[@id=0]/ancestor::node() | 相較於用 *,會多出一個文件根節點 |
//messages/message[1]//node() | 遞歸下降,取第一個 message 的所有後代節點 |
/messages/message[1]/sender/following::* | sender 之後的所有節點,並對每個節點向下遞歸 |
//message[@id=1]/sender/following-sibling::* | sender 之後的所有同級元素(不跨層) |
//message[@id=1]/datetime/@date | datetime 節點的 date 屬性值 |
//message/datetime[@date] | 所有帶有 date 屬性的 datetime 節點 |
//message[datetime] | 所有含有 datetime 子節點的 message |
//message/datetime/@* | datetime 的所有屬性節點 |
//message/datetime[@*] | 所有至少有一個屬性的 datetime 節點 |
//attribute::* | 根節點下的所有屬性節點 |
//message[@id=0]/body/preceding::node() | 逐層向上,依序選出 body 之前的所有同級節點(注意:同級節點是順序查找,不是遞歸查找) |
//message[@id=0]/body/preceding-sibling::node() | 只取 body 同一層之前的所有同級節點,少了逐層向上的那一圈循環 |
//namespace::* | 文件中所有命名空間節點(含預設命名空間) |
//message[@id=1]//*[namespace::amazon] | 命名空間前綴為 amazon 的節點 |
當 book 節點定義了命名空間(例如 <amazon:book>),寫成 //message[@id=0]//books/book 將找不到任何節點。正確做法有兩種:
//message[@id=0]//books/*[local-name()='book']
//message[@id=0]//books/*[local-name()='book'
and namespace-uri()='https://www.amazon.com/books/schema']
前者只比對本地名稱,後者同時比對名稱與命名空間 URI,語意更嚴謹。
//message[@id=0]//books/*[local-name()='book'][year>2006]
→ 篩選出 year 節點值大於 2006 的 book 節點
//message[@id=0]//books/*[local-name()='book'][1]/year>2006
→ 這是一個判斷式,檢查「第一個 book 的 year 是否大於 2006」,
回傳 xs:boolean 的 true / false
前者用來篩選節點,後者用在表達式末尾時已經變成布林比較,回傳型別完全不同。這是初學者最常踩的混淆點之一。
值得高興的是,XPath 與 XSLT、XQuery 共用函數庫,能直接呼叫各類實用函數,也支援自訂函數。這裡不逐一列舉,有興趣可直接查閱 W3C 的 https://www.w3.org/TR/xquery-operators/,中文讀者也可參考 w3school 的 XPath 函數章節。
<script language="Javascript" type="text/Javascript">
var xmlDoc = new ActiveXObject("Microsoft.XMLDOM");
xmlDoc.async = false;
xmlDoc.load("messages.XML");
xmlDoc.setProperty("SelectionLanguage", "XPath");
var sPath = "/messages/message[1]//books/*[local-name()='book']";
var bookNodes = xmlDoc.selectNodes(sPath);
document.write("<ul>");
for (var i = 0; i < bookNodes.length; i++) {
document.write("<li>" + bookNodes[i].childNodes[0].text + "</li>");
}
document.write("</ul>");
</script>
這裡有一個容易忽略的細節:早期 XMLDOM 的 SelectionLanguage 屬性預設是正則表達式而非 XPath,因此必須明確加上:
xmlDoc.setProperty("SelectionLanguage", "XPath");
若不設定這個屬性,就要注意兩件事:陣列下標從 0 開始(而 XPath 表達式內部的索引是從 1 開始),以及無法在查詢表達式中使用 XPath 函數。
補充一點背景:以 ActiveXObject 建立 XMLDOM 的寫法屬於 IE 時代的遺產,在今日的專案中通常會改用各語言原生的 XML/XPath API(例如 .NET 的 XDocument 搭配 XPathSelectNodes、Java 的 javax.xml.xpath、或 Node.js 的 xmldom + xpath 套件),語法觀念完全相通。
XPath 是 XSLT 的配對語言,幾乎每個 match、select、test 屬性裡都是 XPath 表達式;差別只在於 XSLT 環境中 <、> 必須以實體轉義形式書寫。
xquery version "1.0";
<ul>
{
let $i := 0
for $x in doc("messages.XML")//message[@id=0]//books/*[local-name()='book']
where $x/year > 2006
order by $x/year descending
return <li>{ data($x/name) }</li>
}
</ul>
輸出:
<ul>
<li>Microsoft Visual C# 2008 Step by Step</li>
<li>Professional C# 2008</li>
</ul>
可以清楚看到,for 子句中的定位子句就是標準的 XPath 路徑表達式,XQuery 只是在它外面包上了 FLWOR 表達式與結果建構的能力。
XPath 的學習曲線集中在一個觀念上:先確定上下文,再談路徑。把軸、節點測試、謂詞三個成分拆開來讀,多數「查不到節點」的問題都能立刻定位——是方向錯了、名稱沒對上,還是謂詞的位置放錯了。剩下的就是多寫幾條表達式把手感練出來。