Ant構建與部署Java項目---入門

原文地址：http://tech.it168.com/j/2007-11-09/200711091344781.shtml

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

一．安裝與配置

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

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

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

由上能夠看出，讀者運行Ant的命令時，須要進入到Ant的bin目錄，如何才能讓系統自動找到Ant呢？這時須要讀者在系統環境變量path中添加Ant的bin目錄。設置完成後，咱們就能夠在任何目錄（例如C:"Users\XX"目錄）輸入Ant的命令，來得到命令的運行結果。

二．Ant的關鍵元素

Ant的構件文件是基於XML編寫的，默認名稱爲build.xml。爲了更清楚的瞭解Ant，在這裏編寫一個簡單的Ant程序，用來展示Ant的功能，讓讀者對Ant有一個初步的瞭解。首先在D:\Java EE\Ant（讀者可自行更改目錄）文件夾下創建一個build.xml文件，內容以下：

<? xml version="1.0" ?>
< project  name ="hello" >
        < target  name ="sayHello" >
               < echo  message ="Hello,Andy" />
        </ target >
</ project >

讀者能夠進入D:Java EE\Ant盤，而後運行ant sayHello，能夠看到以下的運行結果：
    

其中sayHello爲須要執行的任務的名稱。若是文件名不爲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的各元素的使用。創建D:\Java EE\Ant\task2.xml文件，修改後的內容以下：

<? xml version="1.0" ?>
< project  name ="AntStudy"  default ="sayBaseDir"  basedir ="D:\Java\ apache-ant-1.9.3" >
        < target  name ="sayBaseDir" >
               < echo  message ="The base dir is: ${basedir}" />
        </ target >
</ project >

 

配置中basedir屬性值必須爲磁盤存在的目錄

從上面的內容咱們能夠看出，在這裏定義了default屬性的值爲sayBaseDir，即當運行ant命令時，若未指明執行的target時，默認執行的target的sayBaseDir，同時還定義了basedir屬性的值爲D:\Java\apache-ant-1.9.3，進入D:Java EE\Ant盤後運行ant命令，可看到運行的結果，以下圖所示：
    

由於設定了basedir的值，因此basedir屬性的值變成了讀者設置的值。讀者能夠自行將project元素的basedir屬性去掉後運行ant看看運行結果，此時basedir的值變成了"D:\Java EE\Ant"，即爲Ant構件文件的父目錄。

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功能的簡短描述和說明。

下面帶領讀者來看一個各屬性綜合使用的例子。創建D:\Java EE\Ant\task3.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 ="andy" >
               < description >
                            a depend example!
               </ description >
               < echo  message ="The base dir is: ${basedir}" />
        </ target >
</ project >

進入D:Java EE\Ant盤後一次運行ant -f task3.xml,ant -f task3.xml targetA,ant -f task3.xml targetB，可看到以下圖所示的運行結果：
    

讀者分析結果後能夠看到，咱們運行的是名爲targetB的target，因該target依賴於targetA，因此targetA將首先被執行，同時由於系統安裝了java環境，因此ant.java.version屬性存在，執行了targetA這個target，輸出信息：[echo] Java Version: 1.7，targetA執行完畢後，接着執行targetB，由於andy不存在，而unless屬性是在不存在時進入所在的target的，由此可知targetB得以執行，輸出信息：The base dir is: D:\Java EE\Ant"。

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；

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

ant.java.version：Ant檢測到的JDK的版本，在上例運行結果中可看到爲1.7。

下面讓讀者來看一個property元素使用的簡單例子。創建D:\Java EE\Ant\task4.xml文件，內容以下：

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

該例的運行結果以下圖所示：
    

由此讀者能夠看出，經過以下兩個語句：

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

<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的數據類型

在構建文件中爲了標識文件或文件組，常常須要使用數據類型。數據類型包含在 org.apache.tool.ant.types包中。下面鏡簡單介紹構建文件中一些經常使用的數據類型。

1. argument 類型
 由Ant構建文件調用的程序，能夠經過<arg>元素向其傳遞命令行參數，如apply,exec和java任務都可接受嵌套<arg>元素，能夠爲各自的過程調用指定參數。如下是<arg>的全部屬性。
(1).values 是一個命令參數。若是參數種有空格，但又想將它做爲單獨一個值，則使用此屬性。
(2).file表示一個參數的文件名。在構建文件中，此文件名相對於當前的工做目錄。
(3).line表示用空格分隔的多個參數列表。
(4).path表示路徑。

2.ervironment 類型
  由Ant構建文件調用的外部命令或程序，<env>元素制定了哪些環境變量要傳遞給正在執行的系統命令，<env>元素能夠接受如下屬性。
(1).file表示環境變量值得文件名。此文件名要被轉換位一個絕對路徑。
(2).path表示環境變量的路徑。Ant會將它轉換爲一個本地約定。
(3).value 表示環境變量的一個直接變量。
(4).key 表示環境變量名。
注意  file path 或 value只能取一個。

3.filelist類型
 Filelist 是一個支持命名的文件列表的數據類型，包含在一個filelist類型中的文件不必定是存在的文件。如下是其全部的屬性。
(1).dir是用於計算絕對文件名的目錄。
(2).files 是用逗號分隔的文件名列表。
(3).refid 是對某處定義的一個<filelist>的引用。
注意  dir 和 files 都是必要的，除非指定了refid(這種狀況下，dir和files都不容許使用)。

4.fileset類型
Fileset 數據類型定義了一組文件，並一般表示爲<fileset>元素。不過，許多ant任務構建成了隱式的fileset,這說明他們支持全部的fileset屬性和嵌套元素。如下爲fileset 的屬性列表。
(1).dir表示fileset 的基目錄。
(2).casesensitive的值若是爲false，那麼匹配文件名時，fileset不是區分大小寫的，其默認值爲true.
(3).defaultexcludes 用來肯定是否使用默認的排除模式，默認爲true。
(4).excludes 是用逗號分隔的須要派出的文件模式列表。
(5).excludesfile 表示每行包含一個排除模式的文件的文件名。
(6).includes 是用逗號分隔的，須要包含的文件模式列表。
(7).includesfile 表示每行包括一個包含模式的文件名。

5.patternset 類型 
Fileset 是對文件的分組，而patternset是對模式的分組，他們是緊密相關的概念。<patternset>支持4個屬性：includes excludex includexfile 和 excludesfile,與fileset相同。Patternset 還容許如下嵌套元素：include,exclude,includefile 和 excludesfile.

6.filterset 類型
Filterset定義了一組過濾器，這些過濾器將在文件移動或複製時完成文件的文本替換。主要屬性以下：
(1).begintoken 表示嵌套過濾器所搜索的記號，這是標識其開始的字符串。
(2).endtoken表示嵌套過濾器所搜索的記號這是標識其結束的字符串。
(3).id是過濾器的惟一標誌符。
(4).refid是對構建文件中某處定義一個過濾器的引用。

7.Path類型 
Path元素用來表示一個類路徑，不過它還能夠用於表示其餘的路徑。在用做揖個屬性時，路經中的各項用分號或冒號隔開。在構建的時候，此分隔符將代替當前平臺中全部的路徑分隔符，其擁有的屬性以下。
(1).location 表示一個文件或目錄。Ant在內部將此擴展爲一個絕對路徑。
(2).refid 是對當前構建文件中某處定義的一個path的引用。
(3).path表示一個文件或路徑名列表。

8.mapper類型
Mapper類型定義了一組輸入文件和一組輸出文件間的關係，其屬性以下。
(1).classname 表示實現mapper類的類名。當內置mapper不知足要求時，用於建立定製mapper.
(2).classpath表示查找一個定製mapper時所用的類型路徑。
(3).classpathref是對某處定義的一個類路徑的引用。
(4).from屬性的含義取決於所用的mapper.
(5).to屬性的含義取決於所用的mapper.
(6).type屬性的取值爲identity，flatten glob merge  regexp  其中之一，它定義了要是用的內置mapper的類型。

五．利用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 ="run"  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爲源代碼目錄，WebContent爲各jsp存放目錄，lib爲工程的包目錄。在AntWeb工程目錄下創建了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 ="AntWeb"   default ="war" basedir ="." >
  < property  name ="classes"  value ="build/classes" />
     < property  name ="build" value ="build" />
     < property  name ="lib" value ="WebContent/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 ="WebContent/WEB-INF/web.xml" >
            <!--  拷貝WebContent下除了WEB-INF和META-INF的兩個文件夾 -->
     < fileset  dir ="WebContent"  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.15.jar

            ........................

     --classes

            --com

　　　　　　--netease

                    --Main.class

     --web.xml

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