DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> XML學習教程 >> XML詳解
用物件導向思維寫 XSLT:樣式表元件化與動態組裝
編輯:XML詳解     

今天大量應用系統以 XML 承載業務資料,而這些資料往往散落在不同來源。實務上常見的需求是:同一批資料,要能依不同角色呈現不同視圖。樣式表恰好提供了「業務資料」與「表現層」分離的手段,問題是——當視圖不只一種時,難道要為每種角色各寫一份龐大的樣式表嗎?

本文提出一個解法:把樣式表當成類別來設計,先做出多個可重複使用的 XSLT 文件元件,再由一個樣式表組裝器依請求動態拼裝出完整的樣式表,套用於分散的 XML 資料之上,藉此為不同使用者提供不同的表現層。

範例情境:產品目錄系統

我們以產品目錄為例,設定三種角色:一般用戶、高級用戶、內部用戶。各自的視圖不同——等級不同,折扣率不同,售價自然不同;內部用戶還需要看到供應商資訊。而產品資訊、供應商資訊、折扣率分別存放在三份 XML 文件中。

系統的核心機制是這樣的:先產出多個 XSLT 元件,每個元件負責一部分轉換職責,角色如同 OOP 中的類別;再製作一個「XSLT 文件組裝器」,它本身也是一份 XSLT,能接收應用程式傳入的參數,依參數把多個元件組裝成一份完整的樣式表。

把樣式表當類別看

XSLT 由一堆匹配模板、命名模板,加上一組屬性、參數與變數構成,作用於 XML 資料源時依定義的模板執行操作。從這個角度來看,樣式表確實很像 OOP 裡的類別——那麼,OO 的幾個核心概念自然也就能搬進來用。

三個基礎元件

依需求我們設計了三個基本樣式表:產品樣式表、供應商樣式表、折扣率樣式表。

產品樣式表是整個目錄系統的主樣式表,後續所有擴充都建立在它之上,地位等同基類。供應商樣式表負責轉換供應商資訊;由於資料位於另一份 XML,而主來源文件是產品列表,因此供應商 XML 必須作為輔助來源文件,透過 document() 載入。

清單 1:以 document() 取得節點集

<xsl:template name="supplierShow">
  <xsl:param name="sId"/>
  <xsl:variable name="supplier"
    select="document('suppliers.xml',.)//供應商[@id=$sId]"/>
  ......
</xsl:template>

折扣率樣式表則依用戶等級決定零售價。它同樣要跨文件取數,並依等級算出價格。

清單 2:零售價計算

<xsl:template name="discount">
  <xsl:param name="catalog"/>
  <xsl:param name="price"/>
  <xsl:param name="customerType"/>
  <xsl:variable name="discountPrice">
    <xsl:choose>
      <xsl:when test="$customerType='一般用戶'">
        <xsl:variable name="discountRate"
          select="document('discounts.xml',.)//一般用戶/折扣[@類別=$catalog]/@折扣率"/>
        <xsl:value-of select="$price * $discountRate"/>
      </xsl:when>
      ......
    </xsl:choose>
  </xsl:variable>
</xsl:template>

樣式表之間的繼承

XSLT 有兩種重用樣式表的方式:xsl:import(導入)與 xsl:include(包含)。差別在於:包含只是把樣式表直接插入主樣式表中該指令所在的位置,如同被包含的檔案從資料流中原位讀入;而導入的模板優先級較低,只有當呼叫端不存在同名模板或同名參數時才會被採用。

包含的編譯效率較快,但無法顯式重載模板。本範例需要重載能力,因此選擇導入。以下展示內部用戶的產品樣式表如何導入主樣式表並擴充供應商資訊——它相當於繼承了主產品樣式表,再疊加自己的功能。

清單 3:以導入機制擴充樣式表

<xsl:stylesheet xmlns:xsl="https://www.w3.org/1999/XSL/Transform" version="1.0">
  <!-- 導入樣式表 -->
  <xsl:import href="supplier.xslt"/>
  ......

  <!-- 顯示用的重載模板 -->
  <xsl:template match="供應商">
    <xsl:apply-imports/>
  </xsl:template>
</xsl:stylesheet>

樣式表的重載:mode 與 apply-imports

xsl:template 與 xsl:apply-templates 都有 mode 屬性。帶著 mode 的 apply-templates 只會尋找 mode 相同的模板並處理它,忽略模式不符的規則。利用這個特性,我們能為同一個 XML 元素定義多份模板,執行期再由 mode 決定實際呼叫哪一份。

清單 4:以 mode 區分不同視圖

<xsl:template match="價格" mode="normal">
  <br/>
  折扣價格:
  <xsl:call-template name="discount">
    <xsl:with-param name="catalog" select="../類別"/>
    <xsl:with-param name="price" select="."/>
    <xsl:with-param name="customerType" select="'一般用戶'"/>
  </xsl:call-template>
</xsl:template>

<!-- 與 apply-templates 的 mode 屬性搭配運作 -->
<xsl:template match="價格" mode="advanced">
  <br/>
  折扣價格:
  <xsl:call-template name="discount">
    <xsl:with-param name="catalog" select="../類別"/>
    <xsl:with-param name="price" select="."/>
    <xsl:with-param name="customerType" select="'高級用戶'"/>
  </xsl:call-template>
</xsl:template>

另一條路是 xsl:apply-imports。由於被導入的模板優先級低於導入方的同名模板(即使前者標了更高的 priority 也一樣),apply-imports 的作用近似 OOP 裡呼叫父類別的 super():它通知處理器去執行被導入文件中的模板,且該模板必須符合目前的上下文節點。

清單 5:運用導入模板

<xsl:stylesheet version="1.0" xmlns:xsl="https://www.w3.org/1999/XSL/Transform">
  <!-- 導入的樣式表元件 -->
  <xsl:import href="discount.xslt"/>
  ......

  <!-- 原有的價格匹配模板 -->
  <xsl:template match="價格">
    <br/>
    價格: <xsl:value-of select="."/>
    <!-- 導入的價格匹配模板 -->
    <xsl:apply-imports />
  </xsl:template>
</xsl:stylesheet>

這裡藏著一個陷阱:被導入的 discount.xslt 帶有 mode 屬性,主模板卻沒有,於是主模板根本無法正確匹配到對應的導入模板。這個問題留待下一節,由組裝器代為補上。

組裝器的實作

組裝器本身就是一份樣式表,依請求動態拼出不同樣式表。前面提到的 OO 概念,都是靠它在執行期「即時生成」出來的。思路是:依請求導入對應元件來擴充主樣式表,同時對主樣式表做必要改寫。

清單 6:依請求參數組裝樣式表

<xsl:param name="customerType" /> <!-- 傳入的請求參數 -->

<xsl:template match="xsl:stylesheet">
  <xsl:copy>
    <xsl:apply-templates select="@*"/>
    <xsl:choose>
      <!-- 依請求參數正確導入樣式表元件 -->
      <xsl:when test="$customerType='一般用戶' or $customerType='高級用戶'">
        <xsl:element name="xsl:import">
          <xsl:attribute name="href">
            <xsl:text>discount.xslt</xsl:text>
          </xsl:attribute>
        </xsl:element>
      </xsl:when>
      <xsl:when test="$customerType='內部用戶'">
        <xsl:element name="xsl:import">
          <xsl:attribute name="href">
            <xsl:text>supplier.xslt</xsl:text>
          </xsl:attribute>
        </xsl:element>
      </xsl:when>
    </xsl:choose>
    <xsl:apply-templates select="node()"/>
  </xsl:copy>
</xsl:template>

<xsl:template match="xsl:template">
  ......
  <!-- 在匹配模板中運用導入的模板 -->
  <xsl:if test="$customerType='內部用戶'">
    <xsl:if test="@match='供應商'">
      <xsl:element name="xsl:apply-imports"/>
    </xsl:if>
  </xsl:if>
  ......
</xsl:template>

清單 6 解決了組裝,但上一節留下的 mode 匹配問題還在。清單 7 示範如何在組裝過程中動態為主樣式表的模板補上 mode 屬性,補上之後,導入樣式表中的匹配模板就能被正確呼叫。

清單 7:動態補上 mode 屬性

<xsl:template match="xsl:template">
  <xsl:copy>
    <xsl:apply-templates select="@*"/>
    <!-- 依請求參數增加 mode 屬性 -->
    <xsl:if test="$customerType='一般用戶' or $customerType='高級用戶'">
      <xsl:if test="not(@match='/')">
        <xsl:attribute name="mode">
          <xsl:if test="$customerType='一般用戶'">
            <xsl:text>normal</xsl:text>
          </xsl:if>
          <xsl:if test="$customerType='高級用戶'">
            <xsl:text>advanced</xsl:text>
          </xsl:if>
        </xsl:attribute>
      </xsl:if>
      <!-- 主樣式表已具備對應 mode,故可正確呼叫導入的模板 -->
      <xsl:if test="@match='價格'">
        <xsl:element name="xsl:apply-imports"/>
      </xsl:if>
    </xsl:if>
    <xsl:if test="$customerType='內部用戶'">
      <xsl:if test="@match='供應商'">
        <xsl:element name="xsl:apply-imports"/>
      </xsl:if>
    </xsl:if>
    <xsl:apply-templates select="xsl:param"/>
    <xsl:apply-templates select="node()[not(name()='xsl:param')]"/>
  </xsl:copy>
</xsl:template>

注意最後兩行:先處理 xsl:param,再處理其餘節點。這是因為在 XSLT 中,xsl:param 必須是樣式表的前幾個子元素,若順序錯了引擎會直接報錯。

驗證用的測試程式

組裝完成後,寫個簡單的 Java 程式驗證系統。流程是兩段式轉換:先用組裝器樣式表把主樣式表骨架(product_skeleton.xml)轉成一份可用的樣式表,再用這份樣式表去轉換真正的產品資料。

清單 8:測試程式

import javax.xml.transform.*;
import javax.xml.transform.stream.*;
import java.io.*;

public class test {
  public static void main(String[] args) {
    try {
      StringWriter sw = new StringWriter();
      StringWriter sw2 = new StringWriter();
      TransformerFactory tf = TransformerFactory.newInstance();

      // XSLTCreator.xslt 即樣式表組裝器
      Transformer trans = tf.newTransformer(
        new StreamSource(new File("XSLTCreator.xslt")));

      // 應用程式傳入參數,決定組出哪一份樣式表
      trans.setParameter("customerType", "一般用戶");

      // product_skeleton.xml 是系統的主樣式表骨架
      trans.transform(new StreamSource(new File("product_skeleton.xml")),
                      new StreamResult(sw));

      Transformer trans2 = tf.newTransformer(
        new StreamSource(new StringReader(sw.toString())));
      trans2.transform(new StreamSource(new File("products.xml")),
                       new StreamResult(sw2));

      System.out.println(sw2.toString());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

Web 實例

以下是一個簡單的、以 WEB 為基礎的內容發布系統:它依請求動態生成樣式表,再回應相應頁面。系統本身著重在示範概念,未做效能優化。

圖一是系統的時序圖。其中 XSLTServlet 是所有請求的集中控制點與服務起點,XSLTCreator 則是組裝器的核心。

圖一 系統時序圖

清單 9:XSLTCreator 的主要實作

public void xsltCreator(HttpServletRequest req, HttpServletResponse resp)
        throws IOException, SAXException {
  StringWriter sw = new StringWriter();
  StringWriter sw2 = new StringWriter();
  String userType;
  try {
    TransformerFactory tf = TransformerFactory.newInstance();
    tf.setURIResolver(new URIResolver() {
      public Source resolve(String href, String base) {
        StringBuffer path = new StringBuffer(base_path);
        path.append(File.separator).append(href);
        File file = new File(path.toString());
        if (file.exists()) return new StreamSource(file);
        return null;
      }
    });

    // 第一段:組裝樣式表
    Transformer trans = tf.newTransformer(new StreamSource(
      locator.getCacheFile("XSLTCreator.xslt")));

    HttpSession session = req.getSession();
    if (req.getParameter("User") != null)
      session.setAttribute("userType", req.getParameter("User"));
    userType = (String) session.getAttribute("userType");
    trans.setParameter("customerType", userType);
    trans.transform(new StreamSource(
      locator.getCacheFile("product_skeleton.xml")), new StreamResult(sw));

    // 第二段:依產品別過濾資料
    Transformer trans2 = tf.newTransformer(new StreamSource(
      locator.getCacheFile("productFilter.xslt")));
    String type = (String) req.getParameter("productType");
    trans2.setParameter("type", type);
    trans2.transform(new StreamSource(
      locator.getCacheFile("products.xml")), new StreamResult(sw2));

    // 第三段:以組好的樣式表輸出最終頁面
    Transformer trans3 = tf.newTransformer(new StreamSource(
      new StringReader(sw.toString())));
    trans3.transform(new StreamSource(new StringReader(sw2.toString())),
                     new StreamResult(resp.getWriter()));

  } catch (TransformerConfigurationException e) {
    PrintWriter pw = resp.getWriter();
    pw.println("<html><body><h2>transformer error</h2><pre>");
    e.printStackTrace(pw);
    pw.println("</pre></body></html>");
  } catch (TransformerFactoryConfigurationError e) {
    ......
  } catch (TransformerException e) {
    ......
  }
}

系統入口如下圖二所示。

圖二 系統入口頁面

系統依請求動態生成不同頁面。圖三是以高級用戶身分登入後所呈現的內容。

圖三 動態生成的產品列表

總結

本文的做法可以濃縮成兩句話:以多個 XSLT 文件元件降低單一樣式表的設計複雜度,再以組裝器承擔動態、多變的樣式表生成工作。導入與重載負責「像類別一樣被擴充」,mode 負責「同一元素的多重視圖」,而組裝器負責在執行期把這些積木按請求拼起來。

需要提醒的是,這種「樣式表生成樣式表」的兩段式轉換,除錯成本不低——錯誤訊息往往指向生成後的樣式表而非你手寫的元件。正式環境建議把組裝結果快取起來,並在開發階段輸出成實際檔案以便追查問題。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved