作者:車東 來自:http://blog.csdn.net/legendinfo
內(nèi)容摘要:
ANT是一個基于Java的自動化腳本引擎,腳本格式為XML。除了做Java編譯相關(guān)任務(wù)外,ANT還可以通過插件實現(xiàn)很多應(yīng)用的調(diào)用。
1)ANT的基本概念:
2)ANT的安裝:解包,設(shè)置路徑
3)ANT的使用:最好的學(xué)習(xí)只不過是一個簡單實用的例子起步……
ANT的基本概念:Java的Makefile
當一個代碼項目大了以后,每次重新編譯,打包,測試等都會變得非常復(fù)雜而且重復(fù),因此c語言中有make腳本來幫助這些工作的批量完成。在Java中應(yīng)用是平臺無關(guān)性的,當然不會用平臺相關(guān)的make腳本來完成這些批處理任務(wù)了,ANT本身就是這樣一個流程腳本引擎,用于自動化調(diào)用程序完成項目的編譯,打包,測試等。除了基于JAVA是平臺無關(guān)的外,腳本的格式是基于XML的,比make腳本來說還要好維護一些。
每個ant腳本(缺省叫build.xml)中設(shè)置了一系列任務(wù)(target):比如對于一個一般的項目可能需要有以下任務(wù)。
任務(wù)1:usage 打印本腳本的幫助信息(缺?。?div style="height:15px;">
任務(wù)2:clean <-- init 清空初始化環(huán)境
任務(wù)3:javadoc <-- build <-- init 生成JAVADOC
任務(wù)4:jar <-- build <-- init 生成JAR
任務(wù)5:all <-- jar + javadoc <-- build <-- init 完成以上所有任務(wù):jar javadoc
而多個任務(wù)之間往往又包含了一定了依賴關(guān)系:比如把整個應(yīng)用打包任務(wù)(jar)的這個依賴于編譯任務(wù)(build),而編譯任務(wù)又依賴于整個環(huán)境初始化任務(wù)(init)等。
注:我看到很多項目的ant腳本中的命名基本上都是一致的,比如:編譯一般叫build或者compile;打包一般叫jar或war;生成文檔一般命名為javadoc或javadocs;執(zhí)行全部任務(wù)all。在每個任務(wù)的中,ANT會根據(jù)配置調(diào)用一些外部應(yīng)用并配以相應(yīng)參數(shù)執(zhí)行。雖然ANT可調(diào)用的外部應(yīng)用種類非常豐富,但其實最常用的就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í)行任務(wù),缺省的任務(wù)設(shè)置可以指向最常用的任務(wù),比如:build,或指向打印幫助信息:usage,告訴用戶有那些腳本選項可以使用。
ANT的使用
最好的學(xué)習(xí)過程就是看懂那些open source項目中的build.xml腳本,然后根據(jù)自己的需要簡化成一個更簡單的,ANT和APACHE上很多非常工程派的項目:簡單易用,而且適應(yīng)性非常強,因為這些項目的建立往往來源于開發(fā)人員日常最直接的需求。
以下是的一個WebLucene應(yīng)用的例子:修改自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 -->
缺省任務(wù):usage 打印幫助文檔,告訴有那些任務(wù)選項:可用的有build, jar, javadoc和clean.
初始化環(huán)境變量:init
所有任務(wù)都基于一些基本環(huán)境變量的設(shè)置初始化完成,是后續(xù)其他任務(wù)的基礎(chǔ),在環(huán)境初始化過程中,有2點比較可以方便設(shè)置:
1 除了使用卻缺省的property設(shè)置了JAVA源路徑和輸出路徑外,引用了一個外部的build.properties文件中的設(shè)置,
<property file="${basedir}/build.properties" />
這樣大部分簡單配置用戶只要會看懂build.properties就可以了,畢竟XML比起key value的屬性文件還是要可讀性差一些。用build.properties也可以方便其他用戶從編譯的細節(jié)中解放出來。
2 CLASSPATH設(shè)置:使用了其中的:
<path id="classpath">
<pathelement path="${jsdk_jar}"/>
<fileset dir="${lib.dir}">
<include name="**/*.jar"/>
</fileset>
</path>
則相當于設(shè)置了:CLASSPATH=/path/to/resin/lib/jsdk23.jar;/path/to/project/lib/*.jar;
文件復(fù)制:prepare-src
創(chuàng)建臨時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>
編譯任務(wù):build
編譯時的CLASSPATH環(huán)境通過一下方式找到引用一個path對象
<classpath refid="classpath"/>
打包任務(wù):jar
對應(yīng)用打包生成項目所寫名的.jar文件
<!-- =================================================================== -->
<!-- Creates the class package -->
<!-- =================================================================== -->
<target name="jar" depends="build">
<jar jarfile="${lib.dir}/${name}.jar"
basedir="${build.dest}"
includes="**"/>
</target>
生成JAVADOC文檔任務(wù): 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:
更多任務(wù)/擴展:(樣例)
測試任務(wù):JUnit測試
代碼風(fēng)格檢查任務(wù):CheckStyle,Jalopy等
郵件警報任務(wù):可以把以上這些任務(wù)的輸出警告發(fā)送到制定的用戶列表中,這個任務(wù)可以設(shè)置每天自動運行。