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 開發者的絕佳幫手


轉載自:http://blog.csdn.net/user4570/article/details/4221101

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