ANT的安裝/配置筆記

ANT的安裝/配置筆記

作者：車東 發表於：2003-03-06 17:03 最後更新於：2007-04-12 11:04
著作權聲明：可以任意轉載，轉載時請務必以超連結形式標明文章原始出處和作者資訊及本聲明。
http://www.chedong.com/tech/ant.html

內容摘要：
ant是一個基於JAVA的自動化指令碼引擎，指令碼格式為XML。除了做JAVA編譯相關任務外，ANT還可以通過外掛程式實現很多應用的調用。

1. ANT的基本概念：
2. ANT的安裝：解包，設定路徑
3. ANT的使用：最好的學習只不過是一個簡單實用的例子起步……

ANT的基本概念：Java的Makefile

當一個代碼項目大了以後，每次重新編譯，打包，測試等都會變得非常複雜而且重複，因此c語言中有make指令碼來協助這些工作的批量完成。在Java 中應用是平台無關性的，當然不會用平台相關的make指令碼來完成這些批處理任務了，ANT本身就是這樣一個流程指令碼引擎，用於自動化調用程式完成項目的編 譯，打包，測試等。除了基於JAVA是平台無關的外，指令碼的格式是基於XML的，比make指令碼來說還要好維護一些。

每個ant指令碼（預設叫build.xml）中設定了一系列任務(target)：比如對於一個一般的項目可能需要有以下任務。

• 任務1：usage 列印本指令碼的協助資訊（預設）
• 任務2：clean <-- init 清空初始化環境
• 任務3：javadoc <-- build <-- init 產生JAVADOC
• 任務4：jar <-- build <-- init 產生JAR
• 任務5：all <-- jar + javadoc <-- build <-- init 完成以上所有任務：jar javadoc

而多個任務之間往往又包含了一定了依賴關係：比如把整個應用打包任務(jar)的這個依賴於編譯任務(build)，而編譯任務又依賴於整個環境初始化任 務(init)等。

註：我看到很多項目的ant指令碼中的命名基本上都是一致的，比如：編譯一般叫build或者compile；打包一般叫jar或war；產生文檔一般命名 為javadoc或javadocs；執行全部任務all。在每個任務的中，ANT會根據配置調用一些外部應用並配以相應參數執行。雖然ANT可調用的外 部應用種類非常豐富，但其實最常用的就2，3個：比如javac javadoc jar等。
ANT的安裝

解包後在系統可執行路徑中加入指向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 後，如果不指定設定檔ant會預設找build.xml這個設定檔，並根據設定檔執行任務，預設的任務設定可以指向最常用的任務，比如： build，或指向列印協助資訊：usage，告訴使用者有那些指令碼選項可以使用。

ANT的使用
最好的學習過程就是看懂那些open source項目中的build.xml指令碼，然後根據自己的需要簡化成一個更簡單的，ANT和APACHE上很多非常工程派的項目：簡單易用，而且適應 性非常強，因為這些項目的建立往往來源於開發人員日常最直接的需求。
以下是的一個WebLucene應 用的例子：修改自JDOM的build.xml：

<project default="usage" basedir=".">

  <!-- =================================================================== -->
  <!-- Initialization target                                               -->
  <!-- =================================================================== -->
  <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>

  <!-- =================================================================== -->
  <!-- Help on usage                                                       -->
  <!-- =================================================================== -->
  <target name="usage" depends="init">
    <echo message="${Name} Build file"/>
    <echo message="-------------------------------------------------------------"/>
    <echo message=""/>
    <echo message=" available targets are:"/>
    <echo message=""/>
    <echo message="   jar      --> generates the ${name}.jar file"/>
    <echo message="   build    --> compiles the source code"/>
    <echo message="   javadoc  --> generates the API documentation"/>
    <echo message="   clean    --> cleans up the directory"/>
    <echo message=""/>
    <echo message=" Please rename build.properties.default to build.properties"/>
    <echo message=" and edit build.properties to specify JSDK 2.3 classpath."/>
    <echo message=""/>
    <echo message=" See the comments inside the build.xml file for more details."/>
    <echo message="-------------------------------------------------------------"/>
    <echo message=""/>
    <echo message=""/>
  </target>

  <!-- =================================================================== -->
  <!-- Prepares the source code                                            -->
  <!-- =================================================================== -->
  <target name="prepare-src" depends="init">
    <!-- create directories -->
    <mkdir dir="${build.src}"/>
    <mkdir dir="${build.dest}"/>
   
    <!-- copy src files -->
    <copy todir="${build.src}">
      <fileset dir="${src.dir}"/>
    </copy>
  </target>

  <!-- =================================================================== -->
  <!-- Compiles the source directory                                       -->
  <!-- =================================================================== -->
  <target name="build" depends="prepare-src">
    <javac srcdir="${build.src}"
           destdir="${build.dest}"
           debug="${debug}"
           optimize="${optimize}">
      <classpath refid="classpath"/>
    </javac>
  </target>

  <!-- =================================================================== -->
  <!-- Creates the class package                                           -->
  <!-- =================================================================== -->
  <target name="jar" depends="build">
    <jar jarfile="${lib.dir}/${name}.jar"
         basedir="${build.dest}"
         includes="**"/>
  </target>

  <!-- =================================================================== -->
  <!-- Creates the API documentation                                       -->
  <!-- =================================================================== -->
  <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>

  <!-- =================================================================== -->
  <!-- Clean targets                                                       -->
  <!-- =================================================================== -->
  <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>
<!-- End of file -->

預設任務：usage 列印協助文檔，告訴有那些任務選項：可用的有build, jar, javadoc和clean.

初始化環境變數：init
所有任務都基於一些基本環境變數的設定初始化完成，是後續其他任務的基礎，在環境初始化過程中，有2點比較可以方便設定：

1 除了使用卻預設的property設定了JAVA源路徑和輸出路徑外，引用了一個外部的build.properties檔案中的設定，
<property file="${basedir}/build.properties" />
這樣大部分簡單配置使用者只要會看懂build.properties就可以了，畢竟XML比起key value的屬性檔案還是要可讀性差一些。用build.properties也可以方便其他使用者從編譯的細節中解放出來。

2 CLASSPATH設定：使用了其中的：
    <path id="classpath">
        <pathelement path="${jsdk_jar}"/>
        <fileset dir="${lib.dir}">
           <include name="**/*.jar"/>
        </fileset>
    </path>
則相當於設定了：CLASSPATH=/path/to/resin/lib/jsdk23.jar; /path/to/project/lib/*.jar;

檔案複製：prepare-src
建立臨時SRC存放目錄和輸出目錄。
  <!-- =================================================================== -->
  <!-- Prepares the source code                                            -->
  <!-- =================================================================== -->
  <target name="prepare-src" depends="init">
    <!-- create directories -->
    <mkdir dir="${build.src}"/>
    <mkdir dir="${build.dest}"/>
   
    <!-- copy src files -->
    <copy todir="${build.src}">
      <fileset dir="${src.dir}"/>
    </copy>
  </target>

編譯任務：build
編譯時間的CLASSPATH環境通過一下方式找到引用一個path對象
<classpath refid="classpath"/>

打包任務：jar
對應用打包產生項目所寫名的.jar檔案
  <!-- =================================================================== -->
  <!-- Creates the class package                                           -->
  <!-- =================================================================== -->
  <target name="jar" depends="build">
    <jar jarfile="${lib.dir}/${name}.jar"
         basedir="${build.dest}"
         includes="**"/>
  </target>

產生JAVADOC文檔任務: javadoc
  <!-- =================================================================== -->
  <!-- Creates the API documentation                                       -->
  <!-- =================================================================== -->
  <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>

清空臨時編譯檔案：clean
  <!-- =================================================================== -->
  <!-- Clean targets                                                       -->
  <!-- =================================================================== -->
  <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>

TODO：
更多任務/擴充：（範例）

• 測試工作：JUnit測試
• 代碼風格檢查任務：CheckStyle，Jalopy等
• 郵件警報任務：可以把以上這些任務的輸出警告發送到制定的使用者列表中，這個任務可以設定每天自動運行。

參考資料：
Jakarta ANT:
http://ant.apache.org