本文講述如何使用這個具有極大價值的工具（Ant）來構(gòu)建和部署Java工程。

    Ant是一個用于簡單或復雜Java工程的自動化構(gòu)建、部署工具，它對于那些具有分布式開發(fā)團隊或者相信通過頻繁的構(gòu)建來進行不間斷集成的公司尤其有用。對于那些建立傳統(tǒng)全Java應(yīng)用程序以及那些使用HTML、JSP和Java servlets創(chuàng)建Web應(yīng)用程序的公司來說，Ant極具價值。無論你的Java開發(fā)者使用什么操作系統(tǒng)、集成開發(fā)環(huán)境或者構(gòu)建環(huán)境，Ant都可以將你的工程集合在一起，用于那些重要的構(gòu)建。Ant也能夠自動化并且同步文檔部署，這通常發(fā)生在軟件開發(fā)過程中的沒有正式文檔和文檔比較混亂的部分。

    在構(gòu)建和部署Java應(yīng)用程序的時候，Ant處理著大量有用的任務(wù)。最基本的任務(wù)包括添加和移除目錄、使用FTP拷貝和下載文件、創(chuàng)建JAR和ZIP文件以及創(chuàng)建文檔。更高級的特性包括用源代碼控制系統(tǒng)諸如CVS或者SourceSafe來檢查源代碼、執(zhí)行SQL查詢或腳本、將XML文件轉(zhuǎn)換為人能識別的HTML，以及為遠程方法調(diào)用生成stub（存根）文件。

   Ant和Make（非常著名的構(gòu)建工具，很多C語言開發(fā)人員都使用它）之間有什么不同？Ant是為Java而創(chuàng)建，帶有屬于其自身的、獨特的范例，具有可移植性。而Make依賴于固定的操作系統(tǒng)命令（因此一個運行在微軟Windows下的Make文件對于使用UNIX的開發(fā)者來說毫無用處），利用Ant構(gòu)建的純Java工程是可移植的，因為Ant本身就是用Java編寫的，并且Ant bulidfiles使用XML語法。

本文將向你展示一個典型的Ant文件，它使用了很多的Ant基本任務(wù)。

一個典型的Ant工程

    Ant使用用XML編寫的、稱作bulidfile的工具來開展它的工作。讓我們考慮一個源文件在src目錄中、類庫（包括JAR文件）在lib目錄中、API文檔在doc/api目錄中的典型Java工程。我們可以利用如下的Ant buildfile來構(gòu)建這個工程。

<?xml version="1.0"?>
<project name="typical" default="all" basedir=".">
 <property name="name" value="typical"/>
 <property name="src" value="src"/>
 <property name="lib" value="lib"/>
 <property name="api" value="doc/api"/>

 <property name="tmp" value="tmp"/>
 <property name="classpath" value="${lib}/${name}.jar"/>
 <property name="main" value="test.Main"/>

 <target name="bin"
         description="Compile Java source files">
  <javac srcdir="${src}"
         destdir="${tmp}"
         debug="on"

         deprecation="on"/>
 </target>

 <target name="jar" depends="bin"
         description="Build jar file">
  <jar jarfile="${lib}/${name}.jar"
       basedir="${tmp}"/>
 </target>

 <target name="run" depends="jar"

         description="Run the program">
  <java classname="${main}"
        classpath="${classpath}"/>
 </target>
 <target name="api"
         description="Generate API documentation">
  <javadoc sourcepath="${src}"
           destdir="${api}"
           packagenames="test.*"/>
 </target>


 <target name="clean"
         description="Clean generated files">
  <delete dir="${tmp}"/>
  <mkdir dir="${tmp}"/>
 </target>

 <target name="all" depends="clean,jar,api"/>

</project>
                  

也許這里的語法看起來非常冗長（你可以使用Make寫一個短的多的buildfile），但是Ant buildfile的優(yōu)點是其可讀性好。

    buildfile的內(nèi)容被包含在元素中。工程一般有一套工程屬性，帶有一些區(qū)--由一些Ant任務(wù)諸如編譯源代碼、生成目錄和生成JAR文件等組成。

    工程和屬性。在 元素下面首先可以找到屬性。這些屬性元素類似于變量。你通常可以按照任務(wù)在工程內(nèi)的任何地方使用屬性值，這些任務(wù)是通過使用表達式 $ {屬性名（property-name）} 在< target> 元素中定義的。舉例來說，在上述的buildfile 例子中，值${src}會被解析成src，因為我們在屬性區(qū)中對它是如此定義的。在我們的buildfile中，我們使用${src}屬性作為在javac任務(wù)中的srcdir的特性的值。

   當在命令行中用句法-Dproperty=value來調(diào)用Ant的時候，可能會定義或者重寫屬性。比如說，如果你想將src的值設(shè)定為source-directory，你可以在命令行中鍵入ant DDsrc=sourc_directory。此外，屬性是恒定的，所以一旦被定義，就不能修改它們的值。

   目標和任務(wù)。目標（target）元素定義了一套指令來實現(xiàn)某類工作。可以把它們比作由很多任務(wù)構(gòu)成的程序函數(shù)（與編程指令相比）。舉例來說，在上述的buildfile例子中，名為jar的目標（具有屬性name=jar的元素）包含有一個單一的任務(wù)以從類文件來生成JAR文件。這個例子中只是湊巧目標名稱和任務(wù)名稱相同，但是這個并不是必需的--目標元素名稱是由創(chuàng)建者選擇的，但是任務(wù)名稱是固定的，并且與那些定義在Ant標記中引用的目標名相匹配。這個特殊的目標（我們的目標）依賴于bin 目標（比如說，depends=bin），這意味著如果目標 jar被調(diào)用，那么它就會首先調(diào)用bin目標（如果bin目標還沒有被執(zhí)行）。當調(diào)用Ant時，你可以傳遞一個目標在命令行上運行。比如說，通過在命令行輸入命令ant jar調(diào)用Ant，可以運行目標jar。如果不指定一個目標而調(diào)用Ant，在工程的默認屬性中指定的目標就會被運行（在本例中，是"all"目標）。你也可以通過用空格分隔目標的辦法來調(diào)用帶有多個目標的Ant。

目標及其任務(wù)

  如前所述，Ant bulidfile是一個處理工程構(gòu)建或部署給定階段的目標的集合。在這里我將描述在我們的示例buildfile中使用到的目標，并詳細說明在使用這些目標及其相關(guān)的任務(wù)的時候會碰到的一些常見問題。你可以根據(jù)自身的需要快速地定制這里所展示的bulidfile。以下的例子描述了這些通過使用我們的Ant bulidfile完成這些工作的步驟：

1. 編譯Java源文件
2. 創(chuàng)建JAR文件
3. 運行程序
4. 生成API文檔
5. 清除生成的class（類）文件

1. 編譯Java源文件

這個目標的使用可能是最廣泛的。通常由以下代碼來實現(xiàn)：

<target name="bin" description="Compile Java source files">

  <javac srcdir="${src}"
         destdir="${tmp}"
         debug="on"
         deprecation="on"/>
 </target>
                  

     這個目標包括一個單一的javac任務(wù)，這個任務(wù)就是編譯Java源文件。在上面的這個例子中使用的屬性非常簡單明了：srcdir是存放源文件的目錄，destdir是存放所生成的類文件的目錄。最后兩個屬性是用于javac編譯選項的。注意到optimize屬性（這里沒有使用）沒有什么用，所以最新的Java編譯器沒有將該屬性放入其中。當需要類庫進行編譯時，你應(yīng)該添加一個classpath（類路徑）屬性以便在其中列出JAR文件或者目錄。可以在UNIX或者Windows系統(tǒng)下面寫一個Ant路徑，其中使用冒號或者分號作為路徑的分隔標記，使用斜線或者反斜線作為文件的分隔標記。這樣，定義為lib/foo.jar:lib/bar.jar的classpath在UNIX下不用修改就可以直接使用，而在Windows下就會被自動轉(zhuǎn)換成lib\foo.jar;lib\bar.jar。

   這個任務(wù)力圖使用與JDK一起提供的編譯器。該編譯器是帶有其自有類的 Java程序，其自有類存在于tools.jar文件中（該文件位于lib目錄中）。這樣，tools.jar文件必須在classpath中被指定。在很多操作系統(tǒng)中（包括Solaris和Linux），這個不成其為問題，在使用javac任務(wù)時，如果Ant不能使用這個標準編譯器的話，它就會抗議。為了解決該問題，只要簡單地將lib/tools.jar文件與jre/lib/ext/tools.jar做一個鏈接就可以了。

2. 創(chuàng)建一個JAR文件

這個任務(wù)從Java類（以及諸如圖片或者本地文件等其他資源）生成一個JAR文件。在我們的示例buildfile中，通過如下代碼實現(xiàn)：

<target name="jar" depends="bin"
         description="Build jar file">
  <jar jarfile="${lib}/${name}.jar" basedir="${tmp}"/>
 </target>
                  

     jar元素的屬性非常明顯。當你想要包括文檔庫中的其他文件時，你可以在任務(wù)中放置fileset元素。如同它們的名字所暗示的那樣，那些元素（并不是任務(wù)本身）定義了一系列的文件。讓我們設(shè)想一下，如果你想要引入一些位于img目錄中的PNG（Portable Network Graphics）格式的圖片文件，你應(yīng)該編寫如下代碼：

<target name="jar" depends="bin"
        description="Build jar file">
 <jar jarfile="${lib}/${name}.jar"
      basedir="${tmp}">
  <fileset dir="img" includes="*.png"/>

 </jar>
</target>
                  

   dir屬性指出了文件的基本目錄；而includes包含了一個表達式，該表達式定義了一些文件以包括在fileset中。那些表達式有一個與shell命令非常接近的句法，"*"字符匹配零個或者多個字符而"？"只匹配一個字符。你可以在目錄樹中（包括零）使用表達式"**"來替代任意數(shù)目的目錄。比如說，如果在上述的例子中要包括的圖片位于img的任意一個子目錄中，那么應(yīng)該在jar元素中放置如下所示的fileset：

<fileset dir="img" includes="**/*.png"/> 
                  

    也可以使用excludes屬性把文件從fileset中排除。比如說，要包括在img目錄中的除了.ida類型的所有其他文件，那么可以按照如下方式編寫fileset：

<fileset dir="img" excludes="**/*.dia"/>
                      

    缺省情況下，某些文件是被所有的fileset排除在外的，這些文件是編輯器生成的備份文件（例如UNIX下的**/*~文件）和版本控制目錄（例如**/CVS/*）。如果要告訴Ant你不想排除那些文件，那么就需要在fileset元素中加入屬性defaultexcludes="false"。

Ant也可以處理用于打包Web應(yīng)用程序的WAR文件和用于更復雜應(yīng)用程序的EAR文件，這些復雜的應(yīng)用程序經(jīng)常結(jié)合使用JSP、Servlets和EJB。Ant有專門的任務(wù)來生成WAR和EAR文件。那些任務(wù)是JAR任務(wù)的擴展，定義了新的嵌套元素和屬性。WAR任務(wù)定義了、、和等嵌套元素，這些元素定義特別的fileset的元素。包括在那些fileset中的文件將在文檔庫的WEB-INF/lib、WEB-INF/classes和WEB-INF以及META-INF目錄中結(jié)束。同時，它也為該文檔（WEB-INF/web.xml）的部署描述符定義webxml屬性。

EAR任務(wù)使用元素來將文件放入文檔的META-INF目錄，將appxml屬性用于部署描述符（META-INF/application.xml）。

3. 運行程序

為運行Java應(yīng)用程序，需要使用java任務(wù)，如下面的代碼所示：

<target name="run" depends="jar"
         description="Run the program">
  <java classname="${main}"
        classpath="${classpath}"/>
 </target>
                  

classname定義了包括main()方法運行程序的打包的類的名稱，classpath包含了運行它的類路徑。可以使用嵌套的arg元素傳遞命令行參數(shù)，或者通過嵌套sysproperty元素定義系統(tǒng)屬性。這兩種動作執(zhí)行起來都會非常快，因為缺省情況下，該程序運行在運行Ant的虛擬機（可以使用fork屬性讓Ant啟動一個新的虛擬機）上。

在元素中，通過使用classpath屬性指定了類路徑。用或者子元素（subelement）嵌套也是可以的。比如說，要在lib目錄下包括在classpath屬性中的條目、目錄類以及所有的JAR文件，可以編寫如下代碼：

<java classname="${main}">
 <classpath>
    <pathelement path="${classpath}"/>
    <pathelement location="classes"/>
    <fileset dir="lib" includes="*.jar"/>
   </classpath>
  </java>
                  

如果要重用一個路徑，我們可以在元素中定義它及其ID，并且在元素引用它們。舉例來說，如果我們想重用在上面定義的路徑，可以按照如下所示編寫代碼：

	 <path id="run.path">
	   <pathelement path="${classpath}"/>
	   <pathelement location="classes"/>
	   <fileset dir="lib" includes="*.jar"/>	 
	 </path>
                  

4. 生成API文檔

這里的目標是通過使用javadoc生成API文檔。大體說來，這是由一個單一javadoc任務(wù)構(gòu)成的簡易目標，代碼如下：

  <target name="api"
         description="Generate API documentation">
    <javadoc sourcepath="${src}"
           destdir="${api}"
           packagenames="test.*"/>
   </target>
                  

sourcepath和destdi是顯而易見的屬性。packagenames屬性是一個以逗號分隔的、提供文檔的包列表。雖然Java的import語句不是遞歸的，但是packagenames屬性卻是遞歸的。這意味著語句packagenames="test.*"可以為test包、test.foo包和test.foo.bar包提供文檔，但是不會為foo或者foo.test包提供文檔。

可以使用windowtitle、doctitle、header、footer和bottom這些包含HTML代碼的屬性定義窗口和文檔的標題以及所生成頁面的頁眉、頁腳和底行。注意：應(yīng)該用相應(yīng)的XML實體（< 和"）來代替XML格式字符（< 和 "）。也可以用link屬性為文檔鏈接指定一個URL。我們會說你用String參數(shù)編寫了一個方法。對于一個生成的不帶有l(wèi)ink屬性的文檔，在方法文檔中你就只有一個純文本java.lang.String。當使用一個合適的link屬性時，這將顯示為一個到Sun的java.lang.String類的文檔的鏈接。

5. 清除生成的類文件

該目標清除生成的類文件。比如說，要清除在tmp子目錄中的類文件（以及其他資源），可以編寫如下代碼：

<target name="clean"
         description="Clean generated files">
  <delete dir="${tmp}"/>
  <mkdir dir="${tmp}"/>
 </target>
                  

清除類文件總是一個很好的主意，因為它可以在將來的編譯中避免錯誤的相關(guān)性問題。假設(shè)你在類A中定義了一個常量foo，并且在類B中使用它。當你編譯這些Java源文件的時候，foo的值被嵌入在B的類文件中。如果你修改foo的值，并且重新編譯（沒有刪除類文件），javac任務(wù)就不會編譯類B，因為它的源文件比相應(yīng)的類要舊，因此舊的值將保持不變。即便用javac使用depend屬性也不能解決這個問題，因為Java編譯器的這個選擇是一種錯誤。Jikes的相關(guān)性檢查較好，但是你應(yīng)該重新構(gòu)建所有的類文件，這樣才是最快的辦法。

當你在HTML中用樣式表時會遇到類似的問題。style任務(wù)不檢查要使用樣式表的日期。這樣的話，如果你對那些文件進行操作，該任務(wù)將不會生成目標文件（通常是HTML文件）。你可以通過使用force屬性來強制性地生成文件，但是這樣通常是效率極低的。在這種情況下，通過下面的clean目標可以刪除所生成的HTML文件（在doc屬性目錄中）：

 <target name="clean">
   <delete dir="${tmp}"/>
   <mkdir dir="${tmp}"/>
   <delete><fileset dir="${doc}" includes="*.html"/></delete>
 </target>
                  

為解決這些相關(guān)性問題，當你生成新版本的文件時，應(yīng)該不時地運行clean目標。