Ant學習指南

david.zhang 2006-07-25

展開全文

Ant學習指南

作者：車東來自：http://blog.csdn.net/legendinfo

　　內(nèi)容摘要：
　　ANT是一個基于Java的自動化腳本引擎，腳本格式為XML。除了做Java編譯相關任務外，ANT還可以通過插件實現(xiàn)很多應用的調(diào)用。
　　1)ANT的基本概念：
　　2)ANT的安裝：解包，設置路徑
　　3)ANT的使用：最好的學習只不過是一個簡單實用的例子起步……

　　ANT的基本概念：Java的Makefile

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

　　每個ant腳本（缺省叫build.xml）中設置了一系列任務(target)：比如對于一個一般的項目可能需要有以下任務。

　　任務1：usage 打印本腳本的幫助信息（缺?。?
　　任務2：clean <-- init 清空初始化環(huán)境
　　任務3：javadoc <-- build <-- init 生成JAVADOC
　　任務4：jar <-- build <-- init 生成JAR
　　任務5：all <-- jar + javadoc <-- build <-- init 完成以上所有任務：jar javadoc

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

　　注：我看到很多項目的ant腳本中的命名基本上都是一致的，比如：編譯一般叫build或者compile；打包一般叫jar或war；生成文檔一般命名為javadoc或javadocs；執(zhí)行全部任務all。在每個任務的中，ANT會根據(jù)配置調(diào)用一些外部應用并配以相應參數(shù)執(zhí)行。雖然ANT可調(diào)用的外部應用種類非常豐富，但其實最常用的就2，3個：比如javac javadoc jar等。

　　ANT的安裝

　　解包后在系統(tǒng)可執(zhí)行路徑中加入指向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

　　這樣執(zhí)行ant 后，如果不指定配置文件ant會缺省找build.xml這個配置文件，并根據(jù)配置文件執(zhí)行任務，缺省的任務設置可以指向最常用的任務，比如：build，或指向打印幫助信息：usage，告訴用戶有那些腳本選項可以使用。

　　ANT的使用

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

<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"/>

<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>

<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>

<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>

　　缺省任務：usage 打印幫助文檔，告訴有那些任務選項：可用的有build, jar, javadoc和clean.

　　初始化環(huán)境變量：init

　　所有任務都基于一些基本環(huán)境變量的設置初始化完成，是后續(xù)其他任務的基礎，在環(huán)境初始化過程中，有2點比較可以方便設置：

　　1 除了使用卻缺省的property設置了JAVA源路徑和輸出路徑外，引用了一個外部的build.properties文件中的設置，

　　<property file="${basedir}/build.properties" />
　　這樣大部分簡單配置用戶只要會看懂build.properties就可以了，畢竟XML比起key value的屬性文件還是要可讀性差一些。用build.properties也可以方便其他用戶從編譯的細節(jié)中解放出來。

　　2 CLASSPATH設置：使用了其中的：

　　則相當于設置了：CLASSPATH=/path/to/resin/lib/jsdk23.jar;/path/to/project/lib/*.jar;

　　文件復制：prepare-src

　　創(chuàng)建臨時SRC存放目錄和輸出目錄。

　　編譯任務：build

　　編譯時的CLASSPATH環(huán)境通過一下方式找到引用一個path對象

　　打包任務：jar

　　對應用打包生成項目所寫名的.jar文件

　　生成JAVADOC文檔任務: javadoc