1 Ant是什么? 
Apache Ant 是一個(gè)基于 Java的生成工具。
生成工具在軟件開(kāi)發(fā)中用來(lái)將源代碼和其他輸入文件轉(zhuǎn)換為可執(zhí)行文件的形式(也有可能轉(zhuǎn)換為可安裝的產(chǎn)品映像形式)。隨著應(yīng)用程序的生成過(guò)程變得更加復(fù)雜,確保在每次生成期間都使用精確相同的生成步驟,同時(shí)實(shí)現(xiàn)盡可能多的自動(dòng)化,以便及時(shí)產(chǎn)生一致的生成版本
2 下載、安裝Ant 
安裝Ant
下載.zip文件,解壓縮到c:\ant1.3(后面引用為%ANT_HOME%)

2.1 在你運(yùn)行Ant之前需要做一些配置工作。
? 將bin目錄加入PATH環(huán)境變量。 
? 設(shè)定ANT_HOME環(huán)境變量,指向你安裝Ant的目錄。在一些OS上,Ant的腳本可以猜測(cè)ANT_HOME(Unix和Windos NT/2000)-但最好不要依賴這一特性。 
? 可選地,設(shè)定JAVA_HOME環(huán)境變量(參考下面的高級(jí)小節(jié)),該變量應(yīng)該指向你安裝JDK的目錄。
注意:不要將Ant的ant.jar文件放到JDK/JRE的lib/ext目錄下。Ant是個(gè)應(yīng)用程序,而lib/ext目錄是為JDK擴(kuò)展使用的(如JCE,JSSE擴(kuò)展)。而且通過(guò)擴(kuò)展裝入的類會(huì)有安全方面的限制。
2.2 運(yùn)行Ant 

運(yùn)行Ant非常簡(jiǎn)單,當(dāng)你正確地安裝Ant后,只要輸入ant就可以了。

?  沒(méi)有指定任何參數(shù)時(shí),Ant會(huì)在當(dāng)前目錄下查詢build.xml文件。如果找到了就用該文件作為buildfile。如果你用 -find 選項(xiàng)。 Ant就會(huì)在上級(jí)目錄中尋找buildfile,直至到達(dá)文件系統(tǒng)的根。要想讓Ant使用其他的buildfile,可以用參數(shù) - buildfile file,這里file指定了你想使用的buildfile。

? 可以指定執(zhí)行一個(gè)或多個(gè)target。當(dāng)省略target時(shí),Ant使用標(biāo)簽<project>的default屬性所指定的target。


命令行選項(xiàng)總結(jié):
ant [options] [target [target2 [target3] ...]]
Options:
-help print this message
-projecthelp print project help information
-version print the version information and exit
-quiet be extra quiet
-verbose be extra verbose
-debug print debugging information
-emacs produce logging information without adornments
-logfile file use given file for log output
-logger classname the class that is to perform logging
-listener classname add an instance of class as a project listener
-buildfile file use specified buildfile
-find file search for buildfile towards the root of the filesystem and use the first one found
-Dproperty=value set property to value 
例子
ant
使用當(dāng)前目錄下的build.xml運(yùn)行Ant,執(zhí)行缺省的target。
ant -buildfile test.xml
使用當(dāng)前目錄下的test.xml運(yùn)行Ant,執(zhí)行缺省的target。
ant -buildfile test.xml dist
使用當(dāng)前目錄下的test.xml運(yùn)行Ant,執(zhí)行一個(gè)叫做dist的target。
ant -buildfile test.xml -Dbuild=build/classes dist
使用當(dāng)前目錄下的test.xml運(yùn)行Ant,執(zhí)行一個(gè)叫做dist的target,并設(shè)定build屬性的值為build/classes。

3 編寫build.xml 

Ant的buildfile是用XML寫的。每個(gè)buildfile含有一個(gè)project。

buildfile中每個(gè)task元素可以有一個(gè)id屬性,可以用這個(gè)id值引用指定的任務(wù)。這個(gè)值必須是唯一的。(詳情請(qǐng)參考下面的Task小節(jié))

3.1 Projects

project有下面的屬性:
Attribute Description Required
name 項(xiàng)目名稱. No
default 當(dāng)沒(méi)有指定target時(shí)使用的缺省target Yes
basedir 用于計(jì)算所有其他路徑的基路徑。該屬性可以被basedir property覆蓋。當(dāng)覆蓋時(shí),該屬性被忽略。如果屬性和basedir property都沒(méi)有設(shè)定,就使用buildfile文件的父目錄。 No
項(xiàng)目的描述以一個(gè)頂級(jí)的<description>元素的形式出現(xiàn)(參看description小節(jié))。

一個(gè)項(xiàng)目可以定義一個(gè)或多個(gè)target。一個(gè)target是一系列你想要執(zhí)行的。執(zhí)行Ant時(shí),你可以選擇執(zhí)行那個(gè)target。當(dāng)沒(méi)有給定target時(shí),使用project的default屬性所確定的target。

3.2 Targets

一個(gè)target可以依賴于其他的target。例如,你可能會(huì)有一個(gè)target用于編譯程序,一個(gè)target用于生成可執(zhí)行文件。你在生成可執(zhí)行文件之前必須先編譯通過(guò),所以生成可執(zhí)行文件的target依賴于編譯target。Ant會(huì)處理這種依賴關(guān)系。

然而,應(yīng)當(dāng)注意到,Ant的depends屬性只指定了target應(yīng)該被執(zhí)行的順序-如果被依賴的target無(wú)法運(yùn)行,這種depends對(duì)于指定了依賴關(guān)系的target就沒(méi)有影響。

Ant會(huì)依照depends屬性中target出現(xiàn)的順序(從左到右)依次執(zhí)行每個(gè)target。然而,要記住的是只要某個(gè)target依賴于一個(gè)target,后者就會(huì)被先執(zhí)行。
<target name="A"/>
<target name="B" depends="A"/>
<target name="C" depends="B"/>
<target name="D" depends="C,B,A"/>
假定我們要執(zhí)行target D。從它的依賴屬性來(lái)看,你可能認(rèn)為先執(zhí)行C,然后B,最后A被執(zhí)行。錯(cuò)了,C依賴于B,B依賴于A,所以先執(zhí)行A,然后B,然后C,最后D被執(zhí)行。

一個(gè)target只能被執(zhí)行一次,即時(shí)有多個(gè)target依賴于它(看上面的例子)。

如 果(或如果不)某些屬性被設(shè)定,才執(zhí)行某個(gè)target。這樣,允許根據(jù)系統(tǒng)的狀態(tài)(java version, OS, 命令行屬性定義等等)來(lái)更好地 控制build的過(guò)程。要想讓一個(gè)target這樣做,你就應(yīng)該在target元素中,加入if(或unless)屬性,帶上target因該有所判斷的 屬性。例如:
<target name="build-module-A" if="module-A-present"/>
<target name="build-own-fake-module-A" unless="module-A-present"/>
如果沒(méi)有if或unless屬性,target總會(huì)被執(zhí)行。

可選的description屬性可用來(lái)提供關(guān)于target的一行描述,這些描述可由-projecthelp命令行選項(xiàng)輸出。

將你的tstamp task在一個(gè)所謂的初始化target是很好的做法,其他的target依賴這個(gè)初始化target。要確保初始化target是出現(xiàn)在其他target依賴表中的第一個(gè)target。在本手冊(cè)中大多數(shù)的初始化target的名字是"init"。

target有下面的屬性:
Attribute Description Required
name target的名字 Yes
depends 用逗號(hào)分隔的target的名字列表,也就是依賴表。 No
if 執(zhí)行target所需要設(shè)定的屬性名。 No
unless 執(zhí)行target需要清除設(shè)定的屬性名。 No
description 關(guān)于target功能的簡(jiǎn)短描述。 No

3.3 Tasks

一個(gè)task是一段可執(zhí)行的代碼。

一個(gè)task可以有多個(gè)屬性(如果你愿意的話,可以將其稱之為變量)。屬性只可能包含對(duì)property的引用。這些引用會(huì)在task執(zhí)行前被解析。

下面是Task的一般構(gòu)造形式:
<name attribute1="value1" attribute2="value2" ... />
這里name是task的名字,attributeN是屬性名,valueN是屬性值。

有一套內(nèi)置的(built-in)task,以及一些可選task,但你也可以編寫自己的task。

所有的task都有一個(gè)task名字屬性。Ant用屬性值來(lái)產(chǎn)生日志信息。

可以給task賦一個(gè)id屬性:
<taskname id="taskID" ... />
這里taskname是task的名字,而taskID是這個(gè)task的唯一標(biāo)識(shí)符。通過(guò)這個(gè)標(biāo)識(shí)符,你可以在腳本中引用相應(yīng)的task。例如,在腳本中你可以這樣:
<script ... >
task1.setFoo("bar");
</script>
設(shè)定某個(gè)task實(shí)例的foo屬性。在另一個(gè)task中(用java編寫),你可以利用下面的語(yǔ)句存取相應(yīng)的實(shí)例。
project.getReference("task1").
注意1:如果task1還沒(méi)有運(yùn)行,就不會(huì)被生效(例如:不設(shè)定屬性),如果你在隨后配置它,你所作的一切都會(huì)被覆蓋。

注意2:未來(lái)的Ant版本可能不會(huì)兼容這里所提的屬性,因?yàn)楹苡锌赡芨緵](méi)有task實(shí)例,只有proxies。

3.4 Properties

一 個(gè)project可以有很多的properties??梢栽赽uildfile中用property task來(lái)設(shè)定,或在Ant之外設(shè)定。一個(gè) property有一個(gè)名字和一個(gè)值。property可用于task的屬性值。這是通過(guò)將屬性名放在"${"和"}"之間并放在屬性值的位置來(lái)實(shí)現(xiàn)的。 例如如果有一個(gè)property builddir的值是"build",這個(gè)property就可用于屬性值:${builddir} /classes。這個(gè)值就可被解析為build/classes。

內(nèi)置屬性

如果你使用了<property> task 定義了所有的系統(tǒng)屬性,Ant允許你使用這些屬性。例如,${os.name}對(duì)應(yīng)操作系統(tǒng)的名字。

要想得到系統(tǒng)屬性的列表可參考the Javadoc of System.getProperties。

除了Java的系統(tǒng)屬性,Ant還定義了一些自己的內(nèi)置屬性: 
basedir project基目錄的絕對(duì)路徑 (與<project>的basedir屬性一樣)。
ant.file buildfile的絕對(duì)路徑。
ant.version Ant的版本。
ant.project.name 當(dāng)前執(zhí)行的project的名字;由<project>的name屬性設(shè)定.
ant.java.version Ant檢測(cè)到的JVM的版本; 目前的值有"1.1", "1.2", "1.3" and "1.4".

例子
<project name="MyProject" default="dist" basedir="."> 

<!-- set global properties for this build -->
<property name="src" value="."/>
<property name="build" value="build"/>
<property name="dist" value="dist"/> 

<target name="init">
<!-- Create the time stamp -->
<tstamp/>
<!-- Create the build directory structure used by compile -->
<mkdir dir="${build}"/>
</target>

<target name="compile" depends="init">
<!-- Compile the java code from ${src} into ${build} -->
<javac srcdir="${src}" destdir="${build}"/>
</target>

<target name="dist" depends="compile">
<!-- Create the distribution directory -->
<mkdir dir="${dist}/lib"/>
<!-- Put everything in ${build} into the MyProject-${DSTAMP}.jar file -->
<jar jarfile="${dist}/lib/MyProject-${DSTAMP}.jar" basedir="${build}"/>
</target>

<target name="clean">
<!-- Delete the ${build} and ${dist} directory trees -->
<delete dir="${build}"/>
<delete dir="${dist}"/>
</target>

</project>
3.5 Path-like Structures
你可以用":"和";"作為分隔符,指定類似PATH和CLASSPATH的引用。Ant會(huì)把分隔符轉(zhuǎn)換為當(dāng)前系統(tǒng)所用的分隔符。

當(dāng)需要指定類似路徑的值時(shí),可以使用嵌套元素。一般的形式是
<classpath>
<pathelement path="${classpath}"/>
<pathelement location="lib/helper.jar"/>
</classpath>
location屬性指定了相對(duì)于project基目錄的一個(gè)文件和目錄,而path屬性接受逗號(hào)或分號(hào)分隔的一個(gè)位置列表。path屬性一般用作預(yù)定義的路徑--其他情況下,應(yīng)該用多個(gè)location屬性。

為簡(jiǎn)潔起見(jiàn),classpath標(biāo)簽支持自己的path和location屬性。所以:
<classpath>
<pathelement path="${classpath}"/>
</classpath>
可以被簡(jiǎn)寫作:
<classpath path="${classpath}"/>
也可通過(guò)<fileset>元素指定路徑。構(gòu)成一個(gè)fileset的多個(gè)文件加入path-like structure的順序是未定的。
<classpath>
<pathelement path="${classpath}"/>
<fileset dir="lib">
<include name="**/*.jar"/>
</fileset>
<pathelement location="classes"/>
</classpath>
上面的例子構(gòu)造了一個(gè)路徑值包括:${classpath}的路徑,跟著lib目錄下的所有jar文件,接著是classes目錄。

如果你想在多個(gè)task中使用相同的path-like structure,你可以用<path>元素定義他們(與target同級(jí)),然后通過(guò)id屬性引用--參考Referencs例子。

path-like structure可能包括對(duì)另一個(gè)path-like structurede的引用(通過(guò)嵌套<path>元素):
<path id="base.path">
<pathelement path="${classpath}"/>
<fileset dir="lib">
<include name="**/*.jar"/>
</fileset>
<pathelement location="classes"/>
</path>
<path id="tests.path">
<path refid="base.path"/>
<pathelement location="testclasses"/>
</path>
前面所提的關(guān)于<classpath>的簡(jiǎn)潔寫法對(duì)于<path>也是有效的,如:
<path id="tests.path">
<path refid="base.path"/>
<pathelement location="testclasses"/>
</path>
可寫成:
<path id="base.path" path="${classpath}"/>
命令行變量

有些task可接受參數(shù),并將其傳遞給另一個(gè)進(jìn)程。為了能在變量中包含空格字符,可使用嵌套的arg元素。
Attribute Description Required
value 一個(gè)命令行變量;可包含空格字符。 只能用一個(gè)
line 空格分隔的命令行變量列表。 
file 作為命令行變量的文件名;會(huì)被文件的絕對(duì)名替代。 
path 一個(gè)作為單個(gè)命令行變量的path-like的字符串;或作為分隔符,Ant會(huì)將其轉(zhuǎn)變?yōu)樘囟ㄆ脚_(tái)的分隔符。 

例子
<arg value="-l -a"/>
是一個(gè)含有空格的單個(gè)的命令行變量。
<arg line="-l -a"/>
是兩個(gè)空格分隔的命令行變量。
<arg path="/dir;/dir2:\dir3"/>
是一個(gè)命令行變量,其值在DOS系統(tǒng)上為\dir;\dir2;\dir3;在Unix系統(tǒng)上為/dir:/dir2:/dir3 。

References

buildfile元素的id屬性可用來(lái)引用這些元素。如果你需要一遍遍的復(fù)制相同的XML代碼塊,這一屬性就很有用--如多次使用<classpath>結(jié)構(gòu)。

下面的例子:
<project ... >
<target ... > 
<rmic ...> 
<classpath> 
<pathelement location="lib/"/> 
<pathelement path="${java.class.path}/"/> 
<pathelement path="${additional.path}"/> 
</classpath> 
</rmic> 
</target>
<target ... >
<javac ...>
<classpath>
<pathelement location="lib/"/>
<pathelement path="${java.class.path}/"/>
<pathelement path="${additional.path}"/>
</classpath>
</javac>
</target>
</project>
可以寫成如下形式:
<project ... > 
<path id="project.class.path"> 
<pathelement location="lib/"/>
<pathelement path="${java.class.path}/"/> 
<pathelement path="${additional.path}"/> 
</path>
<target ... >
<rmic ...>
<classpath refid="project.class.path"/>
</rmic>
</target>
<target ... > 
<javac ...>
<classpath refid="project.class.path"/>
</javac>
</target>
</project>
所有使用PatternSets, FileSets 或 path-like structures嵌套元素的task也接受這種類型的引用。
 
 
 
4.1 File(Directory)類
4.1.1 Mkdir
? 創(chuàng)建一個(gè)目錄,如果他的父目錄不存在,也會(huì)被同時(shí)創(chuàng)建。
? 例子:
<mkdir dir="build/classes"/>
? 說(shuō)明: 如果build不存在,也會(huì)被同時(shí)創(chuàng)建
4.1.2 Copy
? 拷貝一個(gè)(組)文件、目錄
? 例子:
1. 拷貝單個(gè)的文件: 
<copy file="myfile.txt" tofile="mycopy.txt"/>
2. 拷貝單個(gè)的文件到指定目錄下
<copy file="myfile.txt" todir="../some/other/dir"/>
3. 拷貝一個(gè)目錄到另外一個(gè)目錄下
<copy todir="../new/dir">
<fileset dir="src_dir"/>
</copy>
4. 拷貝一批文件到指定目錄下
<copy todir="../dest/dir">
<fileset dir="src_dir">
<exclude name="**/*.java"/>
</fileset>
</copy>

<copy todir="../dest/dir">
<fileset dir="src_dir" excludes="**/*.java"/>
</copy>
5. 拷貝一批文件到指定目錄下,將文件名后增加。Bak后綴
<copy todir="../backup/dir">
<fileset dir="src_dir"/>
<mapper type="glob" from="*" to="*.bak"/>
</copy>
6. 拷貝一組文件到指定目錄下,替換其中的@標(biāo)簽@內(nèi)容
<copy todir="../backup/dir">
<fileset dir="src_dir"/>
<filterset>
<filter token="TITLE" value="Foo Bar"/>
</filterset>
</copy>
4.1.3 Delete
? 刪除一個(gè)(組)文件或者目錄
? 例子
1. 刪除一個(gè)文件
<delete file="/lib/ant.jar"/>
2. 刪除指定目錄及其子目錄
<delete dir="lib"/>
3. 刪除指定的一組文件
<delete>
<fileset dir="." includes="**/*.bak"/>
</delete>
4. 刪除指定目錄及其子目錄,包括他自己
<delete includeEmptyDirs="true">
<fileset dir="build"/>
</delete>
4.1.4 Move
? 移動(dòng)或重命名一個(gè)(組)文件、目錄
? 例子:
1. 移動(dòng)或重命名一個(gè)文件
<move file="file.orig" tofile="file.moved"/>
2. 移動(dòng)或重命名一個(gè)文件到另一個(gè)文件夾下面
<move file="file.orig" todir="dir/to/move/to"/>
3. 將一個(gè)目錄移到另外一個(gè)目錄下
<move todir="new/dir/to/move/to">
<fileset dir="src/dir"/>
</move>
4. 將一組文件移動(dòng)到另外的目錄下
<move todir="some/new/dir">
<fileset dir="my/src/dir">
<include name="**/*.jar"/>
<exclude name="**/ant.jar"/>
</fileset>
</move>
5. 移動(dòng)文件過(guò)程中增加。Bak后綴
<move todir="my/src/dir">
<fileset dir="my/src/dir">
<exclude name="**/*.bak"/>
</fileset>
<mapper type="glob" from="*" to="*.bak"/>
</move>


 

4.2 Java相關(guān)
4.2.1 Javac
? 編譯java原代碼
? 例子
1. <javac srcdir="${src}"
destdir="${build}"
classpath="xyz.jar"
debug="on"
/>
編譯${src}目錄及其子目錄下的所有。Java文件,。Class文件將放在${build}指定的目錄下,classpath表示需要用到的類文件或者目錄,debug設(shè)置為on表示輸出debug信息
2. <javac srcdir="${src}:${src2}"
destdir="${build}"
includes="mypackage/p1/**,mypackage/p2/**"
excludes="mypackage/p1/testpackage/**"
classpath="xyz.jar"
debug="on"
/>
編 譯${src}和${src2}目錄及其子目錄下的所有。Java文件,但是package/p1/**,mypackage/p2/**將被編譯,而 mypackage/p1/testpackage/**將不會(huì)被編譯。Class文件將放在${build}指定的目錄下,classpath表示需要 用到的類文件或者目錄,debug設(shè)置為on表示輸出debug信息
3. <property name="classpath" value=".;./xml-apis.jar;../lib/xbean.jar;./easypo.jar"/>

<javac srcdir="${src}"
destdir="${src}"
classpath="${classpath}"
debug="on"
/>
路徑是在property中定義的
4.2.2 java
? 執(zhí)行指定的java類
? 例子:
1. <java classname="test.Main">
<classpath>
<pathelement location="dist/test.jar"/>
<pathelement path="${java.class.path}"/>
</classpath>
</java>
classname中指定要執(zhí)行的類,classpath設(shè)定要使用的環(huán)境變量
2. <path id="project.class.path">
<pathelement location="lib/"/>
<pathelement path="${java.class.path}/"/>
<pathelement path="${additional.path}"/>
</path>

<target ... >
<rmic ...>
<classpath refid="project.class.path"/>
</rmic>
</target>


 


4.3 打包相關(guān)
4.3.1 jar
? 將一組文件打包
? 例子:
1. <jar destfile="${dist}/lib/app.jar" basedir="${build}/classes"/>
將${build}/classes下面的所有文件打包到${dist}/lib/app.jar中
2. <jar destfile="${dist}/lib/app.jar"
basedir="${build}/classes"
includes="mypackage/test/**"
excludes="**/Test.class"
/>
將${build}/classes下面的所有文件打包到${dist}/lib/app.jar中,但是包括mypackage/test/所有文件不包括所有的Test.class
3. <jar destfile="${dist}/lib/app.jar"
basedir="${build}/classes"
includes="mypackage/test/**"
excludes="**/Test.class"
manifest=”my.mf”
/>
manifest屬性指定自己的META-INF/MANIFEST.MF文件,而不是由系統(tǒng)生成
4.3.2 war
? 對(duì)Jar的擴(kuò)展,用于打包Web應(yīng)用
? 例子:
? 假設(shè)我們的文件目錄如下:
thirdparty/libs/jdbc1.jar
thirdparty/libs/jdbc2.jar
build/main/com/myco/myapp/Servlet.class
src/metadata/myapp.xml
src/html/myapp/index.html
src/jsp/myapp/front.jsp
src/graphics/images/gifs/small/logo.gif
src/graphics/images/gifs/large/logo.gif
? 下面是我們的任務(wù)的內(nèi)容: 
<war destfile="myapp.war" webxml="src/metadata/myapp.xml">
<fileset dir="src/html/myapp"/>
<fileset dir="src/jsp/myapp"/>
<lib dir="thirdparty/libs">
<exclude name="jdbc1.jar"/>
</lib>
<classes dir="build/main"/>
<zipfileset dir="src/graphics/images/gifs" 
prefix="images"/>
</war>
? 完成后的結(jié)果:
WEB-INF/web.xml
WEB-INF/lib/jdbc2.jar
WEB-INF/classes/com/myco/myapp/Servlet.class
META-INF/MANIFEST.MF
index.html
front.jsp
images/small/logo.gif
images/large/logo.gif
4.3.3 ear
? 用于打包企業(yè)應(yīng)用
? 例子
<ear destfile="${build.dir}/myapp.ear" appxml="${src.dir}/metadata/application.xml">
<fileset dir="${build.dir}" includes="*.jar,*.war"/>
</ear>
 
 

4.4 時(shí)間戳
在生成環(huán)境中使用當(dāng)前時(shí)間和日期,以某種方式標(biāo)記某個(gè)生成任務(wù)的輸出,以便記錄它是何時(shí)生成的,這經(jīng)常是可取的。這可能涉及編輯一個(gè)文件,以便插入一個(gè)字符串來(lái)指定日期和時(shí)間,或?qū)⑦@個(gè)信息合并到 JAR 或 zip 文件的文件名中。
這種需要是通過(guò)簡(jiǎn)單但是非常有用的 tstamp 任務(wù)來(lái)解決的。這個(gè)任務(wù)通常在某次生成過(guò)程開(kāi)始時(shí)調(diào)用,比如在一個(gè) init 目標(biāo)中。這個(gè)任務(wù)不需要屬性,許多情況下只需 <tstamp/> 就足夠了。
tstamp 不產(chǎn)生任何輸出;相反,它根據(jù)當(dāng)前系統(tǒng)時(shí)間和日期設(shè)置 Ant 屬性。下面是 tstamp 設(shè)置的一些屬性、對(duì)每個(gè)屬性的說(shuō)明,以及這些屬性可被設(shè)置到的值的例子:
屬性 說(shuō)明 例子 
DSTAMP 設(shè)置為當(dāng)前日期,默認(rèn)格式為yyyymmdd 20031217
TSTAMP 設(shè)置為當(dāng)前時(shí)間,默認(rèn)格式為 hhmm 1603
TODAY 設(shè)置為當(dāng)前日期,帶完整的月份 2003 年 12 月 17 日
例如,在前一小節(jié)中,我們按如下方式創(chuàng)建了一個(gè) JAR 文件:

<jar destfile="package.jar" basedir="classes"/>

在調(diào)用 tstamp 任務(wù)之后,我們能夠根據(jù)日期命名該 JAR 文件,如下所示:

<jar destfile="package-${DSTAMP}.jar" basedir="classes"/>

因此,如果這個(gè)任務(wù)在 2003 年 12 月 17 日調(diào)用,該 JAR 文件將被命名為 package-20031217.jar。
還可以配置 tstamp 任務(wù)來(lái)設(shè)置不同的屬性,應(yīng)用一個(gè)當(dāng)前時(shí)間之前或之后的時(shí)間偏移,或以不同的方式格式化該字符串。所有這些都是使用一個(gè)嵌套的 format 元素來(lái)完成的,如下所示:

<tstamp>
<format property="OFFSET_TIME"
pattern="HH:mm:ss"
offset="10" unit="minute"/>
</tstamp>

上面的清單將 OFFSET_TIME 屬性設(shè)置為距離當(dāng)前時(shí)間 10 分鐘之后的小時(shí)數(shù)、分鐘數(shù)和秒數(shù)。
用于定義格式字符串的字符與 java.text.SimpleDateFormat 類所定義的那些格式字符相同
 
 

4.5 執(zhí)行SQL語(yǔ)句
? 通過(guò)jdbc執(zhí)行SQL語(yǔ)句
? 例子:
1. <sql
driver="org.gjt.mm.mysql.Driver"
url="jdbc:mysql://localhost:3306/mydb"
userid="root"
password="root"
src="data.sql"
/>
2. <sql
driver="org.database.jdbcDriver"
url="jdbc:database-url"
userid="sa"
password="pass"
src="data.sql"
rdbms="oracle"
version="8.1."
>
</sql>
只有在oracle、版本是8.1的時(shí)候才執(zhí)行
 
 
 
4.6 發(fā)送郵件
? 使用SMTP服務(wù)器發(fā)送郵件
? 例子:
<mail mailhost="smtp.myisp.com" mailport="1025" subject="Test build">
<from address="me@myisp.com"/>
<to address="all@xyz.com"/>
<message>The ${buildname} nightly build has completed</message>
<fileset dir="dist">
<includes name="**/*.zip"/>
</fileset>
</mail>
? mailhost: SMTP服務(wù)器地址
? mailport: 服務(wù)器端口
? subject: 主題
? from: 發(fā)送人地址
? to: 接受人地址
? message: 發(fā)送的消息
? fileset: 設(shè)置附件

====================================================================
 

在ANT 出現(xiàn)之前,編譯和部署Java應(yīng)用需要使用包括特定平臺(tái)的腳本、Make文件、不同的IDE以及手工操作等組成的大雜燴?,F(xiàn)在,幾乎所有的開(kāi)源Java項(xiàng) 目都在使用Ant,許多公司的開(kāi)發(fā)項(xiàng)目也在使用Ant。Ant的大量使用,也自然帶來(lái)了對(duì)總結(jié)Ant最佳實(shí)踐的迫切需求。 

本文總結(jié)了我 喜好的Ant最佳實(shí)踐,很多是從親身經(jīng)歷的項(xiàng)目錯(cuò)誤,或從其他開(kāi)發(fā)者的“恐怖”故事中得到的靈感的。比如,有人告訴我有個(gè)項(xiàng)目將 XDoclet 生成的 代碼放入鎖定文件的版本控制工具中。單開(kāi)發(fā)者修改源代碼時(shí),他必須記住手工檢出(Check out)并鎖定所有將要重生成的文件。然后,手工運(yùn)行代碼生 成器,當(dāng)他能夠讓Ant編譯代碼時(shí),這一方法還存在一些問(wèn)題: 


生成的代碼無(wú)法存儲(chǔ)在版本控制系統(tǒng)中 


Ant(本案例中是Xdoclet)應(yīng)該自動(dòng)確定下一次構(gòu)建涉及的源文件,而不應(yīng)由程序員人工確定。 


Ant的構(gòu)建文件應(yīng)該定義好正確的任務(wù)依賴關(guān)系,這樣程序員不必按照特定順序調(diào)用任務(wù)。 

當(dāng)我開(kāi)始一個(gè)新項(xiàng)目時(shí),我首先編寫Ant構(gòu)建文件。文件定義構(gòu)建的過(guò)程,并為團(tuán)隊(duì)中的每個(gè)程序員都使用。本文所有的最佳實(shí)踐假設(shè)Ant構(gòu)建文件是一個(gè)必須精心編寫的重要文件,它應(yīng)在版本控制系統(tǒng)中得到維護(hù),并定期進(jìn)行重構(gòu)。下面是我的十五大Ant最佳實(shí)踐。 

1. 采用一致的編碼規(guī)范 

Ant用戶不管是喜歡還是痛恨XML構(gòu)建文件的語(yǔ)法,都愿意跳進(jìn)這一迷人的爭(zhēng)論中。讓我們先看一些保持XML構(gòu)建文件簡(jiǎn)潔的方法。 

首 先,也是最重要的,化費(fèi)時(shí)間格式化你的XML讓它看上去很清晰。不過(guò)XML是否美觀,Ant都可以工作。但是丑陋的XML很難讀懂。倘若你在任務(wù)之間留出 空行,有規(guī)則的縮進(jìn),每行文字不超過(guò)90列,那么XML令人驚訝的易讀。再加上好的編輯器或IDE高亮相應(yīng)的語(yǔ)句,你就不會(huì)有如何閱讀的麻煩。同樣,精選 有意義明確、容易讀懂的詞匯來(lái)命名任務(wù)和屬性。比如,dir.reports就比rpts好。并不需要特定的編碼規(guī)范,只要有一種規(guī)范并堅(jiān)持使用就好。 

2. 將build.xml 放在項(xiàng)目根目錄中 

Ant構(gòu)建文件build.xml可以放在如何位置,但是放在項(xiàng)目頂層目錄中可以保持項(xiàng)目簡(jiǎn)潔。這是最普遍的規(guī)范,使開(kāi)發(fā)者能夠在根目錄找到它。同時(shí),也能夠容易了解項(xiàng)目中不同目錄之間的邏輯關(guān)系。以下是一個(gè)典型的項(xiàng)目層次: 



[root dir]  | build.xml  +--src  +--lib (包含第三方 JAR包)  +--build (由 build任務(wù)生成)  +--dist (由 build任務(wù)生成)

當(dāng)build.xml在頂級(jí)目錄時(shí),倘若你在項(xiàng)目某個(gè)子目錄中,只要輸入:ant -find compile 命令,不需要改變工作目錄就能夠以命令行方式編譯代碼。參數(shù)-find告訴Ant尋找存在于上級(jí)目錄中的build.xml并執(zhí)行。 

3. 使用單一構(gòu)建文件 

有人喜歡將一個(gè)大項(xiàng)目分解到幾個(gè)小的構(gòu)建文件,每個(gè)構(gòu)建文件分擔(dān)整個(gè)構(gòu)建過(guò)程的一小部分工作。但是應(yīng)該認(rèn)識(shí)到,將構(gòu)建文件分割會(huì)增加對(duì)整個(gè)構(gòu)建過(guò)程的理解難度。要注意在單一構(gòu)建文件能夠清楚表現(xiàn)構(gòu)建層次的情況下,不要過(guò)工程化(over-engineer)。 

即使你把項(xiàng)目劃分為多個(gè)構(gòu)建文件,也應(yīng)使程序員能夠在項(xiàng)目根目錄下找到核心build.xml。盡管該文件只是將實(shí)際構(gòu)建工作委派給下級(jí)構(gòu)建文件,也應(yīng)保證該文件可用。 

4. 提供良好的幫助說(shuō)明 

應(yīng)盡量使構(gòu)建文件自文檔化。增加任務(wù)描述是最簡(jiǎn)單的方法。當(dāng)你輸入ant -projecthelp時(shí),你就可以看到帶有描述的任務(wù)清單。比如,你可以這樣定義任務(wù): 


<target name="compile"   description="Compiles code, output goes to the build dir.">

最簡(jiǎn)單的規(guī)則是對(duì)所有你希望程序員通過(guò)命令行直接調(diào)用的任務(wù)都加上描述。對(duì)于一般用來(lái)執(zhí)行中間處理過(guò)程的內(nèi)部任務(wù),比如生成代碼或建立輸出目錄等,就無(wú)法使用描述屬性。 

這時(shí),可以通過(guò)在構(gòu)建文件中加入XML注釋來(lái)處理?;蛘邔iT定義一個(gè)help任務(wù),當(dāng)程序員輸入ant help時(shí)來(lái)顯示詳細(xì)的使用說(shuō)明。 

<target name="help"         description="Display detailed usage information">  <echo>Detailed help...</echo></target>

5. 提供清空任務(wù) 

每個(gè)構(gòu)建文件都應(yīng)包含一個(gè)清空任務(wù),刪除所有生成的文件和目錄,使系統(tǒng)回到構(gòu)建文件執(zhí)行前的初始狀態(tài)。執(zhí)行清空任務(wù)后還存在的文件應(yīng)處在版本控制系統(tǒng)的管理下。 

比如: 


<target name="clean"     description="Destroys all generated files and dirs.">  <delete dir="${dir.build}"/>  <delete dir="${dir.dist}"/></target> 

除非是在產(chǎn)生整個(gè)系統(tǒng)版本的特殊任務(wù)中,否則不要自動(dòng)調(diào)用clean任務(wù)。當(dāng)程序員僅僅執(zhí)行編譯任務(wù)或其他任務(wù)時(shí),他們不需要構(gòu)建文件事先執(zhí)行即令人討厭有沒(méi)有必要的清空任務(wù)。要相信程序員能夠確定何時(shí)需要清空所有文件。 

6. 使用ANT管理任務(wù)從屬關(guān)系 

假 設(shè)你的應(yīng)用由Swing GUI組件、Web界面、EJB層和公共應(yīng)用代碼組成。在大型系統(tǒng)中,你需要清晰地定義Java包屬于系統(tǒng)的哪一層。否則如何一 點(diǎn)修改都要重新編譯成千上百個(gè)文件。任務(wù)從屬關(guān)系管理差會(huì)導(dǎo)致過(guò)度復(fù)雜而脆弱的系統(tǒng)。改變GUI面板的設(shè)計(jì)不應(yīng)造成Servlet和EJB的重編譯。 

當(dāng)系統(tǒng)變得龐大后,稍不注意就可能將依賴于客戶端的代碼引入到服務(wù)端。這是因?yàn)镮DE在編譯文件時(shí)使用單一的classpath。Ant讓你更有效地控制構(gòu)建活動(dòng)。 

設(shè)計(jì)你的構(gòu)建文件編譯大型項(xiàng)目的步驟:首先,編譯公共應(yīng)用代碼,將編譯結(jié)果打成JAR包文件。然后,編譯上一層的項(xiàng)目代碼,編譯時(shí)依靠第一步產(chǎn)生的JAR文件。不斷重復(fù)這一過(guò)程,直到最高層的代碼編譯完成。 

分步構(gòu)建強(qiáng)化了任務(wù)從屬關(guān)系管理。如果你工作在底層Java框架上,引用高層的GUI模板組件,這時(shí)代碼不需要編譯。這是由于構(gòu)建文件在編譯底層框架時(shí),在源路徑中沒(méi)有包含高層GUI面板組件的代碼。 

7. 定義并重用文件路徑 

如果文件路徑在一個(gè)地方集中定義,并在整個(gè)構(gòu)建文件中得到重用,那么構(gòu)建文件更易于理解。以下是這樣做的一個(gè)例子: 


<project name="sample" default="compile" basedir=".">  <path id="classpath.common">    <pathelement location="${jdom.jar.withpath}"/>    ...etc  </path>  <path id="classpath.client">    <pathelement location="${guistuff.jar.withpath}"/>    <pathelement location="${another.jar.withpath}"/>    <!-- reuse the common classpath -->    <path refid="classpath.common"/>  </path>  <target name="compile.common" depends="prepare">    <javac destdir="${dir.build}" srcdir="${dir.src}">          <classpath refid="classpath.common"/>          <include name="com/oreilly/common/**"/>    </javac>  </target></project>

當(dāng) 項(xiàng)目不斷增長(zhǎng),構(gòu)建日益復(fù)雜時(shí),這一技術(shù)越發(fā)體現(xiàn)出其價(jià)值。你可能為編譯不同層次的應(yīng)用定義各自的文件路徑,比如運(yùn)行單元測(cè)試的、運(yùn)行應(yīng)用程序的、運(yùn)行 Xdoclet的、生成JavaDocs的等等不同路徑。這種組件化路徑定義的方法比為每個(gè)任務(wù)單獨(dú)定義路徑要優(yōu)越得多。否則,很容易丟失任務(wù)任務(wù)從屬關(guān) 系的軌跡。 

8. 定義恰當(dāng)?shù)娜蝿?wù)參數(shù)關(guān)系 

假設(shè)dist任務(wù)從屬于jar任務(wù),那么哪個(gè)任務(wù)從屬于compile任 務(wù),哪個(gè)任務(wù)從屬于prepare任務(wù)呢?Ant構(gòu)建文件最終定義了任務(wù)的從屬關(guān)系圖,它必須被仔細(xì)地定義和維護(hù)。應(yīng)該定期檢查任務(wù)的從屬關(guān)系以保證構(gòu)建 工作得到正確執(zhí)行。大的構(gòu)建文件隨著時(shí)間推移趨向于增加更多的任務(wù),所以到最后由于不必要的從屬關(guān)系導(dǎo)致構(gòu)建工作非常困難。比如,你可能發(fā)現(xiàn)在程序員只是 需要編譯一些沒(méi)有使用EJB的GUI代碼時(shí),重新生成EJB代碼。 

以“優(yōu)化”的名義忽略任務(wù)的從屬關(guān)系是另一種常見(jiàn)的錯(cuò)誤。這種錯(cuò)誤迫 使程序員為了得到恰當(dāng)?shù)慕Y(jié)果必須記住并按照特定的順序調(diào)用一串任務(wù)。更好的做法是:提供描述清晰的公共任務(wù),這些任務(wù)包含正確的任務(wù)從屬關(guān)系;另外提供一 套“專家”任務(wù)讓你能夠手工執(zhí)行個(gè)別的構(gòu)建步驟,這些任務(wù)不提供完整的構(gòu)建過(guò)程,但是讓那些專家在快速而惱人的編碼期間跳過(guò)某些步驟 

9.使用配置屬性 

任何需要配置或可能發(fā)生變化的信息都應(yīng)作為Ant屬性定義下來(lái)。對(duì)于在構(gòu)建文件中多次出現(xiàn)的值也同樣處理。屬性既可以在構(gòu)建文件頭部定義,也可以為了更好的靈活性而在單獨(dú)的屬性文件中定義。以下是在構(gòu)建文件中定義屬性的樣式: 


<project name="sample" default="compile" basedir=".">  <property name="dir.build" value="build"/>  <property name="dir.src" value="src"/>  <property name="jdom.home" value="../java-tools/jdom-b8"/>  <property name="jdom.jar" value="jdom.jar"/>  <property name="jdom.jar.withpath"                     value="${jdom.home}/build/${jdom.jar}"/>    etc...</project>

或者你可以使用屬性文件: 


<project name="sample" default="compile" basedir=".">  <property file="sample.properties"/>   etc...</project>

在屬性文件 sample.properties中: 


dir.build=builddir.src=srcjdom.home=../java-tools/jdom-b8jdom.jar=jdom.jarjdom.jar.withpath=${jdom.home}/build/${jdom.jar}

用一個(gè)獨(dú)立的文件定義屬性是有好處的,它可以清晰地定義構(gòu)建中的可配置部分。另外,在開(kāi)發(fā)者工作在不同操作系統(tǒng)的情況下,你可以在不同的平臺(tái)上提供該文件的不同版本。 

10. 保持構(gòu)建過(guò)程獨(dú)立 

為 了最大限度的擴(kuò)展性,不要應(yīng)用外部路徑和庫(kù)文件。最重要的是不要依賴于程序員的CLASSPATH設(shè)置。取而代之的是,在構(gòu)建文件中使用相對(duì)路徑并定義自 己的路徑。如果你引用了絕對(duì)路徑如C:\java\tools,其他開(kāi)發(fā)者未必使用與你相同的目錄結(jié)構(gòu),所以就無(wú)法使用你的構(gòu)建文件 

如果你部署開(kāi)發(fā)源碼項(xiàng)目,應(yīng)該提供包括所有需要的JAR文件的發(fā)行版本,當(dāng)然是在遵守許可協(xié)議的基礎(chǔ)上。對(duì)于內(nèi)部項(xiàng)目,相關(guān)的JAR文件都應(yīng)在版本控制系統(tǒng)的管理中,并撿出到大家都知道的位置。 

當(dāng)你不得不應(yīng)用外部路徑時(shí),應(yīng)將路徑定義為屬性。使程序員能夠涌適合他們自己的機(jī)器的參數(shù)重載這些屬性。你也可以使用以下語(yǔ)法引用環(huán)境變量: 


<property environment="env"/><property name="dir.jboss" value="${env.JBOSS_HOME}"/>

11. 使用版本控制系統(tǒng) 

構(gòu)建文件是一個(gè)重要的文件,應(yīng)該象代碼一樣進(jìn)行版本控制。當(dāng)你標(biāo)記你的代碼時(shí),也應(yīng)用同樣的標(biāo)簽標(biāo)記構(gòu)建文件。這樣當(dāng)你需要回溯構(gòu)建舊版本的軟件時(shí),能夠使用相對(duì)應(yīng)的舊版本構(gòu)建文件。 

除構(gòu)建文件之外,你還應(yīng)在版本控制中維護(hù)第三方JAR文件。同樣,這使你能夠重新構(gòu)建舊版本的軟件。這也能夠更容易保證所有開(kāi)發(fā)者擁有一致的JAR文件,因?yàn)樗麄兌际峭瑯?gòu)建文件一起從版本控制系統(tǒng)中撿出的。 

通常應(yīng)避免在版本控制系統(tǒng)中存放構(gòu)建輸出品。倘若你的源代碼很好地得到了版本控制,那么通過(guò)構(gòu)建過(guò)程你能夠重新生成任何版本的產(chǎn)品。 

12. 把Ant作為“最小公分母” 

假設(shè)你的開(kāi)發(fā)團(tuán)隊(duì)使用IDE,為什么要為程序員通過(guò)點(diǎn)擊圖標(biāo)就能夠構(gòu)建整個(gè)應(yīng)用而煩惱呢? 

IDE 的問(wèn)題在團(tuán)隊(duì)中是一個(gè)關(guān)于一致性和重現(xiàn)性的問(wèn)題。幾乎所有的IDE設(shè)計(jì)初衷都是為了提高程序員的個(gè)人生產(chǎn)率,而不是開(kāi)發(fā)團(tuán)隊(duì)的持續(xù)構(gòu)建。典型的IDE要求 每個(gè)程序員定義自己的項(xiàng)目文件。程序員可能擁有不同的目錄結(jié)構(gòu),可能使用不同版本的庫(kù)文件,還可能工作在不同的平臺(tái)上。這將導(dǎo)致出現(xiàn)這種情況:在A那里運(yùn) 行良好的代碼,到B那里就無(wú)法運(yùn)行。 

不管你的開(kāi)發(fā)團(tuán)隊(duì)使用何種IDE,一定要建立所有程序員都能夠使用的Ant構(gòu)建文件。要建立一個(gè)程 序員在將新代碼提交版本控制系統(tǒng)前必須執(zhí)行Ant 構(gòu)建文件的規(guī)則。這將確保代碼是經(jīng)過(guò)同一個(gè)Ant構(gòu)建文件構(gòu)建的。當(dāng)出現(xiàn)問(wèn)題時(shí),要使用項(xiàng)目標(biāo)準(zhǔn)的 Ant構(gòu)建文件,而不是通過(guò)某個(gè)IDE來(lái)執(zhí)行一個(gè)干凈的構(gòu)建。 

程序員可以自由選擇任何他們習(xí)慣使用的IDE。但是Ant應(yīng)作為公共基線以保證永遠(yuǎn)是可構(gòu)建的。 

13. 使用 zipfileset屬性 

人們經(jīng)常使用Ant產(chǎn)生WAR、JAR、ZIP和 EAR文件。這些文件通常都要求有一個(gè)特定的內(nèi)部目錄結(jié)構(gòu),但其往往與你的源代碼和編譯環(huán)境的目錄結(jié)構(gòu)不匹配。 

一個(gè)最常用的方法是寫一個(gè)Ant任務(wù)按照期望的目錄結(jié)構(gòu)把一大堆文件拷貝到臨時(shí)目錄中,然后生成壓縮文件。這不是最有效的方法。使用zipfileset屬性是更好的解決方案。它讓你從任何位置選擇文件,然后把它們按照不同目錄結(jié)構(gòu)放進(jìn)壓縮文件中。以下是一個(gè)例子: 


<ear earfile="${dir.dist.server}/payroll.ear"    appxml="${dir.resources}/application.xml">  <fileset dir="${dir.build}" includes="commonServer.jar"/>  <fileset dir="${dir.build}">    <include name="payroll-ejb.jar"/>  </fileset>  <zipfileset dir="${dir.build}" prefix="lib">    <include name="hr.jar"/>    <include name="billing.jar"/>  </zipfileset>  <fileset dir=".">    <include name="lib/jdom.jar"/>    <include name="lib/log4j.jar"/>    <include name="lib/ojdbc14.jar"/>  </fileset>  <zipfileset dir="${dir.generated.src}" prefix="META-INF">    <include name="jboss-app.xml"/>  </zipfileset></ear>

在這個(gè)例子中,所有JAR文件都放在EAR文件包的lib目錄中。hr.jar和billing.jar是從構(gòu)建目錄拷貝過(guò)來(lái)的。因此我們使用zipfileset屬性把它們移動(dòng)到EAR文件包內(nèi)部的lib目錄。prefix屬性指定了其在EAR文件中的目標(biāo)路徑。 

14. 運(yùn)行 Clean 構(gòu)建任務(wù)的測(cè)試 

假設(shè)你的構(gòu)建文件中有clean和compile的任務(wù),執(zhí)行以下的測(cè)試。第一步,執(zhí)行ant clean;第二步,執(zhí)行ant compile;第三步,再執(zhí)行ant compile。第三步應(yīng)該不作任何事情。如果文件再次被編譯,說(shuō)明你的構(gòu)建文件有問(wèn)題。 

構(gòu)建文件應(yīng)該只在與輸出文件相關(guān)聯(lián)的輸入文件發(fā)生變化時(shí),才應(yīng)該執(zhí)行任務(wù)。一個(gè)構(gòu)建文件在不必執(zhí)行諸如編譯、拷貝或其他工作任務(wù)的時(shí)候執(zhí)行這些等任務(wù)是低效的。當(dāng)項(xiàng)目規(guī)模增長(zhǎng)時(shí),即使是小的低效工作也會(huì)成為大的問(wèn)題。 

15. 避免特定平臺(tái)的Ant包 

不管什么原因,有人喜歡用簡(jiǎn)單的、名稱叫做compile之類的批文件或腳本裝載他們的產(chǎn)品。當(dāng)你去看腳本的內(nèi)容,你會(huì)發(fā)現(xiàn)以下內(nèi)容: 


ant compile

其實(shí)開(kāi)發(fā)人員熟悉Ant,并且完全能夠自己鍵入ant compile。請(qǐng)不要僅僅為了調(diào)用Ant而使用特定平臺(tái)的腳本。這只會(huì)使其他人在首次使用你的腳本時(shí),增加學(xué)習(xí)和理解的煩擾。除此之外,你不可能提供適用于每個(gè)操作系統(tǒng)的腳本,這是真正煩擾其他用戶的地方。 

總結(jié) 

太多的公司依靠手工方法和程序來(lái)編譯代碼和生成軟件發(fā)布版本。那些不使用Ant或類似工具定義構(gòu)建過(guò)程的開(kāi)發(fā)團(tuán)隊(duì),花費(fèi)了令人驚異的時(shí)間來(lái)捕捉代碼編譯過(guò)程中出現(xiàn)的問(wèn)題,這些在某些開(kāi)發(fā)者那里編譯成功的代碼,到另一些開(kāi)發(fā)者那里卻失敗了。 

生成并維護(hù)構(gòu)建腳本不是一項(xiàng)迷人的工作,但卻是一項(xiàng)必需的工作。一個(gè)好的Ant構(gòu)建文件將使你集中到更喜歡的工作——寫代碼中! 

參考