1. 程式人生 > >ant build.xml教程詳解

ant build.xml教程詳解

Ant是一個Apache基金會下的跨平臺的構件工具,它可以實現專案的自動構建和部署等功能。在本文中,主要讓讀者熟悉怎樣將Ant應用到Java專案中,讓它簡化構建和部署操作。

一.安裝與配置

下載地址:http://ant.apache.org/,在本文中下載的是1.7.0版本。解壓到某個目錄(例如E:"apache-ant-1.7.0),即可使用。

window中設定ant環境變數:

ANT_HOME    E:/ apache-ant-1.7.0

path             E:/ apache-ant-1.7.0/bin

安裝與配置完畢後,讀者可以測試一下Ant是否可用,首先進入Ant

bin目錄,執行命令ant –version,若安裝和配置成功,則會顯示Ant版本資訊,如下圖所示:
   

由上可以看出,讀者執行Ant的命令時,需要進入到Antbin目錄,如何才能讓系統自動找到Ant呢?這時需要讀者在系統環境變數path中新增Antbin目錄。設定完成後,我們就可以在任何目錄(例如C:"Documents and Settings"AmigoXie目錄)輸入Ant的命令,來獲得命令的執行結果。

二.Ant的關鍵元素

Ant的構件檔案是基於XML編寫的,預設名稱為build.xml。為了更清楚的瞭解Ant,在這裡編寫一個簡單的Ant程式,用來展現Ant的功能,讓讀者對

Ant有一個初步的瞭解。首先在E盤下建立一個build.xml檔案,內容如下:

<?xml version="1.0"?><project name="helloWorld"><target name="sayHelloWorld"><echo message="Hello,Amigo"/></target></project>

讀者可以進入E盤,然後執行ant sayHelloWorld,可以看到如下的執行結果:
    

其中sayHelloWorld為需要執行的任務的名稱。如果檔名不為build.xml,而為hello.xml

時,讀者運行同樣的命令時,命令視窗會出現如下錯誤:

Buildfile: build.xml does not exist!

Build failed

由上面的命令的錯誤提示可以看出,ant命令預設尋找build.xml檔案。若檔名為hello.xml時,讀者還需要對命令做少許改變,改為:ant –f hello.xml sayHelloWorldant –buildfile hello.xml sayHelloWorldant –file hello.xml sayHelloWorld

接下來開始向讀者講解本節的重點:Ant的關鍵元素projecttargetpropertytask

1.project元素

project元素是Ant構件檔案的根元素,Ant構件檔案至少應該包含一個project元素,否則會發生錯誤。在每個project元素下,可包含多個target元素。接下來向讀者展示一下project元素的各屬性。

1name屬性

用於指定project元素的名稱。

2default屬性

用於指定project預設執行時所執行的target的名稱。

3basedir屬性

用於指定基路徑的位置。該屬性沒有指定時,使用Ant的構件檔案的附目錄作為基準目錄。

下面給讀者一個簡單的例子來展示project的各元素的使用。修改E:"build.xml檔案,修改後的內容如下:

<?xml version="1.0"?><project name="projectStudy" default="sayBaseDir" basedir="E:"apache-ant-1.7.0"><target name="sayBaseDir"><echo message="The base dir is: ${basedir}"/></target></project>

從上面的內容我們可以看出,在這裡定義了default屬性的值為sayBaseDir,即當執行ant命令時,若未指明執行的target時,預設執行的targetsayBaseDir,同時還定義了basedir屬性的值為E:"apache-ant-1.7.0,進入E盤後執行ant命令,可看到執行的結果,如下圖所示:
   

因為設定了basedir的值,所以basedir屬性的值變成了讀者設定的值。讀者可以自行將project元素的basedir屬性去掉後執行ant看看執行結果,此時basedir的值變成了E:",即為Ant構件檔案的父目錄。

有的時候,讀者可能有這種需求,即想得到某個project下所有的target的名稱,讀者可以通過在ant命令里加上-proecthelp來達到該目的。例如針對上述的例子我們執行ant –projecthelp,輸出結果如下:

Buildfile: build.xml

Main targets:

Other targets:

 sayBaseDir

Default target: sayBaseDir

2.target元素

它為Ant的基本執行單元,它可以包含一個或多個具體的任務。多個target可以存在相互依賴關係。它有如下屬性:

1name屬性

指定target元素的名稱,這個屬性在一個project元素中是唯一的。我們可以通過指定target元素的名稱來指定某個target

2depends屬性

用於描述target之間的依賴關係,若與多個target存在依賴關係時,需要以“,”間隔。Ant會依照depends屬性中target出現的順序依次執行每個target。被依賴的target會先執行。

3if屬性

用於驗證指定的屬性是否存在,若不存在,所在target將不會被執行。

4unless屬性

該屬性的功能與if屬性的功能正好相反,它也用於驗證指定的屬性是否存在,若不存在,所在target將會被執行。

5description屬性

該屬性是關於target功能的簡短描述和說明。

下面帶領讀者來看一個各屬性綜合使用的例子。修改E:"build.xml檔案,修改後的內容如下:

<?xml version="1.0"?><project name="targetStudy"><target name="targetA" if="ant.java.version"><echo message="Java Version: ${ant.java.version}"/></target><target name="targetB" depends="targetA" unless="amigo"><description>
                            a depend example!
              
</description><echo message="The base dir is: ${basedir}"/></target></project>

進入E盤後執行ant targetB,可看到如下圖所示的執行結果:
   

讀者分析結果後可以看到,我們執行的是名為targetBtarget,因該target依賴於targetA,所以targetA將首先被執行,同時因為系統安裝了java環境,所以ant.java.version屬性存在,執行了targetA這個target,輸出資訊:[echo] Java Version: 1.5targetA執行完畢後,接著執行targetB,因為amigo不存在,而unless屬性是在不存在時進入所在的target的,由此可知targetB得以執行,輸出資訊:The base dir is: E:"

3.property元素

該元素可看作參量或者引數的定義,project的屬性可以通過property元素來設定,也可在Ant之外設定。若要在外部引入某檔案,例如build.properties檔案,可以通過如下內容將其引入:<property file=” build.properties”/>

property元素可用作task的屬性值。在task中是通過將屬性名放在“${”和“}”之間,並放在task屬性值的位置來實現的。

Ant提供了一些內建的屬性,它能得到的系統屬性的列表與Java文件中System.getPropertis()方法得到的屬性一致,這些系統屬性可參考sun網站的說明。

同時,Ant還提供了一些它自己的內建屬性,如下:

basedirproject基目錄的絕對路徑,該屬性在講解project元素時有詳細說明,不再贅述;

ant.filebuildfile的絕對路徑,如上面的各例子中,ant.file的值為E:"build.xml

ant.versionAnt的版本,在本文中,值為1.7.0

ant.project.name:當前指定的project的名字,即前文說到的projectname屬性的值;

ant.java.versionAnt檢測到的JDK的版本,在上例執行結果中可看到為1.5

下面讓讀者來看一個property元素使用的簡單例子。修改E:"build.xml檔案,內容如下:

<?xml version="1.0"?><project name="propertyStudy" default="example"><property name="name" value="amigo"/><property name="age" value="25"/><target name="example"><echo message="name: ${name}, age: ${age}"/></target></project>

該例的執行結果如下圖所示:
   

由此讀者可以看出,通過如下兩個語句:

<property name="name" value="amigo"/>

<property name="age" value="25"/>

我們設定了名為nameage的兩個屬性,這兩個屬性設定後,讀者在下文中可以通過${name}${age}分別取得這兩個屬性的值。

三.Ant的常用任務

Ant工具中每一個任務封裝了具體要執行的功能,是Ant工具的基本執行單位。在本小節中,主要引導讀者來看下Ant的常用任務及其使用舉例。

1.copy任務

該任務主要用來對檔案和目錄的複製功能。舉例如下:

Eg1.複製單個檔案:<copy file="file.txt" tofile="copy.txt"/>

Eg2.對檔案目錄進行復制:

   <copy todir="../newdir/dest_dir">

            <fileset dir="src_dir"/>

 </copy>

Eg3. 將檔案複製到另外的目錄:

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

2.delete任務

對檔案或目錄進行刪除,舉例如下:

Eg1. 刪除某個檔案:<delete file="photo/amigo.jpg"/>

Eg2. 刪除某個目錄:<delete dir="photo"/>

Eg3. 刪除所有的備份目錄或空目錄:

        <delete includeEmptyDirs="true">

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

        </delete>

3.mkdir任務

建立目錄。eg<mkdir dir="build"/>

4.move任務

移動檔案或目錄,舉例如下:

Eg1. 移動單個檔案:<move file="fromfile" tofile=”tofile”/>

Eg2. 移動單個檔案到另一個目錄:<move file="fromfile" todir=”movedir”/>

Eg3. 移動某個目錄到另一個目錄:

        <move todir="newdir">

               <fileset dir="olddir"/>

        </move>

5.echo任務

該任務的作用是根據日誌或監控器的級別輸出資訊。它包括messagefileappendlevel四個屬性,舉例如下:

<echo message="Hello,Amigo" file="logs/system.log" append="true">

四.利用Ant構建和部署Java工程

Ant可以代替使用javacjavajar等命令來執行java操作,從而達到輕鬆的構建和部署Java工程的目的。下面來看幾個知識點。

1.利用Antjavac任務來編譯java程式

Antjavac任務用於實現編譯Java程式的功能。下面來看一個簡單的例子:

首先我們建立名為antstudyJava工程,建立src目錄為原始碼目錄,在src目錄下建立HelloWorld.java這個類檔案。該類檔案的內容如下:

publicclass HelloWorld {
    
publicstaticvoid main(String[] args) {
       System.out.println("Hello,Amigo");
    }
}

同時在antstudy工程的根目錄下建立build.xml檔案,在該檔案中編譯src目錄下的java檔案,並將編譯後的class檔案放入build/classes目錄中,在編譯前,需清除classes目錄,該檔案的內容如下:

<?xml version="1.0"?><project name="javacTest"default="compile" basedir="."><target name="clean"><delete dir="build"/></target><target name="compile" depends="clean"><mkdir dir="build/classes"/><javac srcdir="src" destdir="build/classes"/></target></project>

執行該build.xml檔案,可在工程中看到新增了build/classes目錄,並在該目錄中生成了編譯後的HelloWorld.class檔案。

2.使用Antjava任務執行Java程式

Ant中可以使用java任務實現執行Java程式的功能。下面在1的例子中進行如下的修改,修改後的build.xml檔案的內容如下:

<?xml version="1.0"?><project name="javaTest" default="jar" basedir="."><target name="clean"><delete dir="build"/></target><target name="compile" depends="clean"><mkdir dir="build/classes"/><javac srcdir="src" destdir="build/classes"/></target><target name="run" depends="compile"><java classname="HelloWorld"><classpath><pathelement path="build/classes"/></classpath></java></target></project>

執行該build.xml檔案,可在控制檯看到HelloWorldmain方法的輸出。

3.使用Antjar任務生成jar檔案

讀者可以在上例的基礎上更進一步,來生成jar包,可在run這個target下再加上如下target

<target name="jar" depends="run"><jar destfile="helloworld.jar" basedir="build/classes"><manifest><attribute name="Main-class" value="HelloWorld"/></manifest></jar></target>

此時將antprojectdefault屬性設定為jar,同時執行該build.xml檔案,執行完畢後,可看到在工程目錄下生成了一個jarHelloWorld.jar

4.使用Antwar任務打包J2EE Web專案

建立一個J2EE Web工程,其目錄結構如下圖所示:

其中src為原始碼目錄,WebRoot為各jsp存放目錄,lib為工程的包目錄。在antwebproject工程目錄下建立了build.xml檔案,該檔案為該工程的Ant構件檔案。讀者可以src目錄下放入在前續例子中開發的HelloWorld.java檔案,並在WebRoot下建立index.jsp檔案,其內容很簡單,就是輸出Hello資訊,程式碼如下所示:

<%@ page language="java" contentType="text/html; charset="UTF-8" pageEncoding="UTF-8"%><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ant打包測試</title></head><body>
       Hello,Ant
    
</body></html>

接下來編寫build.xml檔案,其內容如下:

<?xml version="1.0"?><project name="antwebproject"  default="war"basedir="."><property name="cla