ant教程

Ant是一個Apache基金會下的跨平臺的構件工具，它能夠實現項目的自動構建和部署等功能。在本文中，主要讓讀者熟悉怎樣將Ant應用到Java項目中，讓它簡化構建和部署操做。 
一．             安裝與配置

下載地址：http://ant.apache.org/，在本文中下載的是1.7.0版本。解壓到某個目錄（例如E:"apache-ant-1.7.0），便可使用。

添加系統環境變量：ANT_HOME，該變量指向Ant解壓後的根目錄，在此爲E:"apache-ant-1.7.0。

安裝與配置完畢後，讀者能夠測試一下Ant是否可用，首先進入Ant的bin目錄，運行命令ant –version，若安裝和配置成功，則會顯示Ant版本信息，以下圖所示：    

由上能夠看出，讀者運行Ant的命令時，須要進入到Ant的bin目錄，如何才能讓系統自動找到Ant呢？這時須要讀者在系統環境變量path中添加Ant的bin目錄。設置完成後，咱們就能夠在任何目錄（例如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 sayHelloWorld、ant –buildfile hello.xml sayHelloWorld或ant –file hello.xml sayHelloWorld。

接下來開始向讀者講解本節的重點：Ant的關鍵元素project、target、property和task。

1.       project元素

project元素是Ant構件文件的根元素，Ant構件文件至少應該包含一個project元素，不然會發生錯誤。在每一個project元素下，可包含多個target元素。接下來向讀者展現一下project元素的各屬性。

1）name屬性

用於指定project元素的名稱。

2）default屬性

用於指定project默認執行時所執行的target的名稱。

3）basedir屬性

用於指定基路徑的位置。該屬性沒有指定時，使用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時，默認執行的target的sayBaseDir，同時還定義了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能夠存在相互依賴關係。它有以下屬性：

1）name屬性

指定target元素的名稱，這個屬性在一個project元素中是惟一的。咱們能夠經過指定target元素的名稱來指定某個target。

2）depends屬性

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

3）if屬性

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

4）unless屬性

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

5）description屬性

該屬性是關於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，可看到以下圖所示的運行結果：    

讀者分析結果後能夠看到，咱們運行的是名爲targetB的target，因該target依賴於targetA，因此targetA將首先被執行，同時由於系統安裝了java環境，因此ant.java.version屬性存在，執行了targetA這個target，輸出信息：[echo] Java Version: 1.5，targetA執行完畢後，接着執行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還提供了一些它本身的內置屬性，以下：

basedir：project基目錄的絕對路徑，該屬性在講解project元素時有詳細說明，再也不贅述；

ant.file：buildfile的絕對路徑，如上面的各例子中，ant.file的值爲E:"build.xml；

ant.version：Ant的版本，在本文中，值爲1.7.0；

ant.project.name：當前指定的project的名字，即前文說到的project的name屬性的值；

ant.java.version：Ant檢測到的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"/>

咱們設置了名爲name和age的兩個屬性，這兩個屬性設置後，讀者在下文中能夠經過${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任務

該任務的做用是根據日誌或監控器的級別輸出信息。它包括message、file、append和level四個屬性，舉例以下：

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

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

Ant能夠代替使用javac、java和jar等命令來執行java操做，從而達到輕鬆的構建和部署Java工程的目的。下面來看幾個知識點。

1.       利用Ant的javac任務來編譯java程序

Ant的javac任務用於實現編譯Java程序的功能。下面來看一個簡單的例子：

首先咱們創建名爲antstudy的Java工程，創建src目錄爲源代碼目錄，在src目錄下創建HelloWorld.java這個類文件。該類文件的內容以下：

public class HelloWorld  {     public static void 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.       使用Ant的java任務運行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文件，可在控制檯看到HelloWorld的main方法的輸出。

3.       使用Ant的jar任務生成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>

此時將ant的project的default屬性設置爲jar，同時運行該build.xml文件，運行完畢後，可看到在工程目錄下生成了一個jar包HelloWorld.jar。

4.       使用Ant的war任務打包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="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的做用在內容中已經進行說明，在此再也不贅述。運行該build文件，更新目錄後，可看到在build目錄下生成了antwebproject.war文件，解開後可看到其目錄結構以下：

--META-INF

     --MANIFEST.MF

--index.jsp

--WEB-INF

     --lib

            --log4j-1.2.9.jar

     --classes

            --HelloWorld.class

     --web.xml

     讀者能夠將該war包拷貝到Tomcat的目錄下看一下運行結果。

五．             總結

在本文中，筆者由淺至深詳細描述了Ant的安裝與配置、關鍵元素和經常使用任務。並經過實例講述了Ant在咱們Java項目中的應用，講述了編譯、運行java程序，以及打jar包、war包等知識，引領讀者進入Ant的奇妙世界。在本文中能夠看到，Ant在自動構建和部署Java程序方面方便易用，並且很是靈活，不失爲咱們Java開發者的絕佳幫手

學習目標：basedir

<?xml version= "1.0" ?>

<project name= "projectStudy"  default = "sayBaseDir"  basedir= "D:\myec" >

        <target name= "sayBaseDir"  description= "打印提示信息" >

               <echo message= "The base dir is: ${basedir}" />

        </target>

</project>

  

  

學習目標：建立目錄

<?xml version= "1.0" ?>

<project name= "propertyStudy"  default = "mkdir"  description= "建立目錄" >

     <target name= "mkdir" >

         <mkdir dir= "mkdirTest" />

     </target>

</project>

 

 

 

學習目標：property變量

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

學習目標：拷貝單個文件 與 文件夾

<?xml version= "1.0" ?>

<project name= "propertyStudy"  default = "copydir" >

     <target name= "copyfile"  description= "拷貝文件" >

         <copy file= "antStudy.txt"  tofile= "copy.txt" />

     </target>

     

     <target name= "copydir"  description= "拷貝目錄" >

         <copy todir= "../AntProject/src_copy" >

               <fileset dir= "src" />

          </copy>

     </target>

</project>

 

 

學習目標：刪除單個文件 與 文件夾 / 刪除備份目錄及空目錄

<?xml version= "1.0" ?>

<project name= "propertyStudy"  default = "deldir" >

     <target name= "delfile"  description= "刪除文件" >

         <delete file= "src_copy/com/cyjch/test/AntTest.java"  />

     </target>

 

     <target name= "deldir"  description= "刪除目錄" >

         <delete dir= "../AntProject/src_copy"  />

     </target>

 

     <target name= "delBakAndEmpty"  description= "刪除空目錄及備份目錄" >

         <delete includeEmptyDirs= "true" >

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

         </delete>

     </target>

</project>

 

 

學習目標：移動文件、目錄

<?xml version= "1.0" ?>

<project name= "propertyStudy"  default = "moveDirToDir" >

     <target name= "moveFile"  description= "移動文件" >

         <move file= "mkdirTest/cantStudy.txt"  tofile= "cantStudy.txt" />

     </target>

 

     <target name= "moveFileToDir"  description= "移動目錄" >

         <move file= "cantStudy.txt"  todir= "mkdirTest" />

     </target>

 

     <target name= "moveDirToDir"  description= "移動目錄到目錄，也可作爲目錄改名" >

         <move todir= "mkdirTestNew" >

             <fileset dir= "mkdirTest" />

         </move>

     </target>

</project>

學習目標：編譯

<?xml version= "1.0" ?>

<project name= "javacTest"  default = "compile"  basedir= "." >

     <target name= "clean"  description= "刪除編譯後產生的目錄及文件" >

         <delete dir= "build"  />

     </target>

 

     <target name= "compile"  depends= "clean"  description= "編譯源文件" >

         <mkdir dir= "build/classes"  />

         <javac srcdir= "src"  destdir= "build/classes"  />

     </target>

</project>

 

 

 

學習目標：編譯並運行JAVA程序

<?xml version= "1.0" ?>

<project name= "javaTest"  default = "run"  basedir= "." >

     <target name= "clean"  description= "清除目錄" >

         <delete dir= "build"  />

     </target>

 

     <target name= "compile"  depends= "clean"  description= "編譯" >

         <mkdir dir= "build/classes"  />

         <javac srcdir= "src"  destdir= "build/classes"  />

     </target>

 

     <target name= "run"  depends= "compile"  description= "運行" >

         <java classname= "AntTest" >

             <classpath>

                 <pathelement path= "build/classes"  />

             </classpath>

         </java>

     </target>

</project>

 

 

 

學習目標：打JAR包

<?xml version= "1.0" ?>

<project name= "javaTest"  default = "jar"  basedir= "." >

     <target name= "jar"  description= "打JAR包" >

         <jar destfile= "helloworld.jar"  basedir= "build/classes" >

             <manifest>

                 <attribute name= "Main-class"  value= "HelloWorld"  />

             </manifest>

         </jar>

     </target>

</project>

 

 

學習目標：打WAR包

學習目標：mkdir srcdir destdir delete war jar

<?xml version= "1.0" ?>

<!--默認爲打包操做-->

<project name= "structured"  default = "archive" >

     <description>編譯並打包一個應用程序</description>

     <!--在工程目錄下建立輸出目錄：build/classes 和 dist-->

     <target name= "init"  description= "建立目錄" >

         <mkdir dir= "build/classes"  />

         <mkdir dir= "dist"  />

     </target>

 

     <!--編譯輸出目錄：srcdir-源目錄和destdir-目標目錄-->

     <target name= "compile"  depends= "init"  description= "編譯" >

         <javac srcdir= "src"  destdir= "build/classes"  />

     </target>

 

     <!--打包 , depends依賴哪些target-->

     <target name= "archive"  depends= "compile"  description= "打包" >

         <war destfile= "dist/antwebproject.war"  basedir= "build/classes"  />

         <jar destfile= "dist/project.jar"  basedir= "build/classes"  />

     </target>

 

     <!--清理刪除-->

     <target name= "clean"  depends= "init"  description= "清理" >

         <delete dir= "build"  />

         <delete dir= "dist"  />

     </target>

</project>

 

 

學習目標： webproject打War包

<?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}/AntProject.war"  webxml= "WebRoot/WEB-INF/web.xml" >

             <!-- 拷貝WebRoot下除了WEB-INF和META-INF的兩個文件夾 , **意爲:匹配0或者更多的目錄-->

             <fileset dir= "WebRoot"  includes= "**/*.jsp"  />

 

             <!-- 拷貝lib目錄下的jar包-->

             <lib dir= "${lib}"  />

 

             <!-- 拷貝build/classes下的 class 文件-->

             <classes dir= "${classes}"  />

 

         </war>

     </target>

 

</project>