Ant的buildfile是用XML寫的。每個buildfile含有一個project。
buildfile中每個task元素可以有一個id屬性,可以用這個id值引用指定的任務(wù)。這個值必須是唯一的。(詳情請參考下面的Task小節(jié))
Projectsproject有下面的屬性:
Attribute | Description | Required |
name | 項(xiàng)目名稱. | No |
default | 當(dāng)沒有指定target時使用的缺省target | Yes |
basedir | 用于計(jì)算所有其他路徑的基路徑。該屬性可以被basedir property覆蓋。當(dāng)覆蓋時,該屬性被忽略。如果屬性和basedir property都沒有設(shè)定,就使用buildfile文件的父目錄。 | No |
項(xiàng)目的描述以一個頂級的<description>元素的形式出現(xiàn)(參看description小節(jié))。
一個項(xiàng)目可以定義一個或多個target。一個target是一系列你想要執(zhí)行的。執(zhí)行Ant時,你可以選擇執(zhí)行那個target。當(dāng)沒有給定target時,使用project的default屬性所確定的target。
Targets
一個target可以依賴于其他的target。例如,你可能會有一個target用于編譯程序,一個target用于生成可執(zhí)行文件。你在生成可執(zhí)行文件之前必須先編譯通過,所以生成可執(zhí)行文件的target依賴于編譯target。Ant會處理這種依賴關(guān)系。
然而,應(yīng)當(dāng)注意到,Ant的depends屬性只指定了target應(yīng)該被執(zhí)行的順序-如果被依賴的target無法運(yùn)行,這種depends對于指定了依賴關(guān)系的target就沒有影響。
Ant會依照depends屬性中target出現(xiàn)的順序(從左到右)依次執(zhí)行每個target。然而,要記住的是只要某個target依賴于一個target,后者就會被先執(zhí)行。
<target name="A"/>
<target name="B" depends="A"/>
<target name="C" depends="B"/>
<target name="D" depends="C,B,A"/>
假定我們要執(zhí)行target D。從它的依賴屬性來看,你可能認(rèn)為先執(zhí)行C,然后B,最后A被執(zhí)行。錯了,C依賴于B,B依賴于A,所以先執(zhí)行A,然后B,然后C,最后D被執(zhí)行。
一個target只能被執(zhí)行一次,即時有多個target依賴于它(看上面的例子)。
如果(或如果不)某些屬性被設(shè)定,才執(zhí)行某個target。這樣,允許根據(jù)系統(tǒng)的狀態(tài)(java version, OS, 命令行屬性定義等等)來更好地控制build的過程。要想讓一個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"/>
如果沒有if或unless屬性,target總會被執(zhí)行。
可選的description屬性可用來提供關(guān)于target的一行描述,這些描述可由-projecthelp命令行選項(xiàng)輸出。
將你的tstamp task在一個所謂的初始化target是很好的做法,其他的target依賴這個初始化target。要確保初始化target是出現(xiàn)在其他target依賴表中的第一個target。在本手冊中大多數(shù)的初始化target的名字是"init"。
target有下面的屬性:
Attribute | Description | Required |
name | target的名字 | Yes |
depends | 用逗號分隔的target的名字列表,也就是依賴表。 | No |
if | 執(zhí)行target所需要設(shè)定的屬性名。 | No |
unless | 執(zhí)行target需要清除設(shè)定的屬性名。 | No |
description | 關(guān)于target功能的簡短描述。 | No |
Tasks
一個task是一段可執(zhí)行的代碼。
一個task可以有多個屬性(如果你愿意的話,可以將其稱之為變量)。屬性只可能包含對property的引用。這些引用會在task執(zhí)行前被解析。
下面是Task的一般構(gòu)造形式:
<name attribute1="value1" attribute2="value2" ... />
這里name是task的名字,attributeN是屬性名,valueN是屬性值。
有一套內(nèi)置的(built-in)task,以及一些可選task,但你也可以編寫自己的task。
所有的task都有一個task名字屬性。Ant用屬性值來產(chǎn)生日志信息。
可以給task賦一個id屬性:
<taskname id="taskID" ... />
這里taskname是task的名字,而taskID是這個task的唯一標(biāo)識符。通過這個標(biāo)識符,你可以在腳本中引用相應(yīng)的task。例如,在腳本中你可以這樣:
<script ... >
task1.setFoo("bar");
</script>
設(shè)定某個task實(shí)例的foo屬性。在另一個task中(用java編寫),你可以利用下面的語句存取相應(yīng)的實(shí)例。
project.getReference("task1").
注意1:如果task1還沒有運(yùn)行,就不會被生效(例如:不設(shè)定屬性),如果你在隨后配置它,你所作的一切都會被覆蓋。
注意2:未來的Ant版本可能不會兼容這里所提的屬性,因?yàn)楹苡锌赡芨緵]有task實(shí)例,只有proxies。
Properties
一個project可以有很多的properties。可以在buildfile中用property task來設(shè)定,或在Ant之外設(shè)定。一個property有一個名字和一個值。property可用于task的屬性值。這是通過將屬性名放在"${"和"}"之間并放在屬性值的位置來實(shí)現(xiàn)的。例如如果有一個property builddir的值是"build",這個property就可用于屬性值:${builddir}/classes。這個值就可被解析為build/classes。
內(nèi)置屬性
如果你使用了<property> task 定義了所有的系統(tǒng)屬性,Ant允許你使用這些屬性。例如,${os.name}對應(yīng)操作系統(tǒng)的名字。
要想得到系統(tǒng)屬性的列表可參考the Javadoc of System.getProperties。
除了Java的系統(tǒng)屬性,Ant還定義了一些自己的內(nèi)置屬性: basedir project基目錄的絕對路徑 (與<project>的basedir屬性一樣)。ant.file buildfile的絕對路徑。ant.version Ant的版本。ant.project.name 當(dāng)前執(zhí)行的project的名字;由<project>的name屬性設(shè)定.ant.java.version Ant檢測到的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>
Token Filters
一個project可以有很多tokens,這些tokens在文件拷貝時會被自動擴(kuò)展,這要求在支持這一行為的task中選擇過濾拷貝功能。這一功能可用filter task在buildfile中設(shè)定。
既然這很可能是一個有危害的行為,文件中的tokens必須采取@token@的形式,這里token是filter task中設(shè)定的token名。這種token語法與其他build系統(tǒng)執(zhí)行類似filtering的語法相同,而且與大多數(shù)的編程和腳本語言以及文檔系統(tǒng)并不沖突,
注意:如果在一個文件中發(fā)現(xiàn)了一個@token@形式的token,但沒有filter與這個token關(guān)連,則不會發(fā)生任何事;因此,沒有轉(zhuǎn)義方法-但只要你為token選擇合適的名字,就不會產(chǎn)生問題。
警告:如果你在拷貝binary文件時打開filtering功能,你有可能破壞文件。這個功能只針對文本文件。
Path-like Structures
你可以用":"和";"作為分隔符,指定類似PATH和CLASSPATH的引用。Ant會把分隔符轉(zhuǎn)換為當(dāng)前系統(tǒng)所用的分隔符。
當(dāng)需要指定類似路徑的值時,可以使用嵌套元素。一般的形式是
<classpath><pathelement path="${classpath}"/><pathelement location="lib/helper.jar"/></classpath>
location屬性指定了相對于project基目錄的一個文件和目錄,而path屬性接受逗號或分號分隔的一個位置列表。path屬性一般用作預(yù)定義的路徑--其他情況下,應(yīng)該用多個location屬性。
為簡潔起見,classpath標(biāo)簽支持自己的path和location屬性。所以:
<classpath><pathelement path="${classpath}"/></classpath>
可以被簡寫作:
<classpath path="${classpath}"/>
也可通過<fileset>元素指定路徑。構(gòu)成一個fileset的多個文件加入path-like structure的順序是未定的。
<classpath><pathelement path="${classpath}"/><fileset dir="lib"><include name="**/*.jar"/></fileset><pathelement location="classes"/></classpath>
上面的例子構(gòu)造了一個路徑值包括:${classpath}的路徑,跟著lib目錄下的所有jar文件,接著是classes目錄。
如果你想在多個task中使用相同的path-like structure,你可以用<path>元素定義他們(與target同級),然后通過id屬性引用--參考Referencs例子。
path-like structure可能包括對另一個path-like structurede的引用(通過嵌套<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>的簡潔寫法對于<path>也是有效的,如:
<path id="tests.path"><path refid="base.path"/><pathelement location="testclasses"/></path>
可寫成:
<path id="base.path" path="${classpath}"/>
命令行變量
有些task可接受參數(shù),并將其傳遞給另一個進(jìn)程。為了能在變量中包含空格字符,可使用嵌套的arg元素。
Attribute | Description | Required |
value | 一個命令行變量;可包含空格字符。 | 只能用一個 |
line | 空格分隔的命令行變量列表。 |
file | 作為命令行變量的文件名;會被文件的絕對名替代。 |
path | 一個作為單個命令行變量的path-like的字符串;或作為分隔符,Ant會將其轉(zhuǎn)變?yōu)樘囟ㄆ脚_的分隔符。 |
例子
<arg value="-l -a"/>
是一個含有空格的單個的命令行變量。
<arg line="-l -a"/>
是兩個空格分隔的命令行變量。
<arg path="/dir;/dir2:\dir3"/>
是一個命令行變量,其值在DOS系統(tǒng)上為\dir;\dir2;\dir3;在Unix系統(tǒng)上為/dir:/dir2:/dir3 。
References
buildfile元素的id屬性可用來引用這些元素。如果你需要一遍遍的復(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也接受這種類型的引用。