Ant 介紹 學習

1.       Ant簡介：這裏引用Ant幫助文檔中對Ant的介紹：

     Apache Ant是一個基於Java的構建工具。從理論上講，也是一種類似於Make的工具，只是去除了Make工具的缺點。

    
       既然已經有了make, gnumake, nmake, jam以及其他的構件工具，爲什麼還要Ant呢？因爲Ant的早期開發者發現所有以上這些工具都或多或少的有一些侷限性，使得在跨平臺開發軟件成爲困難。 類似於Make的工具都是傳統的基於Shell的--首先進行依賴性檢查，然後執行命令。這意味着你可以輕易的通過使用或者編寫程序來擴展這些工具，以滿 足不同的平臺。當然，這也意味着你將侷限於特定的平臺，至少可以說侷限於特定類型的平臺，例如：Unix平臺。
                                                                                      

    同時，Make文件也有一些先天的缺陷。好多人都會遇到恐怖的tab問題。Ant的最初開發者多次說“我的命令不能執行因爲我在tab前面加了一個空格！”。一些工具如Jam一定程序上解決了這個問題，但仍有其它的格式問題。

    Ant與從基於命令的那些擴展開來的那些工具不同，Ant是由java類擴展的。不用編寫shell命令，而是配置基於XML的文件，形成多個任務的目標配置樹。每一個任務都是通過一個實現了一個規定接口的java類來運行的。

    ant 缺少了一些直接執行shell命令的能力，如find . -name foo -exec rm {}，但它給用戶提供了跨平臺的能力，可以在任何地方工作。實際上，Ant也提供了命令execute用來執行shell命令,這就是它的任務，它允許執 行基於操作系統的命令。

    簡單的說，Ant是一個基於Java，並且主要用於Java工程的構建工具。Ant本意是Another Neat Tool,也就是另一種整潔的工具，取首字符就是Ant。

構建工具就是爲了減少重複工作而產生的。

2.       Ant的一些核心概念：

XML:構建文件是以XML文件來描述的，採用XML格式有很多好處。這裏就不一一列舉。

陳述式語法：構建文件短小精悍，且易於理解。

每個構建文件包含一個工程(project)。

每個工程包含若干個目標(target)。

目標可以依賴於其他的目標(depends)。

目標包含任務(task)。

易於使用Java語言增加新的任務---易於擴展（自定義）。

3.       Ant結構：

Ant的結構如下圖所示：

構建文件的概念視圖：工程包含一個目標的集合。在每個目標裏是任務的聲明，它們是對Ant用於構建該目標的行爲說明。目標生成一個依賴關係圖表來聲明該目標的依賴關係。當執行一個目標時，必須先執行它們依賴的目標。

 

例子：一個典型的構建文件：

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

 

該構建過程如下：

系統初始化1、編譯  2、生成JAVADOC   4、打包  5、上傳到FTP，其中後兩步結合到一起叫部署。

 

執行時輸出如下：

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

在執行時使用命令行參數以傳入一個屬性文件，屬性文件中包含連接FTP服務器使用的服務器名，用戶名，用戶密碼來給特性使用。

這個例子很好的展示了Ant的一些基本要素：目標依賴、特性的使用、編譯、文檔生成、JAR打包（tar,Zip,WAR,EAR等），最後是部署。

 

Ant的簡單任務(<mkdir>)都是由Java類庫來實現相應的功能。而一些複雜的任務<ftp>、<junit>還需要第三方庫的支持。

 

    Ant 的一個強大之處：它總能工作。只要正確的指定構建文件，Ant就能計算出目標的依賴性，並且按照正確的順序調用目標。目標通過任務按序執行，而任務自身處 理其文件依賴性以及實際的操作來完成工作。因爲每個任務通常都是在高層陳述，所以一兩行XML語句經常就已經足夠描述任務的內容。

 

4.   下載並安裝Ant

     使用Ant前提條件，系統中已經安裝JDK以及Ant。在文檔編寫之時，Ant的最新版本是Ant 1.7,但是爲了穩定性，本文檔使用版本爲Ant 1.6.5.

首先下載Ant，到apache軟件網站http://www.apache.org/。

其次，解壓縮文件，放到指定的系統目錄中，例如C:/Ant。

再次，將其添加到path，以便從命令行使用。(一些IDE，例如Eclipse可以不需要設置path,而通過IDE相關設置將Ant添加到path中。)

再次，設置一些環境變量指向JDK以及ANT。

最後，添加需要的可選庫。

 

在Windows安裝過程（以筆者的安裝過程爲例）

    下載apache-ant-1.6.5-bin.zip到本地硬盤，解壓縮之後將文件夾命名爲Ant,放在C:/Ant中。這個目錄就是Ant主目錄。

應該將主目錄中的bin目錄添加到path屬性中，這樣就可以在命令行中調用ant命令，ANT_HOME是批處理文件所在目錄的上級目錄。最好明確設定。

現在許多工具已經集成了特定版本的Ant，一些操作系統甚至默認的已經安裝了Ant。所以，你的系統中可能已經安裝了Ant。

首先可以通過運行以下命令：
ant -version
和
ant -diagnostics
來確定。我們推薦您不設置CLASSPATH來運行Ant命令。如果任何版本的Ant可以從CLASSPATH加載 ，這時就會由於加載了不兼容的類而產生許多錯誤。

 

一些其他問題請參閱Ant的FAQ設置。

正常情況下，執行ant ?Cversion即可顯示Ant版本，則說明安裝配製成功：

 

5.       運行第一個構建文件：

首先創建一個Java工程，名爲AntProject，工程中源文件和目標文件是分開的，分別爲文件夾src和bin,然後創建一個Java類文件，類名爲

com.neusoft.test.AntTest，只是爲了測試，所以類的內容很簡單：

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，內容如下：

<?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的知識，請參考其他書籍，這裏不做介紹。

以上創建完成後，目錄結構如下圖：

 

     Ant 構建文件總是有一個<project>元素做爲根元素，它有兩個屬性，name和default，<target>元素是 <project>元素的子元素，可以有多個，它有兩個屬性，name和depends，<target>元素包含的元素就是一 些任務元素。

<target>可以由命令行進行顯示的調用，也可以在內部使用如可以直接調用ant init、ant compile等。如果不寫參數，則默認的build文件是build.xml，默認的目標是<project>的default屬性定義的 目標。目標的名稱是唯一的，可以是任意字符串。

 

下面我們先運行一下這個Ant構建，再講解其他的內容，進入工程目錄，執行

ant

這裏就相當於執行默認的目標，也就是<project name="structured" default="archive" >中的archive目標。

 

這裏說明了首先初始化創建兩個目錄，然後編譯了一個JAVA文件，然後進行了打包的操作。

 

這裏講解一下如果構建失敗了怎麼辦？

首 先有可能是XML語法書寫不正確(將<target>寫成<targe>)，或者在任務執行過程中出現了錯誤(.java文件中 包含編譯錯誤)，或者任務名稱書寫錯誤(將<javac>寫成<javacc>)等等，這些都不是Ant的錯誤，不需要填寫 Bug Report。寫XML時一定要細心，一些IDE已經有驗證功能，可以很好的防止書寫的錯誤。

 

出現錯誤時，可以使用

ant ?Cverbose

或者

ant ?Cdebug來獲取更加詳細的構建信息，以解決問題。

下圖是使用ant ?Cverbose時的輸出，使用ant ?Cdebug將獲取比這更詳細的信息，這裏就不舉例了。

 

本例中直接使用了軟件工程中的構建結構，使用src作爲源文件目錄，build/class作爲中間生成文件，以dist作爲可發佈文件。在最後把一些可執行文件可以放在bin目錄中。此時目錄結構如下圖所示：

 

我們需要一種辦法來確定某些任務先執行，而有些任務後執行，比如必須先編譯，才能執行程序或者打包。我們在聲明目標的時候，就在其依賴屬性中列出其依賴關係：

<target name="compile" depends="init" >

<target name="archive" depends="compile" >

<target name="clean" depends="init">

如果一個目標依賴與多個其他目標，需要將它們都寫到依賴屬性中，例如：

depents=”compile,test”。在我們的構建中，archive依賴於init和compile，但是我們不需要去寫，因爲compile已經依賴於init了。即：Ant的依賴關係是傳遞的，但不是自反的。

如果在執行過程中兩個目標共享同一個目標，則先導目標只被執行一次。

可以通過指定目標來運行構建：

例如執行完ant後，可以執行ant clean來清理構建：

 

ant等價於ant archive

ant init

ant clean

ant compile

ant archive

ant clean archive

 

當構建完成一次以後，再次執行構建會發生什麼呢？

 

第二次執行構建時只花了2s，相比第一次的4s。並且沒有任何一個目標表示做了任何工作。

原因如下：所有的任務都檢查了它們的依賴關係：

<mkdir>沒有創建目錄因爲已經存在

<javac>比較了源文件和類文件的時間戳

<jar>比較了要被加入文件與已經存在文件的時間

只有更新的時候才進行任務執行。

 

Ant如何處理命令行上的多個目標？

執行ant compile archive會怎麼樣？

先實驗一下：

 

Ant 依次執行每個目標和其依賴目標，即Ant的執行順序是init compile init compile archive，雖然這樣看起來增加了額外的工作，但是通過上面的執行過程就會發現，由於其依賴性檢查的阻止，第二次的init和compile並未真正 的執行，執行時間與直接執行archive的時間是一樣的。

 

運行程序：

普通執行該類的方法是：

java ?Ccp build/class com.neusoft.test.AntTest args1 args2

而我們使用Ant的任務來執行它僅僅需要增加一個任務，好處在於：

讓用於執行的目標依賴與編譯的目標，確保運行最新版本

易於傳遞複雜參數

設置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>

 

最後一個參數是file=”.”，表示傳入的參數是一個目錄，爲文件絕對路徑。

運行該目標，輸出如下：

 

Ant命令行選項：

 

請參閱相關手冊進行查詢相關選項的功能。

 

當有多個構建文件時，可以指定構建文件：

ant ?Cbuildfile build.xml compile

來表示執行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>

 

Trackback: http://tb.blog.csdn.net/TrackBack.aspx?PostId=1548077