在這個兩部分系列的第一篇裡,我介紹了 XSLT 2.0 的幾項新特性,並示範如何從抽象資料模型產生程式碼。作為示範,我建立了一個專案,開發一套健壯的程式碼生成器:為資料庫伺服器產生 SQL,同時為 Web 伺服器產生用以存取資料庫的 PHP。做法是透過多層 XSL 轉換——先把抽象模型轉成資料庫實體結構模型,再由該模型建構 SQL 程式碼。
接下來要建構程式碼模型,並從這個模型生成 PHP。專案完成時,你手上會有系統的抽象模型、建庫用的 SQL,以及每張表對應的 PHP 包裝類。但在深入 PHP 生成之前,我想先把影響樣式表設計與使用方式的幾個 XSLT 2.0 新特性回顧一遍。
要成功生成程式碼,你必須同時熟悉目標語言(這裡是 PHP)與生成語言(這裡是 XSLT)。第 1 部分的重點在生成的基本原理,本文則把「XSL 這一側」看得更仔細些。
本質上,XSLT 是一種模板化語言:吃進 XML,再用一組模板把它轉成 XML、HTML 或純文字。生成器就是相關模板的集合,運用兩種模式——XML 模式與文字模式——把原本輸入的 XML 變成程式碼。位於抽象模型與程式碼模板之間的中間模型使用 XML 模式;生成 PHP 與 SQL 的模板則使用文字模式。
這套系統跑在 Saxon XSLT 引擎上,搭配一組自訂模板。為方便起見,模板與輸入放在同一個目錄,輸出則分別寫進 PHP 與 SQL 兩個程式碼目錄。Saxon 不需要特別擴充;不過若發現基本安裝提供的 XSL 標籤或 XPath 函式不夠用,仍可以用 Java 擴充樣式表引擎。
樣式表的入口是與輸入 XML 根節點匹配的模板。引擎啟動時,會把輸入 XML 套用到整個模板庫;若存在與根節點(/)匹配的專用模板,它會優先執行。生成器的主模板標籤就是:
<xsl:template match="/">
這套匹配機制很重要:XSL 會檢視當前節點可用的模板清單,挑出最匹配的一個來套用。清單 1 是上一期用過的例子。
清單 1. 帶有模式類型的模板
<xsl:template match="create" mode="sql">
DROP TABLE IF EXISTS <xsl:value-of select="@name" />;
CREATE <xsl:value-of select="@name" /> (
<xsl:apply-templates mode="sql" select="field" />
PRIMARY KEY ( <xsl:value-of select="@primary-key" /> )
);
</xsl:template>
這段程式告訴 XSL:本模板用於 create 標籤,因此遇到 create 時就執行它。另外請注意模板指定了模式;要讓它生效,還得在 xsl:apply-templates 中一併指定,如清單 2。
清單 2. 套用模板的標籤
<xsl:apply-templates mode="sql" select="$sql-model/sql" />
模式(mode)是 XSL 的重要概念。由於記憶體中可能同時存在多個 XML 樹狀結構,你需要一種方法,把某組特定模板只套用到其中一個結構,或同一份來源的不同轉換上。模式正是為此而生。在這個生成器裡,一組模板以 PHP 為模式,另一組以 SQL 為模式,兩種語言的模板邏輯就此分流。
xsl:apply-templates 指示 XSL 把可用模板套用到 select 所指定的那部分 XML 模型,同時宣告模式為 sql,於是 XSL 只會去找採用 sql 模式的模板。這等於是一套便利的模板名稱空間機制。
那麼輸出呢?這就要靠 XSLT 2.0 新增的 xsl:result-document 標籤了(見清單 3)。
清單 3. 呼叫 SQL 模板的程式碼
<xsl:result-document href="db/gen-tables.sql" format="sql" >
<xsl:apply-templates mode="sql" select="$sql-model/sql" />
</xsl:result-document>
一般情況下,模板輸出會流向執行轉換時指定的輸出目標,通常是單一檔案或標準輸出(主控台)。有了 xsl:result-document,你可以指定新的檔案來承接輸出;本例就把結果寫進 db/gen-tables.sql。對程式碼生成而言,這項特性幾乎是必備的,因為我們往往要從同一份 XML 輸入產生多個輸出檔。
另一項重要改動是 xsl:variable。與 result-document 類似,它改變了內部標籤輸出的去向:不是寫進檔案,而是存進記憶體中的暫時變數。本例把所呼叫模板的輸出放進變數 sql-model(見清單 4),而這個變數實際上是一棵 XML 樹,後續可以有別的模板繼續對它加工。
清單 4. 建立暫時樹變數的程式碼
<xsl:variable name="sql-model">
<xsl:call-template name="gen-sql-model">
<xsl:with-param name="model" select="."/>
</xsl:call-template>
</xsl:variable>
能在記憶體中同時持有數棵 XML 樹,大幅拓寬了 XSL 的應用範圍:你可以建立更大的模板系統,同時讓每個模板保持單純。
第三項值得注意的改進是 xsl:function 標籤,它能用來定義新的 XPath 函式(見清單 5)。
清單 5. 建立 XPath 函式的程式碼
<xsl:function name="gen:model-type-to-sql">
我用它寫了一個函式,把抽象模型(原始輸入檔)中宣告的型別映射為輸出檔中的 SQL 原生型別(清單 6)。用樣板當然也能做到,但透過這套新語法,你可以把函式直接宣告給 XPath 使用,寫起來清爽得多。
清單 6. 呼叫 XPath 函式的程式碼
<field name="{lower-case(@name)}" type="{gen:model-type-to-sql(@type)}"/>
對照 XSLT 1.0 得用 xsl:call-template 才能勉強拼出的效果,清單 6 的簡潔不言可喻。
生成 PHP 的步驟和 SQL 一樣:先建立待生成程式碼的模型,再把模板套上去。以前面用過的 Author 表為例,對應的資料庫存取模型如清單 7。
清單 7. 對應抽象輸入的語言模型
<?XML version="1.0" encoding="UTF-8"?>
<modules xmlns:gen="https://www.codegeneration.Net/">
<module name="Author">
<class name="Author">
<constructor name="Author"/>
<method name="selectAll">
<parameters/>
<implementation>
<selectAll table="author">
<field name="author_id"/>
<field name="first"/>
<field name="last"/>
</selectAll>
</implementation>
</method>
<method name="selectOne">
<parameters>
<variable name="author_id"/>
</parameters>
<implementation>
<selectOne table="author" by="author_id">
<field name="author_id"/>
<field name="first"/>
<field name="last"/>
</selectOne>
</implementation>
</method>
<method type="insert" name="insert">
<parameters>
<variable name="first"/>
<variable name="last"/>
</parameters>
<implementation>
<insert table="author">
<field name="first"/>
<field name="last"/>
</insert>
</implementation>
</method>
</class>
</module>
這份 XML 結構與最終程式碼的結構幾乎一一對應。值得注意的是,模型裡沒有任何一處是 PHP 專屬的——同一個模型也能用來生成其他具型別的語言,例如在模型中補上適當的型別資訊,就能改產出 Java 程式碼。要體會這種 XML 構造的價值,看它生成的 PHP 就知道了。
清單 8. 輸出的 Author 表
<script language="PHP">
class Author extends DatabaseTable {
function Author ( ) { }
function selectAll ( )
{
$dbh = getDbh();
return $dbh->doQuery(
"SELECT author_id, first, last FROM author"
);
}
function selectOne ( $author_id )
{
$dbh = getDbh();
return $dbh->doQuery(
"SELECT author_id, first, last FROM author WHERE author = ?",
$author_id );
}
function insert ( $first, $last )
{
$dbh = getDbh();
$dbh->doCommand( "INSERT INTO author ( first, last ) VALUES ( ?, ? )",
$first, $last );
}
}
</script>
回頭對照清單 7,你會發現模型裡每個標籤都對應輸出中的一個結構。例如 insert 類型的 method 標籤,就對應輸出類中的 insert 函式。
第一個模板是 Module 模板,負責建立新的 .PHP 檔(清單 9)。
清單 9. Module 模板
<!-- PHP: Module tag handler -->
<xsl:template match="module" mode="PHP">
<xsl:result-document href="php/{@name}.PHP">
<script language="PHP">
<xsl:apply-templates select="*" mode="PHP" />
</script>
</xsl:result-document>
</xsl:template>
請注意它用 xsl:result-document 為每個模組開一個新檔,再用 xsl:apply-templates 把程式碼填進去。
insert 方法的實作部分,則由清單 10 的模板負責。
清單 10. SQL Insert 模板
<!-- PHP: SQL Insert tag handler -->
<xsl:template match="insert" mode="PHP">
<xsl:call-template name="PHP-db-function">
<xsl:with-param name="content">
<xsl:call-template name="PHP-sql-command">
<xsl:with-param name="command" select="gen:build-insert(.)" />
</xsl:call-template>
</xsl:with-param>
</xsl:call-template>
</xsl:template>
另一個關鍵呼叫是 build-insert 函式,見清單 11。
清單 11. insert 指令建構器
<!-- Builds an SQL insert command -->
<xsl:function name="gen:build-insert">
<xsl:param name="query" />
<xsl:variable name="out">
<sql>
<query>
INSERT INTO <xsl:value-of select="$query/@table" />
(
<xsl:for-each select="$query/field"><xsl:if test="position() > 1">,
</xsl:if><xsl:value-of select="@name" /></xsl:for-each>
) VALUES (
<xsl:for-each select="$query/field"><xsl:if test="position() > 1">,
</xsl:if>?</xsl:for-each>
)
</query>
<inputs>
<xsl:for-each select="$query/field">
<input name="{@name}" />
</xsl:for-each>
</inputs>
</sql>
</xsl:variable>
<xsl:sequence select="$out" />
</xsl:function>
這個函式回傳一個完整的資料結構,同時包含查詢本身與所需的輸入參數。它在 XSLT 1.0 中也能實作,只是用 2.0 的自訂函式寫來方便許多。
最後,php-sql-command 模板把這份 SQL 資料結構寫成 PHP,見清單 12。
清單 12. SQL 指令模板
<!-- SQL command template -->
<xsl:template name="PHP-sql-command">
<xsl:param name="command" />$dbh->doCommand(
"<xsl:value-of select="normalize-space( $command/sql/query )" />"
<xsl:for-each select="$command/sql/inputs/input">,
$<xsl:value-of select="@name" />
</xsl:for-each> );
</xsl:template>
程式在 $command/sql/query 與 $command/sql/inputs/input 中取得 SQL 敘述,並把輸入參數逐一轉成程式碼。
看起來規模不大,但同樣的手法足以批量產出數百個 PHP 資料庫存取類。當然,這兩篇文章只給了一個示例;真要投入生產,你還得實作 DatabaseTable 基底類,並補上刪除與更新的方法。為了不讓程式碼過長,這裡我省下了它們。
這些文章的內容可以分成技術與觀念兩類。
技術上有兩點:第一,XSLT 非常適合用於程式碼生成,而 XSLT 2.0 把這個過程又簡化了一層;第二,在生成器中導入多個模型與多層轉換,能讓應用程式更容易理解、開發與維護。
觀念上則是:程式碼生成讓大量重複性程式碼得以迅速而準確地產出。好處不少——你把精神花在真正需要思考的地方,而不是耗在複製貼上;需求變動時,整個程式碼庫能快速跟著調整;技術選型也更自由,因為關鍵的設計資訊留在抽象模型裡,沒有被寫死進程式碼。
這些年來我持續撰寫、講授並推廣程式碼生成,期間和許多工程師聊過,他們對專案中使用生成器的評價都很正面。其中一位甚至說:「如果你開的是美國福特車,那台車的很多零件,其實也是福特靠程式碼生成,按生產需求做出來的。」透過這種富創造力又務實的做法,生產時間大幅縮短、程式碼品質提高,工程師也終於能把心思放在那些真正有趣的程式上。