本文描述一套機制:把應用的業務資料與表現資料分開開發,再用一份通用的 XSLT 樣式表將兩者組裝起來。業務資料被格式化為 XML,表現資料則用傳統工具就能完成;透過在表現資料上附加屬性,樣式表得以把版面細節套用到實際內容上。整個最終格式的產生過程不需要專門編程,因為它交給了 XSLT 處理器。
要讀懂本文,你應該具備 XML 與 XSLT 的基礎知識。文中所有示例都以 Apache Xerces XML 解析器 2.0.1 版與 Apache Xalan XSLT 處理器 2.3.1 版產生。
架構方面,我採用 Java 2 企業版(J2EE)提出的 n 層結構,如圖 1。
圖 1. n 層架構
本文聚焦第 1 層與第 2 層。若希望輸出由 servlet 處理,這個架構可以再往前推進:servlet 呼叫與後端溝通的應用邏輯,後端可以是(例如)部署在網路中獨立伺服器上的 Enterprise JavaBean。這裡假設所有業務資料都已格式化為 XML,接著透過 Java Server Page(JSP)準備這些資料以進行表現,再送回用戶端,如圖 2。
圖 2. 使用 JSP 準備待表現的資料
若把它對應到「模型—視圖—控制器(MVC)」設計模式:servlet 扮演控制器,應用邏輯代表模型,JSP 則是視圖。(這樣的對應當然是簡化過的,但足以說明基本原理。)
要真正吃到「用 XML 承載應用資料」的好處,得先把資料轉成可表現的格式,而最常見的做法就是 XSLT 樣式表。XSL 規範提供了兩條路:使用格式化物件(FO),或撰寫單純的 XSLT 樣式表。
FO 通常產生二進位輸出格式,至今仍未廣泛普及(儘管它更適合用於編輯表現資料),主流 XSL 處理器與工具對它的支援也相當有限。另一方面,XSLT 樣式表的使用面廣得多,因此本文聚焦於此。
XSLT 樣式表一律以一份 XML 文件作為輸入,由 XSL 處理器依樣式表中的規則處理它,產生一份新的 XML 輸出文件,如圖 3。
圖 3. 使用 XSLT 樣式表處理 XML 文件
在大多數情況下,這種結構會導致樣式表裡同時混雜著轉換規則與表現資料本身。以下用一個例子說明:假設我有 XML 格式的通訊錄資料,需要轉成 HTML 以便在瀏覽器中檢視。清單 1 是輸入資料。(提醒:XSLT 轉換的輸出必定是另一份 XML 文件;HTML 未必要格式良好,因此這裡一律產生 XHTML,因為 XHTML 一定是格式良好的。稍後再回來談這點。)
清單 1. XML 輸入資料
<addressbook>
<address>
<addressee>John Smith</addressee>
<streetaddress>250 18th Ave SE</streetaddress>
<city>Rochester</city>
<state>MN</state>
<postalCode>55902</postalCode>
</address>
<address>
<addressee>Bill Morris</addressee>
<streetaddress>1234 Center Lane NW</streetaddress>
<city>St. Paul</city>
<state>MN</state>
<postalCode>55123</postalCode>
</address>
</addressbook>
清單 2 是把它轉成 HTML 的樣式表。
清單 2. 用 XSLT 樣式表把資料轉成 HTML
<?XML version='1.0'?>
<xsl:stylesheet xmlns:xsl="https://www.w3.org/1999/XSL/Transform"
version="1.0">
<xsl:output method="Html" indent="yes"/>
<!-- copy all elements that are not matched otherwise -->
<xsl:template match="* | @*">
<xsl:copy><xsl:copy-of select="@*"/><xsl:apply-templates/></xsl:copy>
</xsl:template>
<xsl:template match="addressbook">
<Html>
<head><title>My Addressbook</title></head>
<body>
<h1>My Addressbook</h1>
<table border="1">
<thead>
<tr>
<td>Name</td>
<td>Street</td>
<td>City</td>
<td>Postal Code</td>
</tr>
</thead>
<tbody>
<xsl:for-each select="address">
<tr>
<td><xsl:value-of select="addressee"/></td>
<td><xsl:value-of select="streetaddress"/></td>
<td><xsl:value-of select="city"/></td>
<td><xsl:value-of select="postalCode"/></td>
</tr>
</xsl:for-each>
</tbody>
</table>
</body>
</Html>
</xsl:template>
</xsl:stylesheet>
清單 2 暴露出兩個問題。第一,樣式表裡同時塞滿了業務資料的轉換資訊與表現資料本身,幾乎不可能再用 HTML 編輯環境來維護。第二,每換一種輸出格式就得複製一份樣式表——例如用戶端若是手機,表現資料可能得改成 WML 而非 HTML。
我們先把樣式表放一邊,單獨描述表現資料。為了建立表現資料與表現元素之間的關聯,可以為所用的 HTML 標籤定義擴展屬性,再寫一份樣式表讀取這些屬性,組出最終的輸出。
這裡有個障礙:XSLT 處理器只接受一份 XML 輸入文件,再依樣式表產生一份輸出文件。(輸入可以各種形式傳入:檔案、位元組串流,或直接的 DOM 物件。)但我們手上有兩個輸入來源——應用資料與表現資料。有兩種解法:
document() 函式,把額外的 XML 檔嵌入供樣式表使用。兩者都可行。本文採用第二種,其結構如圖 4。
圖 4. 把多個輸入來源合併為一份 XML 文件
請注意,依 XSLT 處理器的要求,這裡的表現資料必須是格式良好的 XML,這點很重要。HTML 並非在所有情況下都格式良好,改用 XHTML 就能補上這個缺口。這個主題本文不細談,只舉一例:HTML 中的 <br> 元素通常當空元素使用,卻沒有依 XML 標準自我結束;在格式良好的 XML 中,它必須寫成 <br />(雖然主流瀏覽器兩種都吃)。
要把資料轉成期望的輸出格式,得先知道哪個表現元素對應哪個資料元素。做法是在 HTML 元素上加屬性,讓樣式表能依此完成資料綁定,如清單 3。
清單 3. 為 HTML 元素加上屬性
<?XML version="1.0"?>
<combinedelement>
<view>
<Html>
<head>
<title>My Addressbook</title>
</head>
<body>
<form method="POST">
<table id="AddressesPanel" dataSrc="addressbook"
rowelement="address">
<tr>
<th>Name</th>
<th>Street</th>
<th>City</th>
<th>Postal Code</th>
</tr>
<tr>
<td><input datafld="addressee" ></input></td>
<td><input datafld="streetaddress"></input></td>
<td><input datafld="city"></input></td>
<td><input datafld="postalCode"></input></td>
</tr>
</table>
<input type="submit" value="Change"/>
</form>
</body>
</Html>
</view>
<model>
<addressbook>
<address>
<addressee>John Smith</addressee>
<streetaddress>250 18th Ave SE</streetaddress>
<city>Rochester</city>
<state>MN</state>
<postalCode>55902</postalCode>
</address>
<address>
<addressee>Bill Morris</addressee>
<streetaddress>1234 Center Lane NW</streetaddress>
<city>St. Paul</city>
<state>MN</state>
<postalCode>55123</postalCode>
</address>
</addressbook>
</model>
</combinedelement>
前面提過要合併兩份輸入文件。由於一份 XML 文件只能有一個根元素,這就是我把 <combinedelement> 定義成新根元素的原因。依 MVC 術語,表現資料包在 <view> 裡,業務資料包在 <model> 裡。
接著看這段:
<table id="AddressesPanel" dataSrc="addressbook" rowelement="address">
dataSrc 屬性指出 <model> 中哪個元素要顯示在表裡,rowelement 屬性則定義哪個元素充當迭代單位。
表中的每個輸入元素都帶一個 datafld 屬性,用來標明該欄顯示哪個業務資料元素的值:
<td><input datafld="addressee" ></input></td>
<td><input datafld="streetaddress"></input></td>
<td><input datafld="city"></input></td>
<td><input datafld="postalCode"></input></td>
這些表現資料,你可以用 WebSphere Studio 之類的工具,或任何能編輯 HTML 頁面的環境輕鬆完成;額外的屬性得手動補進 HTML 原始碼,但基本的表現視圖完全可以在工具中直觀地拉出來,不需要寫程式,也不需要懂 XSL。當然,若你覺得直接手寫更順手,也完全不必借助任何工具。
最後一塊拼圖,是產生最終輸出的樣式表。這份樣式表可以獨立於實際應用程式開發,因為它裡頭不含任何應用專屬的資訊。清單 5 只涵蓋 HTML 表格的處理,但其他 HTML 元素都能用非常類似的手法處理。
清單 5. 用 XSLT 樣式表處理 HTML 表格
<?XML version='1.0'?>
<xsl:stylesheet xmlns:xsl="https://www.w3.org/1999/XSL/Transform"
version="1.0">
<xsl:output method="Html" indent="yes"/>
<!-- copy all elements which don't match any template -->
<xsl:template match="* | @*">
<xsl:copy><xsl:copy-of select="@*"/><xsl:apply-templates/></xsl:copy>
</xsl:template>
<!-- delete the model element and all its content -->
<xsl:template match="model"/>
<!-- delete the combinedelement element, but not its content -->
<xsl:template match="combinedelement">
<xsl:apply-templates/>
</xsl:template>
<!-- delete the view element, but not its content -->
<xsl:template match="view">
<xsl:apply-templates/>
</xsl:template>
<!-- handle all <tr> elements -->
<xsl:template match="TR | tr">
<xsl:choose>
<!-- no special handling of the table header -->
<xsl:when test="th">
<xsl:apply-templates/>
</xsl:when>
<xsl:otherwise>
<!-- store the name of the rowelement in a variable -->
<!-- in the addressbook sample, this is 'address' -->
<xsl:variable name="rowname">
<xsl:value-of
select='(ancestor::node()[name() = 'table'])/@rowelement"/>
</xsl:variable>
<!-- call the 'processRow' template, passing the rowelement -->
<!-- and a counter -->
<xsl:call-template name="processRow">
<xsl:with-param name="numAddresses">
<xsl:value-of select="count(//*[name() = $rowname])"/>
</xsl:with-param>
<xsl:with-param name="n">1</xsl:with-param>
</xsl:call-template>
</xsl:otherwise>
</xsl:choose>
</xsl:template>
<!-- the processRow template calls itself recursively -->
<!-- for all rowelements -->
<xsl:template name="processRow">
<xsl:param name="numAddresses"/>
<xsl:param name="n"/>
<!-- done iterating? -->
<xsl:if test="$numAddresses >= $n">
<xsl:copy>
<!-- for all td's -->
<xsl:for-each select="td">
<!-- copy the element content -->
<xsl:copy>
<xsl:copy-of select="@*"/>
<!-- find all elements with a 'datafld' attribute -->
<!-- and save them in a variable for later use -->
<xsl:for-each select="./*[@datafld]">
<xsl:variable name="elname">
<xsl:value-of select="./@datafld"/>
</xsl:variable>
<!-- copy the element, change the 'datafld' -->
<!-- attribute into a 'name' attribute -->
<xsl:copy>
<xsl:copy-of select='(@*)[name() != 'datafld']"/>
<xsl:attribute name="name">
<xsl:value-of select="@datafld"/>
</xsl:attribute>
<!-- retrieve the value of the element -->
<!-- from the model by using the -->
<!-- 'datafld' attribute as a search -->
<!-- argument -->
<xsl:attribute name="value">
<xsl:value-of
select='(//*[name() = $elname])[position() = $n]'/>
</xsl:attribute>
</xsl:copy>
</xsl:for-each>
</xsl:copy>
</xsl:for-each>
<!-- call the template recursively, increase counter -->
<xsl:call-template name="processRow">
<xsl:with-param name="n">
<xsl:value-of select="$n + 1"/>
</xsl:with-param>
<xsl:with-param name="numAddresses">
<xsl:value-of select="$numAddresses"/>
</xsl:with-param>
</xsl:call-template>
</xsl:copy>
</xsl:if>
</xsl:template>
</xsl:stylesheet>
清單 5 中有一個細節值得細究,因為它在許多場合都用得上。XSLT 沒有為迴圈定義任何機制,但當同一個輸入元素必須被重複處理才能產生正確輸出時,你就需要迴圈。繞過這個限制的方法,是定義一個遞迴呼叫自己的模板:它把變數傳給自己當計數器,藉此決定迴圈何時結束。
本文提出的方案把應用業務資料與表現資料分開開發,再由一份通用 XSLT 樣式表將兩者整合。它並不完整,只描述了概念,我期待日後出現更完整、更健壯的實作。
一旦有了這樣的通用樣式表,就能像清單 5 那樣到處套用並重用。舉例來說,結構化資訊標準促進組織(OASIS)提出的「Web 服務的互動式應用(WSIA)」倡議也奠基於 MVC 模式,嘗試為可視的 Web 服務定義組件模型,其成果很可能會導向與本文所述類似的技术路线。