過去幾年裡,我曾帶領一個程序構建小組,親眼見證了軟體從概念、代碼到交付用戶的整個過程所发生的巨大演變。其中最顯著的變化之一,莫過於管理大型軟體開發項目時,構建活動所依賴的工具與技術已經今非昔比。
回想 1990 年代中期,大多數源代碼都以 C 或 C++ 撰寫,描述並管理編譯流程的工具無非就是 make,再搭配零星幾個批次檔或 shell 腳本來提升自動化程度,構建過程大致就是如此。
如今時代早已不同。Java 技術、XML、XSLT、極限編程與持續構建等大量新技術、新思想接連問世。到了 90 年代後期,構建工具領域最大的變化,或許就是 Ant 的登場。
Ant 是一款基於 Java 的構建工具,源自 Apache Software Foundation 的 Jakarta 專案,如今已成為構建 Java 專案的事實標準。由於 Ant 腳本以 XML 表示,因此天生就能被解析、修改、生成,甚至透過 XSLT(可擴展樣式表語言轉換)進行程式化轉換。你甚至可以直接從某個 Ant 任務內部呼叫樣式表處理器。
接下來,我們要探討的正是 Ant 與 XSLT 攜手合作的場景。本文其餘篇幅將透過三個實務案例,說明我在工作中遭遇的問題與解法。每個案例的核心思路,都是把一份基礎 Ant 腳本與一份或多份 XSL 樣式表結合起來,讓原本靜態僵化的腳本變得靈活。請對照自身經驗思考 Ant 在以下情境中的用法:
問題的價值往往體現在解法之中。即使每個案例乍看之下未必直接適用於你,我相信你仍能在其中找到啟發,用這種簡單的技術為自己的構建流程注入活力。
正式開始之前,先確認你已掌握幾個基本概念。我提供的每個解法都需要執行一次 XSL 轉換。下圖說明了 XSLT 的一般運作方式:源文檔(source document)通常是一份 Ant 腳本,但有時也可能是另一個 XML 資料檔;轉換過程(transformation process)會把樣式表(stylesheet)中的規則套用到源檔上,進而產生結果文檔(result document)。
圖 1. XSLT 過程概覽
如前所述,我曾在一個構建小組工作多年,團隊需與眾多開發組織協作,支援他們的構建工作。我曾同時支援多達 17 種不同產品,並為一個持續演進的軟體發布將近 50 個版本。
我們面臨的挑戰之一,是管理如此龐雜且多樣的活動。各開發團隊之間共通點甚少、彼此少有交流,因此「標準化」便成為破題的關鍵。從抽象層次來看,我們每次發布的構建流程其實大同小異:
我們原本打算打造通用腳本,即使做不到完全一致,起碼也要遵循上述要點。然而由於設計五花八門,問題層出不窮。時間一久,這些腳本若缺乏嚴格管控,便逐漸朝不同方向蔓延,每一支都變得越來越特殊,而維護所耗費的人力、時間與協調成本也節節攀升。
解法
後來我們決定重做腳本,確立 Ant 作為主要構建工具的地位。我們先就一套預設構建流程達成共識,接著把前面列出的通用任務細分成更小的步驟,每個步驟代表一個工作單元,且對多個構建流程而言可能是通用的。在這套細化後的流程中,每個步驟都實作為一個或多個 Ant 目標,每個目標都具備適用於大多數情況的預設行為。
這些要點適用於所有構建流程,但對某個特定步驟而言,預設行為未必合適——這正是 XSLT 大顯身手之處。若無對預設腳本進行轉換的能力,我們恐怕仍得為幾乎相同的腳本維護多份副本。理想的做法是:每次構建只維護一份局部腳本,其中僅包含對該流程有效的步驟。我們因此設計了一個前端程序(同樣是一份 Ant 腳本),它會執行樣式表,把輸入文檔轉換成 Ant 的 build 檔。局部腳本裡未提及的步驟,就沿用預設定義。
整個過程可以用一個公式概括:
局部目標 + 預設目標 + 樣式表 = build 腳本
局部目標收錄在輸入轉換程序的主要 XML 檔中,轉換程序則從次要輸入文檔讀取預設目標,將兩者合併,並在合併過程中標明對局部腳本的引用。清單 1 展示了 Ant 中負責執行轉換的 <style> 任務。
清單 1. Ant 的 style 任務
<style in="${local_targets}" out="${build_script}" style="${style_sheet}" force="yes">
<param name="defaults" expression="${default_targets}"/>
</style>
預設的 targets 文檔並不是真正的 Ant 腳本,它不含 <project> 標籤,而是透過 <default> 標籤把 Ant 目標依各預設情況分組,每一組對應一個獨立的步驟(見清單 2)。
清單 2. 構建 defaults XML 範例
<defaults> <default name="init"> <!-- ========================================================================= Target: init Purpose: Common initialization target. ========================================================================= --> <target name="init"> <!-- This is where my default initialization tasks would be found ... --> </target> </default> <!-- Additional defaults go here ... --> </defaults>
若要做通用性的功能增強,只需修改預設目標或樣式表即可。由於所有流程都引用同一份預設目標或樣式表,任何改動都會在執行時自動套用到所有腳本上。維護上唯一需要留意的,是局部腳本覆蓋了某個通用增強特性的情況;但只要對設計加以妥善管理,依據我們對步驟的定義,那些可能被覆蓋的步驟本就不應包含任何預設行為。
我經常遇到的一個難題,是必須理解並修改別人撰寫的腳本。這些腳本往往充斥著由本該專注於源代碼的人所寫的構建流程,加上文檔匱乏、甚至偶有誤導,更讓它們惡名昭彰。
再好的文檔也無可取代,但若真的闕如,只要能以抽象方式瀏覽整個流程,也能抵消部分負面影響。只要掌握關鍵的引用關係,在腦海中建立起整體框架,就足以指引你繼續深入。有了好用的瀏覽器,你便能看見一幅概念性的全景視圖,自由穿梭其間而不必擔心迷失上下文——既見森林,也見樹木。
初次面對龐大的 Ant 腳本,多數人難免心生畏懼;即使你對它相當熟悉,往往也要耗費不少時間才能定位需要修改之處。所有 XML 文檔(Ant 腳本亦然)都具有高度結構化的特性,只要有 XSLT,就能把這種結構性轉換成 HTML 文檔,讓內容更易讀、更易理解。你可以用 XSL 過濾掉無關緊要的資訊,只保留關鍵元素。
若你的瀏覽器支援 XSL 樣式表(例如 Microsoft Internet Explorer 6),甚至能讓 Ant 腳本永久保有這種可讀性。不必大費周章,只要直接開啟 Ant 腳本,就能在瀏覽器中看到格式化後的結果。Ant 在執行時會忽略額外的處理指令,因此你無須事先另外產生 HTML 檔。
眼見為憑
第一步是開發一份把 Ant 腳本轉換成 HTML 的樣式表。樣式表可以簡單,也可以極盡詳盡,全看你的需求。無論好壞,這裡先列出我所開發的樣式表,它能滿足我檢視 Ant 腳本時的基本需求:
若你熟悉 HTML 或 JavaScript,對於格式化與呈現資料的方式,想必會有更具創意的做法。
準備好樣式表後,把它放到瀏覽器能存取的位置——可以是 HTTP 伺服器或某個分享裝置,怎麼方便就怎麼來。最後一步,是向 Ant 腳本加入一條指令,告訴瀏覽器在顯示時套用你的樣式表,否則你只會看到五顏六色的原始 XML 代碼。請把清單 3 中標示的部分複製到 Ant 腳本最上方,並將 href 屬性的值替換為你樣式表的實際位置。
清單 3. 樣式表處理指令
<?XML version="1.0"?> <?XML-stylesheet type="text/xsl" href="./examples/example2/ant2Html.xsl"?> <project name="Example2" default="main" basedir="."> <!-- The rest of the Ant script goes here. --> </project>
如此便大功告成。與前一個案例同理,由於樣式表與資料(此處即 Ant 腳本)彼此分離,無論你如何強化樣式表,都不必更動腳本本身。只要部署好修改後的樣式表,所有使用者立刻就能用上新樣式。
當你能瀏覽格式化後的 Ant 腳本,或許會想:為何不用框架讓瀏覽更順暢?其實,從單一樣式表產生多個框架並不像想像中那麼簡單,往往需要借助 JavaScript 這類腳本語言。我們不妨也來試試:我提供了同一份 Ant 腳本的第二個版本,這次改用能產生框架的樣式表來格式化。該樣式表用到 JavaScript、MSXML 與 ActiveX 控制項,因此必須以 Microsoft Internet Explorer 作為瀏覽器。
Ant 的語法與其他指令集一樣,都有無法表達的概念。雖然 Ant 對相依關係、引用關係與繼承關係處理得游刃有餘,卻不支援最基本的迴圈——原有的標籤集並未提供重複執行一組任務的手段。
問題
考慮一個簡單的例子:假設你正在構建的發布版本支援八種語言——德語、英語、法語、義大利語、日語、韓語、葡萄牙語與西班牙語。與特定語言相關的檔案必須以其本國編碼表示,這就要求對所有相關的屬性檔執行 Ant 的 native2ascii 任務。聽起來很適合用迴圈來解決,對吧?
以下是三種解法。
解法一:暴力法
暴力法就是反覆複製任務代碼,直到湊足所需次數。此法確實能達成目標,對迭代次數較少的情況也還堪用;但一旦迴圈規模變大、迭代次數增多,維護便成問題。每一段重複代碼都會提高程序邏輯出錯的機率,本例中任何修改(例如新增屬性檔)都得放大八倍。清單 4 展示了這種做法,粗體部分凸顯了各組代碼之間的細微差異。
清單 4. 暴力法
<target name="convert_native_encodings">
<native2ascii encoding=" Cp850" src="${basedir}/src" dest="${basedir}/export">
<include name="**/ *_de.properties"/>
</native2ascii>
<native2ascii encoding=" Cp850" src="${basedir}/src" dest="${basedir}/export">
<include name="**/ *_en.properties"/>
</native2ascii>
<native2ascii encoding=" Cp850" src="${basedir}/src" dest="${basedir}/export">
<include name="**/ *_es.properties"/>
</native2ascii>
<native2ascii encoding=" Cp850" src="${basedir}/src" dest="${basedir}/export">
<include name="**/ *_fr.properties"/>
</native2ascii>
<native2ascii encoding=" Cp850" src="${basedir}/src" dest="${basedir}/export">
<include name="**/ *_it.properties"/>
</native2ascii>
<native2ascii encoding=" SJIS" src="${basedir}/src" dest="${basedir}/export">
<include name="**/ *_ja.properties"/>
</native2ascii>
<native2ascii encoding=" KSC5601" src="${basedir}/src" dest="${basedir}/export">
<include name="**/ *_ko.properties"/>
</native2ascii>
<native2ascii encoding=" Cp850" src="${basedir}/src" dest="${basedir}/export">
<include name="**/ *_pt_BR.properties"/>
</native2ascii>
</target>
解法二:<for> 標籤
更好的方案,是為 Ant 加上一個 <for> 標籤。一套設計得當的擴展機制,能有效增強語言的表達力,清單 5 即是此類做法。然而它並非毫無缺陷:其一,實作新標籤需要對 Ant 的運作原理有相當深入的理解;其二,同樣是維護問題,也更值得警惕——執行時 Ant 必須能存取支援新標籤的類別,這意味著得仰賴獨立的 .jar 檔,或乾脆重新打包 Ant,而每一台執行該腳本的機器都得能取用這個新標籤。
清單 5. 一種更好的方法
<!-- Iterate over each language code -->
<target name="convert_native_encodings">
<loadproperties srcFile="encodings.properties"/>
<for token="%lang%"
iterate-over="de, en, es, fr, it, ja, ko, pt_BR">
<native2ascii encoding="${encoding.%lang%}" src="${basedir}/src"
dest="${basedir}/export">
<include name="**/ *_%lang%.properties"/>
</native2ascii>
</for>
</target>
encodings.properties 檔的用途,是建立從語言代碼到編碼的對應關係:
清單 6. 編碼對應表
# File: encodings.properties encoding.de=Cp850 encoding.en=Cp850 encoding.es=Cp850 encoding.fr=Cp850 encoding.it=Cp850 encoding.ja=SJIS encoding.ko=KSC5601 encoding.pt_BR=Cp850
解法三:改用 XSLT
最後一種方案與解法二同樣旨在擴展 Ant 語言,卻不會帶來維護負擔。這次我沒有在 Ant 內部新增 Java 類別來實作 for 迴圈,而是用 XSLT 完成相同的工作,最終得到一份可在 Ant 中執行的腳本。樣式表僅把 <for> 標籤展開成一連串任務,這一點又與第一種方法頗為相似。
這份轉換用的樣式表相當直觀:預設模板輸出的 XML 與輸入完全相同,無須更動;唯有遇到 <for> 標籤時,輸出才會有所不同。
有一點值得留意:最初的輸入並不是有效的 Ant 腳本,它的輸出才是。當你發布構建成果時,只需發布最終的腳本即可——它是一份完全合法的 Ant 腳本,大多數開發人員無須使用樣式表,直接執行即可。
希望這些內容對你有所幫助,無論是直接取用,還是點燃你自己的思路火花。其實我在許多層面上不過是在重新詮釋一個相當古老的想法——自最早的編譯語言時代起,人們就習慣在編譯前用模板對源代碼做預處理,而直到今天,這依然是一項強大的技術。
圍繞這項技術,仍有大量應用值得探索。最後留給你幾點建議,只盼這隻「Ant(螞蟻)」能繼續翩翩起舞:你可以嘗試用樣式表依據其他 XML 資料檔生成 Ant 腳本。比方說,我們撰寫的許多 Java 代碼都是透過外掛架構來打包與發布的,這要求包內具備 plugin.XML 檔;若要組裝外掛,會用到 <javac>、<jar> 等基礎 Ant 任務。何不善用 XSLT,把 plugin.XML 這份描述檔轉換成建構外掛的 Ant 腳本呢?
再舉一例:假設你希望在構建執行過程中即時掌握其狀態,例如即時更新某個網頁。一種做法是為 Ant 撰寫一個日誌任務,在每個目標開始或結束時執行更新,這同樣需要深入理解 Ant 並具備 Java 技能。還有一種更省事的做法:用 XSLT 在每個目標開始或結束時插入一項探測任務(probe task)。這些探測任務如同追蹤點,透過把資料寫入檔案的方式,用既有的 Ant 任務來擷取狀態。