原文地址:http://tech.it168.com/j/2007-11-09/200711091344781.shtml
本文請勿轉(zhuǎn)載!
Ant是一個Apache基金會下的跨平臺的構(gòu)件工具,它可以實現(xiàn)項目的自動構(gòu)建和部署等功能。在本文中,主要讓讀者熟悉怎樣將Ant應(yīng)用到Java項目中,讓它簡化構(gòu)建和部署操作。
一. 安裝與配置
下載地址:http://ant.apache.org/,在本文中下載的是1.7.0版本。解壓到某個目錄(例如E:"apache-ant-1.7.0),即可使用。
添加系統(tǒng)環(huán)境變量:ANT_HOME,該變量指向Ant解壓后的根目錄,在此為E:"apache-ant-1.7.0。
安裝與配置完畢后,讀者可以測試一下Ant是否可用,首先進(jìn)入Ant的bin目錄,運行命令ant –version,若安裝和配置成功,則會顯示Ant版本信息,如下圖所示:

由上可以看出,讀者運行Ant的命令時,需要進(jìn)入到Ant的bin目錄,如何才能讓系統(tǒng)自動找到Ant呢?這時需要讀者在系統(tǒng)環(huán)境變量path中添加Ant的bin目錄。設(shè)置完成后,我們就可以在任何目錄(例如C:"Documents and Settings"AmigoXie目錄)輸入Ant的命令,來獲得命令的運行結(jié)果。
二. Ant的關(guān)鍵元素
Ant的構(gòu)件文件是基于XML編寫的,默認(rèn)名稱為build.xml。為了更清楚的了解Ant,在這里編寫一個簡單的Ant程序,用來展現(xiàn)Ant的功能,讓讀者對Ant有一個初步的了解。首先在E盤下建立一個build.xml文件,內(nèi)容如下:
<?xml version="1.0"?>
<project name="helloWorld">
<target name="sayHelloWorld">
<echo message="Hello,Amigo"/>
</target>
</project>

讀者可以進(jìn)入E盤,然后運行ant sayHelloWorld,可以看到如下的運行結(jié)果:

其中sayHelloWorld為需要執(zhí)行的任務(wù)的名稱。如果文件名不為build.xml,而為hello.xml時,讀者運行同樣的命令時,命令窗口會出現(xiàn)如下錯誤:
Buildfile: build.xml does not exist!
Build failed
由上面的命令的錯誤提示可以看出,ant命令默認(rèn)尋找build.xml文件。若文件名為hello.xml時,讀者還需要對命令做少許改變,改為:ant –f hello.xml sayHelloWorld、ant –buildfile hello.xml sayHelloWorld或ant –file hello.xml sayHelloWorld。
接下來開始向讀者講解本節(jié)的重點:Ant的關(guān)鍵元素project、target、property和task。
1. project元素
project元素是Ant構(gòu)件文件的根元素,Ant構(gòu)件文件至少應(yīng)該包含一個project元素,否則會發(fā)生錯誤。在每個project元素下,可包含多個target元素。接下來向讀者展示一下project元素的各屬性。
1)name屬性
用于指定project元素的名稱。
2)default屬性
用于指定project默認(rèn)執(zhí)行時所執(zhí)行的target的名稱。
3)basedir屬性
用于指定基路徑的位置。該屬性沒有指定時,使用Ant的構(gòu)件文件的附目錄作為基準(zhǔn)目錄。
下面給讀者一個簡單的例子來展示project的各元素的使用。修改E:"build.xml文件,修改后的內(nèi)容如下:
<?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>
從上面的內(nèi)容我們可以看出,在這里定義了default屬性的值為sayBaseDir,即當(dāng)運行ant命令時,若未指明執(zhí)行的target時,默認(rèn)執(zhí)行的target的sayBaseDir,同時還定義了basedir屬性的值為E:"apache-ant-1.7.0,進(jìn)入E盤后運行ant命令,可看到運行的結(jié)果,如下圖所示:

因為設(shè)定了basedir的值,所以basedir屬性的值變成了讀者設(shè)置的值。讀者可以自行將project元素的basedir屬性去掉后運行ant看看運行結(jié)果,此時basedir的值變成了E:",即為Ant構(gòu)件文件的父目錄。
有的時候,讀者可能有這種需求,即想得到某個project下所有的target的名稱,讀者可以通過在ant命令里加上-proecthelp來達(dá)到該目的。例如針對上述的例子我們運行ant –projecthelp,輸出結(jié)果如下:
Buildfile: build.xml
Main targets:
Other targets:
sayBaseDir
Default target: sayBaseDir
2. target元素
它為Ant的基本執(zhí)行單元,它可以包含一個或多個具體的任務(wù)。多個target可以存在相互依賴關(guān)系。它有如下屬性:
1)name屬性
指定target元素的名稱,這個屬性在一個project元素中是唯一的。我們可以通過指定target元素的名稱來指定某個target。
2)depends屬性
用于描述target之間的依賴關(guān)系,若與多個target存在依賴關(guān)系時,需要以“,”間隔。Ant會依照depends屬性中target出現(xiàn)的順序依次執(zhí)行每個target。被依賴的target會先執(zhí)行。
3)if屬性
用于驗證指定的屬性是否存在,若不存在,所在target將不會被執(zhí)行。
4)unless屬性
該屬性的功能與if屬性的功能正好相反,它也用于驗證指定的屬性是否存在,若不存在,所在target將會被執(zhí)行。
5)description屬性
該屬性是關(guān)于target功能的簡短描述和說明。
下面帶領(lǐng)讀者來看一個各屬性綜合使用的例子。修改E:"build.xml文件,修改后的內(nèi)容如下:
<?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>

進(jìn)入E盤后運行ant targetB,可看到如下圖所示的運行結(jié)果:

讀者分析結(jié)果后可以看到,我們運行的是名為targetB的target,因該target依賴于targetA,所以targetA將首先被執(zhí)行,同時因為系統(tǒng)安裝了java環(huán)境,所以ant.java.version屬性存在,執(zhí)行了targetA這個target,輸出信息:[echo] Java Version: 1.5,targetA執(zhí)行完畢后,接著執(zhí)行targetB,因為amigo不存在,而unless屬性是在不存在時進(jìn)入所在的target的,由此可知targetB得以執(zhí)行,輸出信息:The base dir is: E:"。
3. property元素
該元素可看作參量或者參數(shù)的定義,project的屬性可以通過property元素來設(shè)定,也可在Ant之外設(shè)定。若要在外部引入某文件,例如build.properties文件,可以通過如下內(nèi)容將其引入:<property file=” build.properties”/>
property元素可用作task的屬性值。在task中是通過將屬性名放在“${”和“}”之間,并放在task屬性值的位置來實現(xiàn)的。
Ant提供了一些內(nèi)置的屬性,它能得到的系統(tǒng)屬性的列表與Java文檔中System.getPropertis()方法得到的屬性一致,這些系統(tǒng)屬性可參考sun網(wǎng)站的說明。
同時,Ant還提供了一些它自己的內(nèi)置屬性,如下:
basedir:project基目錄的絕對路徑,該屬性在講解project元素時有詳細(xì)說明,不再贅述;
ant.file:buildfile的絕對路徑,如上面的各例子中,ant.file的值為E:"build.xml;
ant.version:Ant的版本,在本文中,值為1.7.0;
ant.project.name:當(dāng)前指定的project的名字,即前文說到的project的name屬性的值;
ant.java.version:Ant檢測到的JDK的版本,在上例運行結(jié)果中可看到為1.5。
下面讓讀者來看一個property元素使用的簡單例子。修改E:"build.xml文件,內(nèi)容如下:
<?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>
該例的運行結(jié)果如下圖所示:

由此讀者可以看出,通過如下兩個語句:
<property name="name" value="amigo"/>
<property name="age" value="25"/>
我們設(shè)置了名為name和age的兩個屬性,這兩個屬性設(shè)置后,讀者在下文中可以通過${name}和${age}分別取得這兩個屬性的值。
三. Ant的常用任務(wù)
在Ant工具中每一個任務(wù)封裝了具體要執(zhí)行的功能,是Ant工具的基本執(zhí)行單位。在本小節(jié)中,主要引導(dǎo)讀者來看下Ant的常用任務(wù)及其使用舉例。
1. copy任務(wù)
該任務(wù)主要用來對文件和目錄的復(fù)制功能。舉例如下:
Eg1.復(fù)制單個文件:<copy file="file.txt" tofile="copy.txt"/>
Eg2.對文件目錄進(jìn)行復(fù)制:
<copy todir="../newdir/dest_dir">
<fileset dir="src_dir"/>
</copy>
Eg3. 將文件復(fù)制到另外的目錄:
<copy file="file.txt" todir="../other/dir"/>
2. delete任務(wù)
對文件或目錄進(jìn)行刪除,舉例如下:
Eg1. 刪除某個文件:<delete file="photo/amigo.jpg"/>
Eg2. 刪除某個目錄:<delete dir="photo"/>
Eg3. 刪除所有的備份目錄或空目錄:
<delete includeEmptyDirs="true">
<fileset dir="." includes="**/*.bak"/>
</delete>
3. mkdir任務(wù)
創(chuàng)建目錄。eg:<mkdir dir="build"/>
4. move任務(wù)
移動文件或目錄,舉例如下:
Eg1. 移動單個文件:<move file="fromfile" tofile=”tofile”/>
Eg2. 移動單個文件到另一個目錄:<move file="fromfile" todir=”movedir”/>
Eg3. 移動某個目錄到另一個目錄:
<move todir="newdir">
<fileset dir="olddir"/>
</move>
5. echo任務(wù)
該任務(wù)的作用是根據(jù)日志或監(jiān)控器的級別輸出信息。它包括message、file、append和level四個屬性,舉例如下:
<echo message="Hello,Amigo" file="logs/system.log" append="true">
四. 利用Ant構(gòu)建和部署Java工程
Ant可以代替使用javac、java和jar等命令來執(zhí)行java操作,從而達(dá)到輕松的構(gòu)建和部署Java工程的目的。下面來看幾個知識點。
1. 利用Ant的javac任務(wù)來編譯java程序
Ant的javac任務(wù)用于實現(xiàn)編譯Java程序的功能。下面來看一個簡單的例子:
首先我們建立名為antstudy的Java工程,建立src目錄為源代碼目錄,在src目錄下建立HelloWorld.java這個類文件。該類文件的內(nèi)容如下:

public class HelloWorld
{

public static void main(String[] args)
{
System.out.println("Hello,Amigo");
}
}
同時在antstudy工程的根目錄下建立build.xml文件,在該文件中編譯src目錄下的java文件,并將編譯后的class文件放入build/classes目錄中,在編譯前,需清除classes目錄,該文件的內(nèi)容如下:
<?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. 使用Ant的java任務(wù)運行Java程序
Ant中可以使用java任務(wù)實現(xiàn)運行Java程序的功能。下面在1的例子中進(jìn)行如下的修改,修改后的build.xml文件的內(nèi)容如下:
<?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文件,可在控制臺看到HelloWorld的main方法的輸出。
3. 使用Ant的jar任務(wù)生成jar文件
讀者可以在上例的基礎(chǔ)上更進(jìn)一步,來生成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>
此時將ant的project的default屬性設(shè)置為jar,同時運行該build.xml文件,運行完畢后,可看到在工程目錄下生成了一個jar包HelloWorld.jar。
4. 使用Ant的war任務(wù)打包J2EE Web項目
建立一個J2EE Web工程,其目錄結(jié)構(gòu)如下圖所示:

其中src為源代碼目錄,WebRoot為各jsp存放目錄,lib為工程的包目錄。在antwebproject工程目錄下建立了build.xml文件,該文件為該工程的Ant構(gòu)件文件。讀者可以src目錄下放入在前續(xù)例子中開發(fā)的HelloWorld.java文件,并在WebRoot下建立index.jsp文件,其內(nèi)容很簡單,就是輸出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文件,其內(nèi)容如下:
<?xml version="1.0"?>
<project name="antwebproject" default="war"basedir=".">
<property name="classes" value="build/classes"/>
<property name="build"value="build"/>
<property name="lib"value="WebRoot/WEB-INF/lib"/>
<!-- 刪除build路徑-->
<target name="clean">
<delete dir="build"/>
</target>

<!-- 建立build/classes路徑,并編譯class文件到build/classes路徑下-->
<target name="compile" depends="clean">
<mkdir dir="${classes}"/>

<javac srcdir="src" destdir="${classes}"/>
</target>

<!-- 打war包-->
<target name="war" depends="compile">
<war destfile="${build}/antwebproject.war" webxml="WebRoot/WEB-INF/web.xml">
<!-- 拷貝WebRoot下除了WEB-INF和META-INF的兩個文件夾-->
<fileset dir="WebRoot" includes="**/*.jsp"/>

<!-- 拷貝lib目錄下的jar包-->
<lib dir="${lib}"/>
<!-- 拷貝build/classes下的class文件-->
<classesdir="${classes}"/>
</war>
</target>
</project>

各target的作用在內(nèi)容中已經(jīng)進(jìn)行說明,在此不再贅述。運行該build文件,更新目錄后,可看到在build目錄下生成了antwebproject.war文件,解開后可看到其目錄結(jié)構(gòu)如下:
--META-INF
--MANIFEST.MF
--index.jsp
--WEB-INF
--lib
--log4j-1.2.9.jar
--classes
--HelloWorld.class
--web.xml
讀者可以將該war包拷貝到Tomcat的目錄下看一下運行結(jié)果。
五. 總結(jié)
在本文中,筆者由淺至深詳細(xì)描述了Ant的安裝與配置、關(guān)鍵元素和常用任務(wù)。并通過實例講述了Ant在我們Java項目中的應(yīng)用,講述了編譯、運行java程序,以及打jar包、war包等知識,引領(lǐng)讀者進(jìn)入Ant的奇妙世界。在本文中可以看到,Ant在自動構(gòu)建和部署Java程序方面方便易用,而且非常靈活,不失為我們Java開發(fā)者的絕佳幫手。
posted on 2007-11-09 17:31
阿蜜果 閱讀(123995)
評論(30) 編輯 收藏 所屬分類:
Ant