本內(nèi)容包含了Ant的歷史簡要介紹,Ant的功能以及Ant框架的介紹,并對下載安裝使用Ant進行了示例介紹,同時通過一個Java程序講解了Ant的基本使用方法。
1. Ant簡介:這里引用Ant幫助文檔中對Ant的介紹:
Apache Ant是一個基于Java的構建工具。從理論上講,也是一種類似于Make的工具,只是去除了Make工具的缺點。 既然已經(jīng)有了make, gnumake, nmake, jam以及其他的構件工具,為什么還要Ant呢?因為Ant的早期開發(fā)者發(fā)現(xiàn)所有以上這些工具都或多或少的有一些局限性,使得在跨平臺開發(fā)軟件成為困難。類似于Make的工具都是傳統(tǒng)的基于Shell的--首先進行依賴性檢查,然后執(zhí)行命令。這意味著你可以輕易的通過使用或者編寫程序來擴展這些工具,以滿足不同的平臺。當然,這也意味著你將局限于特定的平臺,至少可以說局限于特定類型的平臺,例如:Unix平臺。 |
||
同時,Make文件也有一些先天的缺陷。好多人都會遇到恐怖的tab問題。Ant的最初開發(fā)者多次說“我的命令不能執(zhí)行因為我在tab前面加了一個空格!”。一些工具如Jam一定程序上解決了這個問題,但仍有其它的格式問題。
Ant與從基于命令的那些擴展開來的那些工具不同,Ant是由java類擴展的。不用編寫shell命令,而是配置基于XML的文件,形成多個任務的目標配置樹。每一個任務都是通過一個實現(xiàn)了一個規(guī)定接口的java類來運行的。
ant缺少了一些直接執(zhí)行shell命令的能力,如find . -name foo -exec rm {},但它給用戶提供了跨平臺的能力,可以在任何地方工作。實際上,Ant也提供了命令execute用來執(zhí)行shell命令,這就是它的任務,它允許執(zhí)行基于操作系統(tǒng)的命令。 簡單的說,Ant是一個基于Java,并且主要用于Java工程的構建工具。Ant本意是Another Neat Tool,也就是另一種整潔的工具,取首字符就是Ant。
構建工具就是為了減少重復工作而產(chǎn)生的。
2. Ant的一些核心概念:
XML:構建文件是以XML文件來描述的,采用XML格式有很多好處。這里就不一一列舉。
陳述式語法:構建文件短小精悍,且易于理解。
每個構建文件包含一個工程(project)。
每個工程包含若干個目標(target)。
目標可以依賴于其他的目標(depends)。
目標包含任務(task)。
易于使用Java語言增加新的任務---易于擴展(自定義)。
3. Ant結構:
Ant的結構如下圖所示:
![]() 構建文件的概念視圖:工程包含一個目標的集合。在每個目標里是任務的聲明,它們是對Ant用于構建該目標的行為說明。目標生成一個依賴關系圖表來聲明該目標的依賴關系。當執(zhí)行一個目標時,必須先執(zhí)行它們依賴的目標。 例子:一個典型的構建文件:
<?xml version="1.0" ?>
<project name="OurProject" default="deploy">
<target name="init">
<mkdir dir="build/classes" />
<mkdir dir="dist" />
</target>
<target name="compile" depends="init" >
<javac srcdir="src" destdir="build/classes"/>
</target>
<target name="doc" depends="init" >
<javadoc destdir="build/classes" sourcepath="src" packagenames="org.*" />
</target>
<target name="deploy" depends="compile,doc" >
<jar destfile="dist/project.jar" basedir="build/classes"/>
<ftp server="" userid="" password=""> <fileset dir="dist"/>
</ftp>
</target>
</project>
該構建過程如下:
系統(tǒng)初始化1、編譯 2、生成JAVADOC 4、打包 5、上傳到FTP,其中后兩步結合到一起叫部署。
執(zhí)行時輸出如下:
> ant -propertyfile ftp.properties
Buildfile: build.xml
init:
[mkdir] Created dir: /home/ant/Projects/OurProject/build/classes
[mkdir] Created dir: /home/ant/Projects/OurProject/dist
compile:
[javac] Compiling 1 source file to /home/ant/Projects/OurProject/build/
classes
doc:
[javadoc] Generating Javadoc
[javadoc] Javadoc execution
[javadoc] Loading source files for package org.example.antbook.lesson1...
[javadoc] Constructing Javadoc information...
[javadoc] Building tree for all the packages and classes...
[javadoc] Building index for all the packages and classes...
[javadoc] Building index for all classes...
deploy:
[jar] Building jar: /home/ant/Projects/OurProject/dist/project.jar
[ftp] sending files
[ftp] 1 files sent
BUILD SUCCESSFUL
Total time: 5 seconds.
在執(zhí)行時使用命令行參數(shù)以傳入一個屬性文件,屬性文件中包含連接FTP服務器使用的服務器名,用戶名,用戶密碼來給特性使用。 這個例子很好的展示了Ant的一些基本要素:目標依賴、特性的使用、編譯、文檔生成、JAR打包(tar,Zip,WAR,EAR等),最后是部署。
Ant的簡單任務(<mkdir>)都是由Java類庫來實現(xiàn)相應的功能。而一些復雜的任務<ftp>、<junit>還需要第三方庫的支持。
Ant的一個強大之處:它總能工作。只要正確的指定構建文件,Ant就能計算出目標的依賴性,并且按照正確的順序調(diào)用目標。目標通過任務按序執(zhí)行,而任務自身處理其文件依賴性以及實際的操作來完成工作。因為每個任務通常都是在高層陳述,所以一兩行XML語句經(jīng)常就已經(jīng)足夠描述任務的內(nèi)容。
4. 下載并安裝Ant
使用Ant前提條件,系統(tǒng)中已經(jīng)安裝JDK以及Ant。在文檔編寫之時,Ant的最新版本是Ant 1.7,但是為了穩(wěn)定性,本文檔使用版本為Ant 1.6.5.
首先下載Ant,到apache軟件網(wǎng)站http://www.apache.org/。
其次,解壓縮文件,放到指定的系統(tǒng)目錄中,例如C:\Ant。
再次,將其添加到path,以便從命令行使用。(一些IDE,例如Eclipse可以不需要設置path,而通過IDE相關設置將Ant添加到path中。)
再次,設置一些環(huán)境變量指向JDK以及ANT。
最后,添加需要的可選庫。
在Windows安裝過程(以筆者的安裝過程為例)
下載apache-ant-1.6.5-bin.zip到本地硬盤,解壓縮之后將文件夾命名為Ant,放在C:\Ant中。這個目錄就是Ant主目錄。
應該將主目錄中的bin目錄添加到path屬性中,這樣就可以在命令行中調(diào)用ant命令,ANT_HOME是批處理文件所在目錄的上級目錄。最好明確設定。
現(xiàn)在許多工具已經(jīng)集成了特定版本的Ant,一些操作系統(tǒng)甚至默認的已經(jīng)安裝了Ant。所以,你的系統(tǒng)中可能已經(jīng)安裝了Ant。
首先可以通過運行以下命令:
ant -version 和 ant -diagnostics 來確定。我們推薦您不設置CLASSPATH來運行Ant命令。如果任何版本的Ant可以從CLASSPATH加載 ,這時就會由于加載了不兼容的類而產(chǎn)生許多錯誤。 一些其他問題請參閱Ant的FAQ設置。
正常情況下,執(zhí)行ant ?Cversion即可顯示Ant版本,則說明安裝配制成功:
![]() 5. 運行第一個構建文件:
首先創(chuàng)建一個Java工程,名為AntProject,工程中源文件和目標文件是分開的,分別為文件夾src和bin,然后創(chuàng)建一個Java類文件,類名為
com.neusoft.test.AntTest,只是為了測試,所以類的內(nèi)容很簡單:
package com.neusoft.test;
/**
*This is just a test class.
*/
public class AntTest{
public static void main(String[] args){
for(int i=0;i<args.length;i++){
System.out.println(args[i]);
}
}
}
然后我們在工程的路徑下面建立一個構建文件build.xml,內(nèi)容如下:
<?xml version="1.0" ?>
<project name="structured" default="archive" >
<target name="init">
<mkdir dir="build/classes" />
<mkdir dir="dist" />
</target>
<target name="compile" depends="init" >
<javac srcdir="src" destdir="build/classes"/>
</target>
<target name="archive" depends="compile" >
<jar destfile="dist/project.jar"
basedir="build/classes" />
</target>
<target name="clean" depends="init">
<delete dir="build" />
<delete dir="dist" />
</target>
</project>
構建文件說明如下圖:
![]() 關于XML的知識,請參考其他書籍,這里不做介紹。 以上創(chuàng)建完成后,目錄結構如下圖:
![]() Ant構建文件總是有一個<project>元素做為根元素,它有兩個屬性,name和default,<target>元素是<project>元素的子元素,可以有多個,它有兩個屬性,name和depends,<target>元素包含的元素就是一些任務元素。
<target>可以由命令行進行顯示的調(diào)用,也可以在內(nèi)部使用如可以直接調(diào)用ant init、ant compile等。如果不寫參數(shù),則默認的build文件是build.xml,默認的目標是<project>的default屬性定義的目標。目標的名稱是唯一的,可以是任意字符串。
下面我們先運行一下這個Ant構建,再講解其他的內(nèi)容,進入工程目錄,執(zhí)行
ant
這里就相當于執(zhí)行默認的目標,也就是<project name="structured" default="archive" >中的archive目標。
![]() 這里說明了首先初始化創(chuàng)建兩個目錄,然后編譯了一個JAVA文件,然后進行了打包的操作。
這里講解一下如果構建失敗了怎么辦?
首先有可能是XML語法書寫不正確(將<target>寫成<targe>),或者在任務執(zhí)行過程中出現(xiàn)了錯誤(.java文件中包含編譯錯誤),或者任務名稱書寫錯誤(將<javac>寫成<javacc>)等等,這些都不是Ant的錯誤,不需要填寫B(tài)ug Report。寫XML時一定要細心,一些IDE已經(jīng)有驗證功能,可以很好的防止書寫的錯誤。
出現(xiàn)錯誤時,可以使用
ant ?Cverbose
或者
ant ?Cdebug來獲取更加詳細的構建信息,以解決問題。
下圖是使用ant ?Cverbose時的輸出,使用ant ?Cdebug將獲取比這更詳細的信息,這里就不舉例了。
![]() 本例中直接使用了軟件工程中的構建結構,使用src作為源文件目錄,build/class作為中間生成文件,以dist作為可發(fā)布文件。在最后把一些可執(zhí)行文件可以放在bin目錄中。此時目錄結構如下圖所示:
![]() 我們需要一種辦法來確定某些任務先執(zhí)行,而有些任務后執(zhí)行,比如必須先編譯,才能執(zhí)行程序或者打包。我們在聲明目標的時候,就在其依賴屬性中列出其依賴關系:
<target name="compile" depends="init" >
<target name="archive" depends="compile" >
<target name="clean" depends="init">
如果一個目標依賴與多個其他目標,需要將它們都寫到依賴屬性中,例如:
depents=”compile,test”。在我們的構建中,archive依賴于init和compile,但是我們不需要去寫,因為compile已經(jīng)依賴于init了。即:Ant的依賴關系是傳遞的,但不是自反的。
![]() 如果在執(zhí)行過程中兩個目標共享同一個目標,則先導目標只被執(zhí)行一次。 可以通過指定目標來運行構建:
例如執(zhí)行完ant后,可以執(zhí)行ant clean來清理構建:
![]() ant等價于ant archive
ant init
ant clean
ant compile
ant archive
ant clean archive
當構建完成一次以后,再次執(zhí)行構建會發(fā)生什么呢?
![]() 第二次執(zhí)行構建時只花了2s,相比第一次的4s。并且沒有任何一個目標表示做了任何工作。
原因如下:所有的任務都檢查了它們的依賴關系:
<mkdir>沒有創(chuàng)建目錄因為已經(jīng)存在
<javac>比較了源文件和類文件的時間戳
<jar>比較了要被加入文件與已經(jīng)存在文件的時間
只有更新的時候才進行任務執(zhí)行。
Ant如何處理命令行上的多個目標?
執(zhí)行ant compile archive會怎么樣?
先實驗一下:
![]() Ant依次執(zhí)行每個目標和其依賴目標,即Ant的執(zhí)行順序是init compile init compile archive,雖然這樣看起來增加了額外的工作,但是通過上面的執(zhí)行過程就會發(fā)現(xiàn),由于其依賴性檢查的阻止,第二次的init和compile并未真正的執(zhí)行,執(zhí)行時間與直接執(zhí)行archive的時間是一樣的。
運行程序:
普通執(zhí)行該類的方法是:
java ?Ccp build/class com.neusoft.test.AntTest args1 args2
而我們使用Ant的任務來執(zhí)行它僅僅需要增加一個任務,好處在于:
讓用于執(zhí)行的目標依賴與編譯的目標,確保運行最新版本
易于傳遞復雜參數(shù)
設置classpath更方便
在Ant自身的JVM中運行,載入更快
增加一個新的目標:
<target name="execute" depends="compile">
<java classname="com.neusoft.test.AntTest"
classpath="build/classes">
<arg value="a"/>
<arg value="b"/>
<arg file="."/>
</java>
</target>
最后一個參數(shù)是file=”.”,表示傳入的參數(shù)是一個目錄,為文件絕對路徑。
運行該目標,輸出如下:
![]() Ant命令行選項:
![]() 請參閱相關手冊進行查詢相關選項的功能。
當有多個構建文件時,可以指定構建文件:
ant ?Cbuildfile build.xml compile
來表示執(zhí)行build.xml這個構建文件中的compile目標。
控制提供的信息量:
ant ?Cquiet:安靜模式,不給出任何輸出。
![]() ant ?Cemacs:簡單模式,不顯示任務名稱。
![]() ant ?Cprojecthelp:獲取項目信息。
![]() 最終的構建文件,添加了description屬性。
<?xml version="1.0" ?>
<project name="secondbuild" default="execute" >
<description>Compiles and runs a simple program</description>
<target name="init">
<mkdir dir="build/classes" />
<mkdir dir="dist" />
</target>
<target name="compile" depends="init"
description="Compiles the source code">
<javac srcdir="src" destdir="build/classes"/>
</target>
<target name="archive" depends="compile"
description="Creates the JAR file">
<jar destfile="dist/project.jar" basedir="build/classes"/>
</target>
<target name="clean" depends="init"
description="Removes the temporary directories used">
<delete dir="build" />
<delete dir="dist" />
</target>
<target name="execute" depends="compile"
description="Runs the program">
<echo level="warning" message="running" />
<java classname="org.example.antbook.lesson1.Main"
classpath="build/classes">
<arg value="a"/>
<arg value="b"/>
<arg file="."/>
</java>
</target>
</project> |