Ant 是一個以 Java 實作的自動化腳本引擎,腳本格式為 XML。除了編譯相關任務,透過擴充(task)還能呼叫各類外部應用。
專案一大,每次重新編譯、打包、測試都變得繁瑣又重複,C 語言因此有 make 腳本來批量處理。Java 強調跨平台,自然不會採用平台相關的 make,於是有了 Ant:一個流程腳本引擎,用來自動化呼叫編譯器、打包工具與測試框架。它同樣與平台無關,而且腳本以 XML 撰寫,比 make 好維護得多。
每個 Ant 腳本(預設檔名 build.xml)定義了一系列 target。一個一般專案大致會有:
任務1:usage 列印本腳本的說明(預設) 任務2:clean <-- init 清空並初始化環境 任務3:javadoc <-- build <-- init 產生 API 文件 任務4:jar <-- build <-- init 打包成 JAR 任務5:all <-- jar + javadoc <-- build <-- init 一次跑完
target 之間透過 depends 屬性表達相依:打包(jar)相依於編譯(build),編譯又相依於環境初始化(init)。命名慣例大致固定:編譯叫 build 或 compile,打包叫 jar 或 war,文件叫 javadoc,全部執行叫 all。熟悉這套慣例後,接手別人的 build.xml 幾乎不必重新摸索。
解壓後把 ant 的 bin 目錄加入系統執行路徑即可。以 GNU/Linux 為例,可在 /etc/profile 中加入:
export ANT_HOME=/home/ant export JAVA_HOME=/usr/java/j2sdk1.4.1 export PATH=$PATH:$JAVA_HOME/bin:$ANT_HOME/bin
Ant 相依 JDK,所以 JAVA_HOME 必須先設定好。設定完成後直接執行 ant,若未指定參數,它會尋找當前目錄的 build.xml,並執行預設 target——通常指向 build 或 usage(列出所有可用選項)。
最有效的學習路徑是讀成熟開源專案的 build.xml,然後照自己的需求裁剪成更精簡的版本。以下是一份改寫自 JDOM 的範例,用於一個 WebLucene 應用:
<project default="usage" basedir=".">
<!-- ============ 初始化 ============ -->
<target name="init">
<tstamp/>
<property file="${basedir}/build.properties" />
<property name="Name" value="ProjectFullName"/>
<property name="name" value="project_name"/>
<property name="version" value="0.2"/>
<property name="year" value="2003"/>>
<echo message="----------- ${Name} ${version} [${year}] ------------"/>
<property name="debug" value="off"/>
<property name="optimize" value="on"/>
<property name="deprecation" value="on"/>
<property name="src.dir" value="./src/WEB-INF/src"/>
<property name="lib.dir" value="./src/WEB-INF/lib"/>
<property name="packages" value="com.chedong.*,org.apache.lucene.*"/>
<property name="build.src" value="./src/WEB-INF/build"/>
<property name="build.dest" value="./src/WEB-INF/classes"/>
<property name="build.Javadocs" value="./src/doc"/>
<path id="classpath">
<pathelement path="${JSdk_jar}"/>
<fileset dir="${lib.dir}">
<include name="**/*.jar"/>
</fileset>
</path>
<filter token="year" value="${year}"/>
<filter token="version" value="${version}"/>
<filter token="date" value="${TODAY}"/>
<filter token="log" value="true"/>
<filter token="verbose" value="true"/>
</target>
<!-- ============ 使用說明 ============ -->
<target name="usage" depends="init">
<echo message="${Name} Build file"/>
<echo message="---------------------------------------------------"/>
<echo message=" jar --> 產生 ${name}.jar"/>
<echo message=" build --> 編譯原始碼"/>
<echo message=" javadoc --> 產生 API 文件"/>
<echo message=" clean --> 清理輸出目錄"/>
<echo message=" 請將 build.properties.default 複製為 build.properties 並設定 JSDK 路徑"/>
<echo message="---------------------------------------------------"/>
</target>
<!-- ============ 準備原始碼 ============ -->
<target name="prepare-src" depends="init">
<mkdir dir="${build.src}"/>
<mkdir dir="${build.dest}"/>
<copy todir="${build.src}">
<fileset dir="${src.dir}"/>
</copy>
</target>
<!-- ============ 編譯 ============ -->
<target name="build" depends="prepare-src">
<javac srcdir="${build.src}"
destdir="${build.dest}"
debug="${debug}"
optimize="${optimize}">
<classpath refid="classpath"/>
</javac>
</target>
<!-- ============ 打包 ============ -->
<target name="jar" depends="build">
<jar jarfile="${lib.dir}/${name}.jar"
basedir="${build.dest}"
includes="**"/>
</target>
<!-- ============ API 文件 ============ -->
<target name="javadoc" depends="build">
<mkdir dir="${build.Javadocs}"/>
<javadoc packagenames="${packages}"
sourcepath="${build.src}"
destdir="${build.Javadocs}"
author="true" version="true" use="true"
splitindex="true"
windowtitle="${Name} API"
doctitle="${Name}">
<classpath refid="classpath"/>
</javadoc>
</target>
<!-- ============ 清理 ============ -->
<target name="clean" depends="init">
<delete dir="${build.src}"/>
<delete dir="${build.dest}/org"/>
<delete dir="${build.dest}/com"/>
<delete>
<fileset dir="${build.dest}" includes="**/*.class"/>
</delete>
</target>
</project>
兩個值得學的小設計:
其一,除了預設的 property 指定原始碼與輸出路徑外,額外載入外部的 build.properties:<property file="${basedir}/build.properties" />
這樣多數使用者只要看得懂 key-value 形式的設定檔就好——XML 的可讀性畢竟不如純文字屬性檔,把環境相關的細節外移,其他人就能從編譯細節中解脫。
其二,classpath 的定義:<path id="classpath"> ... </path>
它等價於把 SDK 的 jar 與 lib 目錄底下所有 jar 一起放進 CLASSPATH,後續任務只要用 <classpath refid="classpath"/> 引用即可,不必重複寫路徑。
先 mkdir 出臨時原始碼目錄與輸出目錄,再把 src 目錄的檔案複製過去。多這一層暫存的好處是:後續的 filter token 替換、排除特定檔案等操作都有地方施力,也不會污染原始碼樹。
build 透過 refid 引用前面定義的 path 完成編譯;jar 把 classes 目錄打包成 <name>.jar;javadoc 依 packages 屬性的清單產生文件,並同樣帶上 classpath;clean 則刪除暫存目錄與所有 .class 檔。
這份腳本只是起點,實務上通常還會補上:
參考資料:Jakarta Ant — https://ant.apache.org
補充一點:如今 Maven 與 Gradle 已在多數新專案中取代 Ant,但 Ant 的 target/depends 概念仍是理解 Java 建置流程的最佳入門,維護既有專案時更是必備技能。