Ant全攻略[轉] eako的專欄

Ant全攻略

轉自：BEA論壇 powerise  

1.Ant是什麼？

Ant是一種基于Java和XML的build工具。

2 下載下傳、安裝Ant

安裝Ant

下載下傳.zip檔案，解壓縮到c:/ant1.3(後面引用為%ANT_HOME%)

2.1 在你運作Ant之前需要做一些配置工作。

· 将bin目錄加入PATH環境變量。

· 設定ANT_HOME環境變量，指向你安裝Ant的目錄。在一些OS上，Ant的腳本可以猜測ANT_HOME（Unix和Windos NT/2000）－但最好不要依賴這一特性。

· 可選地，設定JAVA_HOME環境變量（參考下面的進階小節），該變量應該指向你安裝JDK的目錄。

注意：不要将Ant的ant.jar檔案放到JDK/JRE的lib/ext目錄下。Ant是個應用程式，而lib/ext目錄是為JDK擴充使用的（如JCE，JSSE擴充）。而且通過擴充裝入的類會有安全方面的限制。

2.2 運作Ant

運作Ant非常簡單，當你正确地安裝Ant後，隻要輸入ant就可以了。

n 沒有指定任何參數時，Ant會在目前目錄下查詢build.xml檔案。如果找到了就用該檔案作為buildfile。如果你用 -find 選項。Ant就會在上級目錄中尋找buildfile，直至到達檔案系統的根。要想讓Ant使用其他的buildfile，可以用參數 -buildfile file，這裡file指定了你想使用的buildfile。

n 可以指定執行一個或多個target。當省略target時，Ant使用标簽<project>的default屬性所指定的target。

指令行選項總結：

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

使用目前目錄下的build.xml運作Ant，執行預設的target。

ant -buildfile test.xml

使用目前目錄下的test.xml運作Ant，執行預設的target。

ant -buildfile test.xml dist

使用目前目錄下的test.xml運作Ant，執行一個叫做dist的target。

ant -buildfile test.xml -Dbuild=build/classes dist

使用目前目錄下的test.xml運作Ant，執行一個叫做dist的target，并設定build屬性的值為build/classes。

3 編寫build.xml

Ant的buildfile是用XML寫的。每個buildfile含有一個project。

buildfile中每個task元素可以有一個id屬性，可以用這個id值引用指定的任務。這個值必須是唯一的。（詳情請參考下面的Task小節）

3.1 Projects

project有下面的屬性：

Attribute Description Required

name 項目名稱. No

default 當沒有指定target時使用的預設target Yes

basedir 用于計算所有其他路徑的基路徑。該屬性可以被basedir property覆寫。當覆寫時，該屬性被忽略。如果屬性和basedir property都沒有設定，就使用buildfile檔案的父目錄。 No

項目的描述以一個頂級的<description>元素的形式出現（參看description小節）。

一個項目可以定義一個或多個target。一個target是一系列你想要執行的。執行Ant時，你可以選擇執行那個target。當沒有給定target時，使用project的default屬性所确定的target。

3.2 Targets

一個target可以依賴于其他的target。例如，你可能會有一個target用于編譯程式，一個target用于生成可執行檔案。你在生成可執行檔案之前必須先編譯通過，是以生成可執行檔案的target依賴于編譯target。Ant會處理這種依賴關系。

然而，應當注意到，Ant的depends屬性隻指定了target應該被執行的順序－如果被依賴的target無法運作，這種depends對于指定了依賴關系的target就沒有影響。

Ant會依照depends屬性中target出現的順序（從左到右）依次執行每個target。然而，要記住的是隻要某個target依賴于一個target，後者就會被先執行。

<target name="A"/>

<target name="B" depends="A"/>

<target name="C" depends="B"/>

<target name="D" depends="C,B,A"/>

假定我們要執行target D。從它的依賴屬性來看，你可能認為先執行C，然後B，最後A被執行。錯了，C依賴于B，B依賴于A，是以先執行A，然後B，然後C，最後D被執行。

一個target隻能被執行一次，即時有多個target依賴于它（看上面的例子）。

如果（或如果不）某些屬性被設定，才執行某個target。這樣，允許根據系統的狀态（java version, OS, 指令行屬性定義等等）來更好地控制build的過程。要想讓一個target這樣做，你就應該在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總會被執行。

可選的description屬性可用來提供關于target的一行描述，這些描述可由-projecthelp指令行選項輸出。

将你的tstamp task在一個所謂的初始化target是很好的做法，其他的target依賴這個初始化target。要確定初始化target是出現在其他target依賴表中的第一個target。在本手冊中大多數的初始化target的名字是"init"。

target有下面的屬性：

Attribute Description Required

name target的名字 Yes

depends 用逗号分隔的target的名字清單，也就是依賴表。 No

if 執行target所需要設定的屬性名。 No

unless 執行target需要清除設定的屬性名。 No

description 關于target功能的簡短描述。 No

3.3 Tasks

一個task是一段可執行的代碼。

一個task可以有多個屬性（如果你願意的話，可以将其稱之為變量）。屬性隻可能包含對property的引用。這些引用會在task執行前被解析。

下面是Task的一般構造形式：

<name attribute1="value1" attribute2="value2" ... />

這裡name是task的名字，attributeN是屬性名，valueN是屬性值。

有一套内置的（built-in）task，以及一些可選task，但你也可以編寫自己的task。

所有的task都有一個task名字屬性。Ant用屬性值來産生日志資訊。

可以給task賦一個id屬性：

<taskname id="taskID" ... />

這裡taskname是task的名字，而taskID是這個task的唯一辨別符。通過這個辨別符，你可以在腳本中引用相應的task。例如，在腳本中你可以這樣：

<script ... >

task1.setFoo("bar");

</script>

設定某個task執行個體的foo屬性。在另一個task中（用java編寫），你可以利用下面的語句存取相應的執行個體。

project.getReference("task1").

注意1：如果task1還沒有運作，就不會被生效（例如：不設定屬性），如果你在随後配置它，你所作的一切都會被覆寫。

注意2：未來的Ant版本可能不會相容這裡所提的屬性，因為很有可能根本沒有task執行個體，隻有proxies。

3.4 Properties

一個project可以有很多的properties。可以在buildfile中用property task來設定，或在Ant之外設定。一個property有一個名字和一個值。property可用于task的屬性值。這是通過将屬性名放在"${"和"}"之間并放在屬性值的位置來實作的。例如如果有一個property builddir的值是"build"，這個property就可用于屬性值：${builddir}/classes。這個值就可被解析為build/classes。

内置屬性

如果你使用了<property> task 定義了所有的系統屬性，Ant允許你使用這些屬性。例如，${os.name}對應作業系統的名字。

要想得到系統屬性的清單可參考the Javadoc of System.getProperties。

除了Java的系統屬性，Ant還定義了一些自己的内置屬性：

basedir project基目錄的絕對路徑 (與<project>的basedir屬性一樣)。

ant.file buildfile的絕對路徑。

ant.version Ant的版本。

ant.project.name 目前執行的project的名字；由<project>的name屬性設定.

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>

3.5 Path-like Structures

你可以用":"和";"作為分隔符，指定類似PATH和CLASSPATH的引用。Ant會把分隔符轉換為目前系統所用的分隔符。

當需要指定類似路徑的值時，可以使用嵌套元素。一般的形式是

<classpath>

<pathelement path="${classpath}"/>

<pathelement location="lib/helper.jar"/>

</classpath>

location屬性指定了相對于project基目錄的一個檔案和目錄，而path屬性接受逗号或分号分隔的一個位置清單。path屬性一般用作預定義的路徑－－其他情況下，應該用多個location屬性。

為簡潔起見，classpath标簽支援自己的path和location屬性。是以：

<classpath>

<pathelement path="${classpath}"/>

</classpath>

可以被簡寫作：

<classpath path="${classpath}"/>

也可通過<fileset>元素指定路徑。構成一個fileset的多個檔案加入path-like structure的順序是未定的。

<classpath>

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

前面所提的關于<classpath>的簡潔寫法對于<path>也是有效的，如：

<path id="tests.path">

  <path refid="base.path"/>

<pathelement location="testclasses"/>

</path>

可寫成：

<path id="base.path" path="${classpath}"/>

指令行變量

有些task可接受參數，并将其傳遞給另一個程序。為了能在變量中包含空格字元，可使用嵌套的arg元素。

Attribute Description Required

value 一個指令行變量；可包含空格字元。 隻能用一個

line 空格分隔的指令行變量清單。

file 作為指令行變量的檔案名；會被檔案的絕對名替代。

path 一個作為單個指令行變量的path-like的字元串；或作為分隔符，Ant會将其轉變為特定平台的分隔符。

例子

<arg value="-l -a"/>

是一個含有空格的單個的指令行變量。

<arg line="-l -a"/>

是兩個空格分隔的指令行變量。

<arg path="/dir;/dir2:/dir3"/>

是一個指令行變量，其值在DOS系統上為/dir;/dir2;/dir3；在Unix系統上為/dir:/dir2:/dir3 。

3.6 References

buildfile元素的id屬性可用來引用這些元素。如果你需要一遍遍的複制相同的XML代碼塊，這一屬性就很有用－－如多次使用<classpath>結構。

下面的例子：

<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也接受這種類型的引用。

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

                               Ant全攻略（續）－－－Ant中的内置任務

4.1 File（Directory）類

4.1.1 Mkdir

n 建立一個目錄，如果他的父目錄不存在，也會被同時建立。

n 例子：

<mkdir dir="build/classes"/>

n 說明： 如果build不存在，也會被同時建立

4.1.2 Copy

n 拷貝一個（組）檔案、目錄

n 例子：

1. 拷貝單個的檔案：

<copy file="myfile.txt" tofile="mycopy.txt"/>

2. 拷貝單個的檔案到指定目錄下

<copy file="myfile.txt" todir="../some/other/dir"/>

3. 拷貝一個目錄到另外一個目錄下

  <copy todir="../new/dir">

    <fileset dir="src_dir"/>

  </copy>

4. 拷貝一批檔案到指定目錄下

  <copy todir="../dest/dir">

    <fileset dir="src_dir">

      <exclude name="***.java"/>

  </copy>

5. 拷貝一批檔案到指定目錄下，将檔案名後增加。Bak字尾

  <copy todir="../backup/dir">

    <fileset dir="src_dir"/>

    <mapper type="glob" from="*" to="*.bak"/>

  </copy>

6. 拷貝一組檔案到指定目錄下，替換其中的@标簽@内容

  <copy todir="../backup/dir">

    <fileset dir="src_dir"/>

    <filterset>

      <filter token="TITLE" value="Foo Bar"/>

    </filterset>

  </copy>

4.1.3 Delete

n 删除一個（組）檔案或者目錄

n 例子

1. 删除一個檔案

<delete file="/lib/ant.jar"/>

2. 删除指定目錄及其子目錄

  <delete dir="lib"/>

3. 删除指定的一組檔案

  <delete>

    <fileset dir="." includes="***.jar"/>

<exclude name="**/ant.jar"/>

</fileset>

</move>

5. 移動檔案過程中增加。Bak字尾

<move todir="my/src/dir">

<fileset dir="my/src/dir">

<exclude name="***.zip"/>

  </fileset>

</mail>

l mailhost： SMTP伺服器位址

l mailport： 伺服器端口

l subject：  主題

l from：    發送人位址

l to：      接受人位址

l message： 發送的消息

l fileset：  設定附件

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

Trackback: http://tb.blog.csdn.net/TrackBack.aspx?PostId=321355