用Ant實現Java項目的自動構建和部署

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 SettingsAmigoXie目錄)輸入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。

  • 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

  • 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,可看到如下圖所示的運行結果:
<img src="http://image.it168.com/cms/2007-11-9/Image/2007119131211.jpg"/>

讀者分析結果後可以看到,我們運行的是名爲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:。

  • property元素

該元素可看作參量或者參數的定義,project的屬性可以通過property元素來設定,也可在Ant之外設定。若要在外部引入某文件,例如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>
<img src="http://image.it168.com/cms/2007-11-9/Image/2007119131334.jpg"/>

由此讀者可以看出,通過如下兩個語句:我們設置了名爲name和age的兩個屬性,這兩個屬性設置後,讀者在下文中可以通過${name}和${age}分別取得這兩個屬性的值。

  • Ant的常用任務

在Ant工具中每一個任務封裝了具體要執行的功能,是Ant工具的基本執行單位。在本小節中,主要引導讀者來看下Ant的常用任務及其使用舉例。

  1. copy任務

該任務主要用來對文件和目錄的複製功能。舉例如下:

Eg1.複製單個文件:

Eg2.對文件目錄進行復制:

       <copy todir="../newdir/dest_dir">
    <fileset dir="src_dir"/>
     </copy>

Eg3. 將文件複製到另外的目錄:

  1. delete任務
    對文件或目錄進行刪除,舉例如下:
    Eg1. 刪除某個文件:
    Eg2. 刪除某個目錄:
    Eg3. 刪除所有的備份目錄或空目錄:


  2. mkdir任務

創建目錄。eg:

  1. move任務

移動文件或目錄,舉例如下:Eg1. 移動單個文件:

Eg2. 移動單個文件到另一個目錄:

Eg3. 移動某個目錄到另一個目錄:

    <move todir="newdir">
       <fileset dir="olddir"/>
    </move>
  1. echo任務

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

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

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

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

Ant的javac任務用於實現編譯Java程序的功能。下面來看一個簡單的例子:首先我們建立名爲antstudy的Java工程,建立src目錄爲源代碼目錄,在src目錄下建立HelloWorld.java這個類文件。該類文件的內容如下:

publicclass HelloWorld {publicstaticvoid main(String[] args) {System.out.println("Hello,Amigo");}}

同時在antstudy工程的根目錄下建立build.xml文件,在該文件中編譯src目錄下的java文件,並將編譯後的class文件放入build/classes目錄中,在編譯前,需清除classes目錄,該文件的內容如下:

    <targetname="compile"depends="clean">
       <mkdirdir="build/classes"/>
       <javacsrcdir="src"destdir="build/classes"/>
    </target>
</project>

運行該build.xml文件,可在工程中看到新增了build/classes目錄,並在該目錄中生成了編譯後的HelloWorld.class文件。

  1. 使用Ant的java任務運行Java程序

Ant中可以使用java任務實現運行Java程序的功能。下面在1的例子中進行如下的修改,修改後的build.xml文件的內容如下:

    <targetname="compile"depends="clean">
       <mkdirdir="build/classes"/>
       <javacsrcdir="src"destdir="build/classes"/>
    </target>
    <targetname="run"depends="compile">
       <javaclassname="HelloWorld">
       <classpath>
      <pathelementpath="build/classes"/>
       </classpath>
       </java>
    </target>
    </project>

運行該build.xml文件,可在控制檯看到HelloWorld的main方法的輸出。

  1. 使用Ant的jar任務生成jar文件
    讀者可以在上例的基礎上更進一步,來生成jar包,可在run這個target下再加上如下target:
        <targetname="jar"depends="run">
               <jardestfile="helloworld.jar"basedir="build/classes">
                   <manifest>
                      <attributename="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"?>
        <projectname="antwebproject"default="war"basedir=".">
            <propertyname="classes"value="build/classes"/>
            <propertyname="build"value="build"/>
            <propertyname="lib"value="WebRoot/WEB-INF/lib"/>
            <!-- 刪除build路徑-->
            <targetname="clean">
               <deletedir="build"/>
            </target>
            <!-- 建立build/classes路徑,並編譯class文件到build/classes路徑下-->
            <targetname="compile"depends="clean">
               <mkdirdir="${classes}"/>
               <javacsrcdir="src"destdir="${classes}"/>
            </target>
            <!-- 打war包-->
            <targetname="war"depends="compile">
               <wardestfile="${build}/antwebproject.war"webxml="WebRoot/WEB-INF/web.xml">
                   <!-- 拷貝WebRoot下除了WEB-INF和META-INF的兩個文件夾-->
                   <filesetdir="WebRoot"includes="**/*.jsp"/>
                   <!-- 拷貝lib目錄下的jar包-->
                   <libdir="${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的目錄下看一下運行結果。

關注我,關注測試

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章