在〈XSLT lookup tables〉與〈技巧:XSLT 查找表中的預設值和錯誤處理〉兩篇文件中,我示範了如何用 XSLT 實作靜態值的查找,並在查找失敗時提供預設值。這類程式碼邏輯很簡單,寫法卻相當笨拙——尤其當一份轉換裡要用到好幾張查找表時。
清單 1 是帶預設值的查找表示例。資料表以 xsl:key 建立索引,查不到時回傳 [UNKNOWN]。
清單 1:帶預設值的查找表(states-lookup-default.xslt)
<?XML version="1.0"?>
<xsl:transform
xmlns:xsl="https://www.w3.org/1999/XSL/Transform"
xmlns:s="https://example.com/states.data"
version="1.0">
<xsl:output method="text"/>
<xsl:key name="state-lookup" match="s:state" use="s:abbr"/>
<xsl:variable name="states-top" select="document('')/*/s:states"/>
<xsl:template match="label">
<xsl:value-of select="name"/>
<xsl:text> of </xsl:text>
<xsl:apply-templates select="$states-top">
<xsl:with-param name="curr-label" select="."/>
</xsl:apply-templates>
</xsl:template>
<xsl:template match="s:states">
<xsl:param name="curr-label"/>
<xsl:variable name="look-for" select="$curr-label/address/state"/>
<xsl:variable name="default" select="s:default"/>
<xsl:variable name="result" select="key('state-lookup', $look-for)/s:name"/>
<xsl:choose>
<xsl:when test="$result">
<xsl:value-of select="$result"/>
</xsl:when>
<xsl:otherwise>
<xsl:value-of select="$default"/>
</xsl:otherwise>
</xsl:choose>
</xsl:template>
<s:states>
<s:state><s:abbr>CO</s:abbr><s:name>Colorado</s:name></s:state>
<s:state><s:abbr>CT</s:abbr><s:name>Connecticut</s:name></s:state>
<s:state><s:abbr>ID</s:abbr><s:name>Idaho</s:name></s:state>
<s:state><s:abbr>NJ</s:abbr><s:name>New Jersey</s:name></s:state>
<s:default><s:name>[UNKNOWN]</s:name></s:default>
</s:states>
</xsl:transform>
直覺的做法是把查找邏輯抽成一個命名模板。清單 2 就是這樣寫的——不算理想,但在沒有其他複雜因素的前提下,這差不多是 XSLT 1.0 極限了。
清單 2:把查找邏輯包成可重用模板
<?XML version="1.0"?>
<xsl:transform
xmlns:xsl="https://www.w3.org/1999/XSL/Transform"
xmlns:s="https://example.com/states.data"
version="1.0">
<xsl:output method="text"/>
<xsl:key name="state-lookup" match="s:state" use="s:abbr"/>
<xsl:variable name="states-top" select="document('')/*/s:states"/>
<xsl:template match="label">
<xsl:value-of select="name"/>
<xsl:text> of </xsl:text>
<xsl:call-template name="lookup">
<xsl:with-param name="key-name" select="'state-lookup'"/>
<xsl:with-param name="look-for" select="address/state"/>
<xsl:with-param name="default" select="$states-top/s:default"/>
<xsl:with-param name="table-doc" select="$states-top"/>
</xsl:call-template>
</xsl:template>
<xsl:template name="lookup">
<xsl:param name="key-name"/> <!-- XSLT key 的名稱 -->
<xsl:param name="look-for"/> <!-- 要查找的值 -->
<xsl:param name="default"/>
<!-- 用來設定正確上下文的節點集,取其第一個項目即可 -->
<xsl:param name="table-doc"/>
<!-- 強制把上下文切到查找表所在文件 -->
<xsl:for-each select="$table-doc[1]">
<xsl:variable name="result" select="key($key-name, $look-for)"/>
<xsl:choose>
<xsl:when test="$result">
<xsl:value-of select="$result"/>
</xsl:when>
<xsl:otherwise>
<xsl:value-of select="$default"/>
</xsl:otherwise>
</xsl:choose>
</xsl:for-each>
</xsl:template>
<s:states>
<s:state><s:abbr>CO</s:abbr><s:name>Colorado</s:name></s:state>
<s:state><s:abbr>CT</s:abbr><s:name>Connecticut</s:name></s:state>
<s:state><s:abbr>ID</s:abbr><s:name>Idaho</s:name></s:state>
<s:state><s:abbr>NJ</s:abbr><s:name>New Jersey</s:name></s:state>
<s:default><s:name>[UNKNOWN]</s:name></s:default>
</s:states>
</xsl:transform>
最致命的缺陷是:查找結果只能透過 $result 的字串值在 lookup 模板中呈現。但我真正想要的是「輸入 CO,得到 Colorado」。清單 2 卻會輸出 COColorado,因為查找命中的是整個 s:state 元素,字串值把子元素內容全黏在一起了。相較之下,清單 1 直接在 select 裡指定 s:name,一步就把結果收斂到目標字串。
不同的查找情境往往需要不同的 XPath 表達式,才能從 key 回傳的節點中取出你要的那一小塊。理想做法是「把 XPath 當參數傳進 lookup 模板」,但這需要動態求值 XPath 的能力,而 XSLT 1.0 完全沒有這個機制。
你可能會想另一招:把 xsl:call-template 包進 xsl:variable,再從該變數取 s:name 子元素。這條路也走不通——變數算出來的是結果樹片段(RTF),而 XSLT 1.0 不允許對 RTF 執行軸操作。
此外還有些較不明顯的惱人之處:整段 xsl:call-template 結構冗長笨拙;而 xsl:key 有個容易混淆的行為——必須靠 xsl:for-each 把上下文切到查找表文件的某個節點,而該文件通常並不是來源文件(本例中甚至就是樣式表自己)。
除了最後那個「key 上下文」問題,其餘困擾都能靠 EXSLT 解決。清單 3 完整重現了清單 1 的行為,只用了兩個 EXSLT 機制:func:function 提供真正的函數抽象,dyn:evaluate 提供動態 XPath 求值。打包也乾淨多了。
清單 3:以 EXSLT 正確模組化
<?XML version="1.0"?>
<xsl:transform version="1.0"
xmlns:xsl="https://www.w3.org/1999/XSL/Transform"
xmlns:s="https://example.com/states.data"
xmlns:func="https://exslt.org/functions"
xmlns:dyn="https://exslt.org/dynamic"
extension-element-prefixes="func">
<xsl:output method="text"/>
<xsl:key name="state-lookup" match="s:state" use="s:abbr"/>
<xsl:variable name="states-top" select="document('')/*/s:states"/>
<xsl:template match="label">
<xsl:value-of select="name"/>
<xsl:text> of </xsl:text>
<xsl:value-of
select="s:lookup('state-lookup', address/state,
$states-top/s:default, $states-top,
'$result/s:name')"/>
</xsl:template>
<func:function name="s:lookup">
<xsl:param name="key-name"/> <!-- XSLT key 的名稱 -->
<xsl:param name="look-for"/> <!-- 要查找的值 -->
<xsl:param name="default"/>
<!-- 用來設定正確上下文的節點集,取其第一個項目即可 -->
<xsl:param name="table-doc" select="$default"/>
<!-- 字串形式的 XPath 運算式,用來取出最終結果;
預設直接把 key 的結果原樣渲染 -->
<xsl:param name="result-expr" select="'$result'"/>
<!-- 強制把上下文切到查找表所在文件 -->
<xsl:for-each select="$table-doc[1]">
<xsl:variable name="result" select="key($key-name, $look-for)"/>
<xsl:choose>
<xsl:when test="$result">
<func:result select="dyn:evaluate($result-expr)"/>
</xsl:when>
<xsl:otherwise>
<func:result select="$default"/>
</xsl:otherwise>
</xsl:choose>
</xsl:for-each>
</func:function>
<s:states>
<s:state><s:abbr>CO</s:abbr><s:name>Colorado</s:name></s:state>
<s:state><s:abbr>CT</s:abbr><s:name>Connecticut</s:name></s:state>
<s:state><s:abbr>ID</s:abbr><s:name>Idaho</s:name></s:state>
<s:state><s:abbr>NJ</s:abbr><s:name>New Jersey</s:name></s:state>
<s:default><s:name>[UNKNOWN]</s:name></s:default>
</s:states>
</xsl:transform>
自訂函數 s:lookup 可以在各種查找場景中重用,而第一個模板裡那段簡潔的 XPath 就是明證——查找程式碼幾乎縮成一行。呼叫時的參數順序對應函數定義中 xsl:param 的順序,func:result 則用來指定回傳給呼叫者的值。除此之外,函數主體的行為與 XSLT 1.0 的命名模板幾乎無異。
關鍵在於:result-expr 讓「從命中節點中取出哪一塊」變成可參數化的行為,而 dyn:evaluate 讓字串形式的 XPath 真正被求值。這恰好繞開了 RTF 不能做軸操作的限制——因為函數回傳的是節點集,而非結果樹片段。
這套設計的彈性很高。同一個函數,換一種呼叫方式也完全可行:
<xsl:value-of
select="s:lookup('state-lookup', address/state,
$states-top/s:default, $states-top)/s:name"/>
這裡不傳 result-expr,改在呼叫端對回傳的節點集直接做 /s:name 軸操作——之所以行得通,正是因為 func:function 回傳的是節點集而不是 RTF。
EXSLT 為 XSLT 1.0 的諸多缺點與限制提供了實用的補丁。這篇技巧聚焦在其中一項:用 func:function 與 dyn:evaluate 把原本笨拙的查找邏輯,收斂成一個乾淨、可重用、可參數化的函數。
使用上有兩個前提要留意:其一,dyn:evaluate 屬於動態求值,等於把一段運算式當成輸入,若字串來源可能夾雜外部資料,需自行確保其可信度;其二,EXSLT 屬擴充功能,並非所有 XSLT 引擎都完整支援,跨環境部署前值得先驗證一次。