上一篇我們展示了如何用一個樣式表修改另一個樣式表,讓模板在執行時自動產生註解。這個概念很有潛力,但第一版只能報告match屬性,無法告訴我們模板是否透過name呼叫、是否處於特定mode,或目前處理的來源節點是什麼。本篇會補上這些資訊,並加入可選擇的追蹤機制。
在XSLT中,模板不一定只靠match啟動。有些模板有name,會被xsl:call-template呼叫;有些模板則帶有mode,會在xsl:apply-templates切換模式時被選用。因此,追蹤註解最好能同時顯示match、name與mode,而且只在屬性存在時顯示,避免把不存在的屬性誤寫成空字串。
實作方式是在註解產生器中使用xsl:if,分別檢查match、name與mode是否存在。這樣即使模板只有name,或只有mode,也能正確標示。
除了模板本身,呼叫來源也很重要。大多數模板透過xsl:apply-templates呼叫,且mode不變;但有些情況會改變mode,有些則透過xsl:call-template直接呼叫。我們可以在這些元素外側加入註解,而不是插入元素內部。
例如,當遇到xsl:call-template時,可以在呼叫前產生一條註解,標明即將呼叫的模板名稱。當遇到帶有mode的xsl:apply-templates時,也可以在前後產生註解,表示模式切換。不過,XSLT本身無法直接查詢「目前為何被呼叫」或「原本的模式是什麼」,因此只能做近似標示。
知道哪個模板執行之後,下一步是知道它處理的是哪個來源節點。行號與列號對人類除錯不一定最有用,而且在標準XSLT中取得行列號需要依賴擴充。相比之下,XPath更能描述節點在文件中的位置,例如某個訂單文件中的第二個配送地址。
但完整XPath有個難題:名稱空間前綴。XPath允許使用前綴,卻沒有標準方式在表達式中宣告前綴,因此同一段XPath在不同上下文中可能代表不同意義。為了讓追蹤註解易讀,這裡採用近似做法:輸出一個對名稱空間不敏感的Pseudo XPath,主要供人類閱讀,而不是給XPath處理器直接執行。
產生Pseudo XPath的邏輯是:從目前節點往上走訪祖先與自身,依序判斷節點類型,輸出一個斜線、節點類型與名稱,以及必要的位置述詞。元素、文字、註解、處理指令、屬性與名稱空間節點都要分別處理。位置編號可透過xsl:number取得,用來區分同類型的兄弟節點。
在註解產生器中,只要於tracexsl:comment內呼叫pseudo-xpath-to-current-node模板,就能把來源位置寫進註解。為了讓產生的樣式表可以單獨運作,我們不把它拆成外部檔案,而是把這個模板複製到產生的樣式表中。
做法是在樣式化樣式表時匹配xsl:stylesheet,複製原本內容後,再檢查是否已經有pseudo-xpath-to-current-node模板;如果沒有,就從目前樣式表中複製一份進去。這裡用到document(''),可以讀取目前正在執行的樣式表本身。
當我們嘗試用tracexsl追蹤tracexsl時,會發現問題:如果每個模板都插入註解,連pseudo-xpath-to-current-node也會被插入註解,結果變成在註解中產生註解;有些位置甚至不允許插入註解,例如屬性值附近。這會讓追蹤工具自我中斷。
因此,需要讓模板可以標示「不要追蹤」。這裡使用tracexsl:trace="no"屬性。只要樣式表中的模板帶這個屬性,追蹤樣式表就會跳過它。這種做法也讓使用者能自行決定哪些模板適合插入註解,哪些不適合。
即使能跳過特定模板,大型樣式表仍可能產生過多註解。更好的方式是讓使用者指定只想追蹤哪些群組。可以為模板加上tracexsl:trace="某群組",再透過樣式表參數tracegroups決定要追蹤哪些群組。
例如,將tracegroups設為fred,ginger,只會追蹤標記為fred或ginger的模板;若tracegroups為空字串,則可追蹤所有未標記為no的模板。這個判斷不是完美的字串比對,但對人類控制的追蹤場景已足夠。
參數可透過命令列或TrAX API傳入。Xalan命令列可使用-PARAM tracegroups "fred,ginger";若使用TrAX,則可呼叫Transformer的setParameter方法。這樣使用者不必修改樣式表本身,就能動態決定追蹤範圍。
學會樣式化樣式表之後,可以延伸出許多應用。例如,把註解改成xsl:message訊息;用更複雜的規則決定是否追蹤;或分析追蹤輸出,統計每個模板被呼叫的次數。若需要嚴格XPath,也可以進一步處理名稱空間與多來源文件問題。
更重要的是,這不只是除錯技巧。它示範了如何用XSLT擴充XSLT:你可以自訂新的屬性或偽指令,再由「用於樣式表的樣式表」把它轉換成標準XSLT操作。只要避免依賴特定處理器的功能,這種方法可以在不同XSLT處理器之間保持可攜性。
換句話說,XSLT不只是拿來產生HTML或XML輸出的工具,它本身就是一個通用的文件處理器。而樣式表也是XML文件,因此可以被預處理、被轉換、被自動化增強。這種「編譯器式的預處理器」思路,正是樣式化樣式表最有趣的地方。