1 Ant是什麼?
Apache Ant 是一個基於 Java的生成工具。
生成工具在軟件開發中用來將源代碼和其他輸入文件轉換為可執行文件的形式(也有可能轉換為可安裝的產品映像形式)。隨著應用程序的生成過程變得更加複雜,確保在每次生成期間都使用精確相同的生成步驟,同時實現儘可能多的自動化,以便及時產生一致的生成版本
2 下載、安裝Ant
安裝Ant
下載.zip文件,解壓縮到c:\\ant1.3(後面引用為%ANT_HOME%)
2.1 在你運行Ant之前需要做一些配置工作。
1) 將bin目錄加入PATH環境變量。
2) 設定ANT_HOME環境變量,指向你安裝Ant的目錄。在一些OS上,Ant的腳本可以猜測ANT_HOME(Unix和Windos NT/2000)-但最好不要依賴這一特性。
3) 可選地,設定JAVA_HOME環境變量(參考下面的高級小節),該變量應該指向你安裝JDK的目錄。
注意:不要將Ant的ant.jar文件放到JDK/JRE的lib/ext目錄下。Ant是個應用程序,而lib/ext目錄是為JDK擴展使用的(如JCE,JSSE擴展)。而且通過擴展裝入的類會有安全方面的限制。
2.2 運行Ant
運行Ant非常簡單,當你正確地安裝Ant後,只要輸入ant就可以了。
1) 沒有指定任何參數時,Ant會在當前目錄下查詢build.xml文件。如果找到了就用該文件作為buildfile。如果你用 -find 選項。
Ant就會在上級目錄中尋找buildfile,直至到達文件系統的根。要想讓Ant使用其他的buildfile,可以用參數 -
buildfile file,這裡file指定了你想使用的buildfile。
2) 可以指定執行一個或多個target。當省略target時,Ant使用標籤<project>的default屬性所指定的target。/<project>
命令行選項總結:
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 Required Description
name No 項目名稱.
default Yes 當沒有指定target時使用的缺省target
basedir No 用於計算所有其他路徑的基路徑。該屬性可以被basedir property覆蓋。當覆蓋時,該屬性被忽略。如果屬性和basedir property都沒有設定,就使用buildfile文件的父目錄。
項目的描述以一個頂級的<description>元素的形式出現(參看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>
<target>
<target>
<target>
假定我們要執行target D, 則會先執行A,然後B,然後C,最後D被執行。
一個target只能被執行一次,即時有多個target依賴於它(看上面的例子)。
如果(或如果不)某些屬性被設定,才執行某個target。這樣,允許根據系統的狀態(java version, OS, 命令行屬性定義等等)來更好地控制build的過程。要想讓一個target這樣做,你就應該在target元素中,加入if(或unless)屬性,帶上target因該有所判斷的屬性。例如:
<target>
<target>
如果沒有if或unless屬性,target總會被執行。
可選的description屬性可用來提供關於target的一行描述,這些描述可由-projecthelp命令行選項輸出。
將你的tstamp task在一個所謂的初始化target是很好的做法,其他的target依賴這個初始化target。要確保初始化target是出現在其他target依賴表中的第一個target。在本手冊中大多數的初始化target的名字是"init"。
target有下面的屬性:
Attribute Required Description
name Yes target的名字D
depends No 用逗號分隔的target的名字列表,也就是依賴表。
if No 執行target所需要設定的屬性名。
unless No 執行target需要清除設定的屬性名。
description No 關於target功能的簡短描述。
3.3 Tasks
一個task是一段可執行的代碼。
一個task可以有多個屬性(如果你願意的話,可以將其稱之為變量)。屬性只可能包含對property的引用。這些引用會在task執行前被解析。
下面是Task的一般構造形式:
<name>
這裡name是task的名字,attributeN是屬性名,valueN是屬性值。
有一套內置的(built-in)task,以及一些可選task,但你也可以編寫自己的task。
所有的task都有一個task名字屬性。Ant用屬性值來產生日誌信息。
可以給task賦一個id屬性:
<taskname>
這裡taskname是task的名字,而taskID是這個task的唯一標識符。通過這個標識符,你可以在腳本中引用相應的task。例如,在腳本中你可以這樣:
task1.setFoo("bar");
設定某個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}對應操作系統的名字。/<property>
要想得到系統屬性的列表可參考the Javadoc of System.getProperties。
除了Java的系統屬性,Ant還定義了一些自己的內置屬性:
basedir project基目錄的絕對路徑 (與<project>的basedir屬性一樣)。/<project>
ant.file buildfile的絕對路徑。
ant.version Ant的版本。
ant.project.name 當前執行的project的名字;由<project>的name屬性設定./<project>
ant.java.version Ant檢測到的JVM的版本; 目前的值有"1.1", "1.2", "1.3" and "1.4".
例子
<project> /<project>
<property>
<property>
<property>
<target>
<tstamp>
<mkdir>
<target>
<javac>
<target>
<mkdir>
<target>
<delete>
<delete>
3.5 Path-like Structures
你可以用":"和";"作為分隔符,指定類似PATH和CLASSPATH的引用。Ant會把分隔符轉換為當前系統所用的分隔符。
當需要指定類似路徑的值時,可以使用嵌套元素。一般的形式是
<classpath>
<pathelement>
<pathelement>
location屬性指定了相對於project基目錄的一個文件和目錄,而path屬性接受逗號或分號分隔的一個位置列表。path屬性一般用作預定義的路徑--其他情況下,應該用多個location屬性。
為簡潔起見,classpath標籤支持自己的path和location屬性。所以:
<classpath>
<pathelement>
可以被簡寫作:
<classpath>
也可通過<fileset>元素指定路徑。構成一個fileset的多個文件加入path-like structure的順序是未定的。/<fileset>
<classpath>
<pathelement>
<fileset>
<include>
<pathelement>
上面的例子構造了一個路徑值包括:${classpath}的路徑,跟著lib目錄下的所有jar文件,接著是classes目錄。
如果你想在多個task中使用相同的path-like structure,你可以用<path>元素定義他們(與target同級),然後通過id屬性引用--參考Referencs例子。/<path>
path-like structure可能包括對另一個path-like structurede的引用(通過嵌套<path>元素):/<path>
<path>
<pathelement>
<fileset>
<include>
<pathelement>
<path>
<path>
<pathelement>
前面所提的關於<classpath>的簡潔寫法對於<path>也是有效的,如:/<path>/<classpath>
<path>
<path>
<pathelement>
可寫成:
<path>
命令行變量
有些task可接受參數,並將其傳遞給另一個進程。為了能在變量中包含空格字符,可使用嵌套的arg元素。
Attribute Description Required
value 一個命令行變量;可包含空格字符。 只能用一個
line 空格分隔的命令行變量列表。
file 作為命令行變量的文件名;會被文件的絕對名替代。
path 一個作為單個命令行變量的path-like的字符串;或作為分隔符,Ant會將其轉變為特定平臺的分隔符。
例子
是一個含有空格的單個的命令行變量。
是兩個空格分隔的命令行變量。
是一個命令行變量,其值在DOS系統上為\\dir;\\dir2;\\dir3;在Unix系統上為/dir:/dir2:/dir3 。
References
buildfile元素的id屬性可用來引用這些元素。如果你需要一遍遍的複製相同的XML代碼塊,這一屬性就很有用--如多次使用<classpath>結構。/<classpath>
下面的例子:
<project>
<target> /<target>
<rmic> /<rmic>
<classpath> /<classpath>
<pathelement>
<pathelement>
<pathelement>
<target>
<javac>
<classpath>
<pathelement>
<pathelement>
<pathelement>
可以寫成如下形式:
<project> /<project>
<path> /<path>
<pathelement>
<pathelement>
<pathelement>
<target>
<rmic>
<classpath>
<target> /<target>
<javac>
<classpath>
所有使用PatternSets, FileSets 或 path-like structures嵌套元素的task也接受這種類型的引用。
4 Ant的Core Tasks
1、copy命令
copy主要用來對文件和目錄的複製功能。舉例如下:
● 複製單個文件:
代碼如下:
1 < copy file="old.txt" tofile="new.txt"/>
● 對文件目錄進行復制:
代碼如下:
1 < copy todir="../dest_dir">
2 <fileset>
3 < /copy>
● 將文件複製到另外的目錄:
代碼如下:
1 < copy file="src.txt" todir="c:/base"/>
2、delete命令
對文件或目錄進行刪除,舉例如下:
● 刪除某個文件:
代碼如下:
1 < delete file="/res/image/cat.jpg"/>
● 刪除某個目錄:
代碼如下:
1 < delete dir="/res/image"/>
● 刪除所有的jar文件或空目錄:
代碼如下:
1 < delete includeEmptyDirs="true">
2 <fileset>
3 < /delete>
3、 mkdir 命令
創建目錄。
代碼如下:
1 < mkdir dir="/home/philander/build/classes"/>
4、 move 命令
移動文件或目錄,舉例如下:
● 移動單個文件:
代碼如下:
1 < move file="sourcefile" tofile=”destfile”/>
● 移動單個文件到另一個目錄:
代碼如下:
1 < move file="sourcefile" todir=”movedir”/>
● 移動某個目錄到另一個目錄:
代碼如下:
1 < move todir="newdir">
2 <fileset>
3 < /move>
5、echo 命令
該任務的作用是根據日誌或監控器的級別輸出信息。它包括 message 、 file 、 append 和 level 四個屬性,舉例如下
1 <echo>
6、jar 標籤節點元素
該標籤用來生成一個JAR文件,其屬性如下。
● destfile表示JAR文件名。
● basedir表示被歸檔的文件名。
● includes表示別歸檔的文件模式。
● exchudes表示被排除的文件模式。
● compress表示是否壓縮。
示例:
代碼如下:
1 < jar destfile="${webRoot}/${ash_jar}" level="9" compress="true" encoding="utf-8" basedir="${dest}">
2 <manifest>
3 <attribute>
4
5 < /jar>
上面的mainfest是jar包中的MEAT-INF中的MANIFEST.MF中的文件內容
同樣打包操作的的還有war、tgz,已經解壓操作uzip
代碼如下:
1 < !-- 創建zip -->
2 < zip basedir="${basedir}\\classes" zipfile="temp\\output.zip"/>
3 < !-- 創建tgz -->
4 < gzip class="lazy" src="//p2.ttnews.xyz/loading.gif" data-original="classes\\**\\*.class" zipfile="output.class.gz"/>
5 < !-- 解壓zip -->
6 < unzip class="lazy" src="//p2.ttnews.xyz/loading.gif" data-original="output.class.gz" dest="extractDir"/>
7 < !-- 建立war包 -->
8 < war destfile="${webRoot}/ash.war" basedir="${basedir}/web" webxml="${basedir}/web/WEB-INF/web.xml">
9 <exclude>
10 <exclude>
11 <exclude>
12
13 <exclude>
14
15
16 <classes> /<classes>
17 < /war>
7、javac 標籤節點元素
該標籤用於編譯一個或一組java文件,其屬性如下。
● srcdir表示源程序的目錄。
● destdir表示class文件的輸出目錄。
● include表示被編譯的文件的模式。
● excludes表示被排除的文件的模式。
● classpath表示所使用的類路徑。
● debug表示包含的調試信息。
● optimize表示是否使用優化。
● verbose 表示提供詳細的輸出信息。
● fileonerror表示當碰到錯誤就自動停止。
示例
代碼如下:
1 < javac srcdir="${src}" destdir="${dest}"/>
2 < !-- 設置jvm內存
3 <javac>
4 < javac srcdir="src" fork="true" executable="d:\\sdk141\\bin\\javac"
5 memoryMaximumSize="128m"/>
6 -->
8、java 標籤節點元素
該標籤用來執行編譯生成的.class文件,其屬性如下。
● classname 表示將執行的類名。
● jar表示包含該類的JAR文件名。
● classpath所表示用到的類路徑。
● fork表示在一個新的虛擬機中運行該類。
● failonerror表示當出現錯誤時自動停止。
● output 表示輸出文件。
● append表示追加或者覆蓋默認文件。
示例
代碼如下:
1 < java classname="com.hoo.test.HelloWorld" classpath="${hello_jar}"/>
9、arg 數據參數元素
由Ant構建文件調用的程序,可以通過
● values 是一個命令參數。如果參數中有空格,但又想將它作為單獨一個值,則使用此屬性。
● file 表示一個參數的文件名。在構建文件中,此文件名相對於當前的工作目錄。
● line 表示用空格分隔的多個參數列表。
● 表示路徑,一個作為單個命令行變量的path-like的字符串;或作為分隔符,Ant會將其轉變為特定平臺的分隔符。
● pathref 引用的path(使用path元素節點定義path)的id
● prefix 前綴
● suffix 後綴
例子
代碼如下:
1 < arg value="-l -a"/>
是一個含有空格的單個的命令行變量。
代碼如下:
1 < arg line="-l -a"/>
是兩個空格分隔的命令行變量。
代碼如下:
1 < arg path="/dir;/dir2:\\dir3"/>
是一個命令行變量,其值在DOS系統上為\\dir;\\dir2;\\dir3;在Unix系統上為/dir:/dir2:/dir3 。
10、ervironment 類型
由Ant構建文件調用的外部命令或程序,
● file表示環境變量值的文件名。此文件名要被轉換位一個絕對路徑。
● path表示環境變量的路徑。Ant會將它轉換為一個本地約定。
● value 表示環境變量的一個直接變量。
● key 表示環境變量名。
注意 file path 或 value只能取一個。
11、filelist 文件集合列表
filelist 是一個支持命名的文件列表的數據類型,包含在一個filelist類型中的文件不一定是存在的文件。以下是其所有的屬性。
● dir是用於計算絕對文件名的目錄。
● files 是用逗號分隔的文件名列表。
● refid 是對某處定義的一個<filelist>的引用。 /<filelist>
注意 dir 和 files 都是必要的,除非指定了refid(這種情況下,dir和files都不允許使用)。
示例
代碼如下:
1 < filelist id="docfiles" dir="${doc.src}" files="foo.xml,bar.xml"/>
2 文件集合 ${doc.src}/foo.xml和${doc.src}/bar.xml. 這些文件也許還是不存在的文件.
3 < filelist id="docfiles" dir="${doc.src}" files="foo.xml bar.xml"/>
4
5 < filelist refid="docfiles"/>
6
7 < filelist id="docfiles" dir="${doc.src}">
8 <file>
9 <file>
10 < /filelist>
12、fileset 文件類型
fileset 數據類型定義了一組文件,並通常表示為<fileset>元素。不過,許多ant任務構建成了隱式的fileset,這說明他們支持所有的fileset屬性和嵌套元素。以下為fileset 的屬性列表。 /<fileset>
● dir表示fileset 的基目錄。
● casesensitive的值如果為false,那麼匹配文件名時,fileset不是區分大小寫的,其默認值為true.
● defaultexcludes 用來確定是否使用默認的排除模式,默認為true。
● excludes 是用逗號分隔的需要派出的文件模式列表。
● excludesfile 表示每行包含一個排除模式的文件的文件名。
● includes 是用逗號分隔的,需要包含的文件模式列表。
● includesfile 表示每行包括一個包含模式的文件名。
示例
代碼如下:
1 < fileset id="lib.runtime" dir="${lib.path}/runtime">
2 <include>
3 <include>
4 <include>
5 < /fileset>
6
7 < fileset id="lib.container" dir="${lib.path}/container">
8 <include>
9 < /fileset>
10
11 < fileset id="lib.extras" dir="${lib.path}">
12 <include>
13 < /fileset>
13、patternset 類型
fileset 是對文件的分組,而patternset是對模式的分組,他們是緊密相關的概念。
<patternset>支持4個屬性:includes、excludex、includexfile、excludesfile,這些與fileset相同。/<patternset>
patternset 還允許以下嵌套元素:include,exclude,includefile 和 excludesfile.
示例
代碼如下:
1 < !-- 黑白名單 -->
2 < patternset id="non.test.sources">
3 <include>
4
5 <exclude>
6 < /patternset>
7
8
9 < patternset id="sources">
10 <include>
11
12 <include>
13 <exclude>
14 < /patternset>
15
16 < !-- 一組文件 -->
17 < patternset includesfile="some-file"/>
18 < patternset>
19 <includesfile>
20 < patternset/>
21
22 < patternset>
23 <includesfile>
24 <includesfile>
25 < patternset/>
14、filterset 類型
filterset定義了一組過濾器,這些過濾器將在文件移動或複製時完成文件的文本替換。
主要屬性如下:
● begintoken 表示嵌套過濾器所搜索的記號,這是標識其開始的字符串。
● endtoken 表示嵌套過濾器所搜索的記號這是標識其結束的字符串。
● id 是過濾器的唯一標誌符。
● refid 是對構建文件中某處定義一個過濾器的引用。
示例
代碼如下:
1 < !-- 將目標文件build.dir目錄中的version.txt文件內容中的@DATE@替換成TODAY當前日期的值,並把替換後的文件存放在dist.dir目錄中 -->
2 < copy file="${build.dir}/version.txt" toFile="${dist.dir}/version.txt">
3 <filterset>
4 <filter>
5
6 < /copy>
7
8 < !-- 自定義變量的格式 -->
9 < copy file="${build.dir}/version.txt" toFile="${dist.dir}/version.txt">
10
11 <filterset>
12 <filter>
13
14 < /copy>
15
16 < !-- 使用外部的過濾定義文件 -->
17 < copy toDir="${dist.dir}/docs">
18 <fileset>
19 <include>
20
21 <filterset>
22
23 <filtersfile>
24
25 < /copy>
26
27 < !-- 使用引用方式,重複利用過濾集 -->
28 < filterset id="myFilterSet" begintoken="%" endtoken="*">
29 <filter>
30 < /filterset>
31
32 < copy file="${build.dir}/version.txt" toFile="${dist.dir}/version.txt">
33 <filterset>
34 < /copy>
15、path類型
path元素用來表示一個類路徑,不過它還可以用於表示其他的路徑。在用作幾個屬性時,路經中的各項用分號或冒號隔開。在構建的時候,此分隔符將代替當前平臺中所有的路徑分隔符,其擁有的屬性如下。
● location 表示一個文件或目錄。Ant在內部將此擴展為一個絕對路徑。
● refid 是對當前構建文件中某處定義的一個path的引用。
● path表示一個文件或路徑名列表。
示例
代碼如下:
1 < path id="buildpath">
2 <fileset>
3 <fileset>
4 <fileset>
5 < /path>
6
7 < path id="src.paths">
8 <fileset>
9 <include>
10
11 < /path>
ant編譯打包、運行工程
代碼如下:
1 < ?xml version="1.0" encoding="UTF-8"?>
2 < !-- name是當前工程的名稱,default是默認執行的任務,basedir是工作目錄(.代表當前根目錄) -->
3 < project name="HelloWorld" default="run" basedir=".">
4
5 <property>
6 <property>
7 <property>
8
12
13
14 <target>
15
16 <mkdir>
17 <mkdir>
18 <mkdir>
19
20
21
22 <target>
23 <javac>
24
29
30
31
32 <target>
33
38
39
40 <manifest> /<manifest>
41 <attribute>
42 <attribute>
43
44
45
46 <copy>
47 <copy> /<copy>
48
49 <fileset> /<fileset>
50 <include>
51
52
53
54 <copy> /<copy>
55 <fileset>
56
57 <contains>
58 <size>
59
60
61
62
63
64 <move>
65
66
67
68 <gzip>
69
70 <unzip>
71
74
75
76
77 <target>
78 <java>
79
80
81
82 <target>
83
84 <delete>
85 <delete>
86
87
88 <tstamp> /<tstamp>
89 <format>
90 pattern="HH:mm:ss"
91 offset="10" unit="minute"/>
92
93
94
95 <target>
96 <echo>
97 <aunt>
98 <aunt>
99
100 < /project>
閱讀更多 已婚技術男 的文章