Ant build.xml例子讲解

 

<!--转JUnit Gossip: 建構檔案 http://caterpillar.onlyfun.net/Gossip/JUnit/BuildFile.html-->
<!--help by 转：Ant之build.xml详解  http://blog.sina.com.cn/s/blog_4ea1df280100e8gi.html-->
<project name="example" default="run">
	                       <!--startUp step is default=run-->
    
    <property name="src.dir" value="src"/> 
    <property name="bin.dir" value="bin"/> 
    <property name="bak.dir" value="bak"/>

    <!--step1-->
    <target name="prepare"> 
        <mkdir dir="${bin.dir}"/> 
        <mkdir dir="${bak.dir}"/> 
        <copy todir="${bak.dir}"> 
            <fileset dir="${bin.dir}"/> 
        </copy> 
    </target> 
		
		<!--step2
		1:<javac标签>
        该标签用于编译一个或一组java文件，其属性如下。
				(1).srcdir表示源程序的目录。
				(2).destdir表示class文件的输出目录。
				(3).include表示被编译的文件的模式。
				(4).excludes表示被排除的文件的模式。
				(5).classpath表示所使用的类路径。
				(6).debug表示包含的调试信息。
				(7).optimize表示是否使用优化。
				(8).verbose 表示提供详细的输出信息。
				(9).fileonerror表示当碰到错误就自动停止。。-->
    <target name="compile" depends="prepare"> 
        <javac srcdir="${src.dir}" destdir="${bin.dir}"/> 
    </target>
    
    <!--step3
     1:classpath表示所使用的类路径。
     2:<java>标签
       该标签用来执行编译生成的.class文件，其属性如下。
       (1).classname 表示将执行的类名。
       (2).jar表示包含该类的JAR文件名。
       (3).classpath所表示用到的类路径。
       (4).fork表示在一个新的虚拟机中运行该类。
       (5).failonerror表示当出现错误时自动停止。
       (6).output 表示输出文件。
       (7).append表示追加或者覆盖默认文件。
     -->
    <target name="run" depends="compile">
        <java classname="cc.openhome.HelloAnt">
            <classpath path="${bin.dir}"/>
        </java>
    </target>
    
</project>
<!--总体功能概述 
最终目的 执行 程序 HelloAnt.class ***java HelloAnt***
這邊打算進 行的工作是：
(id=compile):編譯src/cc/openhome中的HelloAnt.java，其編譯成果將儲存至bin目錄中,如果 bin目錄不存在就建立它，
(id=prepare):每一次編譯將bin中前一次編譯的成果複製至bak目錄，如果bak目錄不存在就建立它，
(id=run):最後執行程式。
-->

<!--
建構過程中<target>所共享的屬性，
可以使用<property>標籤設定，
每一個屬性的值會有個名稱對應，以這個例子而言，您設定了程式碼來源位置、編譯結果目標目錄與備份目錄。
-->

<!--
<project>中包括數個<target>，每一個<target>有一個名稱，
<project>的任務執行進入點預設是名稱為"run"的 <target>，
每個<target>可以使用depends屬性指定依賴其它的<target>，
	也就是所依賴的<target>必須先執行完成，才會執行自己的目標。
在上例中，"run"的完成依賴於"compile"的完成，
"compile"的完成又依賴於"prepare"的完成，
所以在建構開始時，
step_1:會先執行"prepare"，
step_2:完成後再執行"compile"，
step_3:最後執行"run"。
-->

<!--
在上例中，build.xml是以<project>為根標籤。
一個build.xml中可以定義多個任務， 
這些任務可能是建立目錄、編譯原始碼、搬移檔案、產生doc文件、進行測試、產生測試報告等，
這些任務通常組織為一個目標 （target）。
-->

<!--
HelloAnt.java只是個簡單的程式：
 package cc.openhome;
public class HelloAnt { 
    public static void main(String[] args) { 
        System.out.println("Hello! Ant!!"); 
    } 
}
-->
<!--
就這個例子而言，使用Ant是有點小題大作了，不過這讓我們可以將焦點集中在Ant本身的設定與執行。
編輯好build.xml之後，在文字模式下於build.xml所在的目錄中，
直接下ant指令即可開始建構專案，
ant預設會讀取同一個目錄下的build.xml，
第一次執行ant時會出現以下的文字提示建構過程:

picture:ant_001.png
**********************屏幕显示内容start*******************************************************************
>ant
Buildfile: C:\workspace\example\build.xml

prepare:
    [mkdir] Created dir: C:\workspace\example\bin
    [mkdir] Created dir: C:\workspace\example\bak

compile:
    [javac] C:\workspace\example\build.xml:14: warning: 'includeantruntime' was not
set, defaulting to build.sysclasspath=last; set to false for repeatable builds
    [javac] Compiling 1 source file to C:\workspace\example\bin

run:
     [java] Hello! Ant!!

BUILD SUCCESSFUL
Total time: 1 second
**********************屏幕显示内容end*******************************************************************

可以看到ant已經完成了所指定的工作，
現在假設修改了HelloAnt.java並存檔，接下來再次下達ant指令，這次出現以下的文字提示建構過程：

**********************屏幕显示内容start*******************************************************************
>ant
Buildfile: C:\workspace\example\build.xml

prepare:
     [copy] Copying 1 file to C:\workspace\example\bak

compile:
    [javac] C:\workspace\example\build.xml:14: warning: 'includeantruntime' was
not set, defaulting to build.sysclasspath=last; set to false for repeatable buil
ds

run:
     [java] Hello! Ant!!

BUILD SUCCESSFUL
Total time: 0 seconds 
**********************屏幕显示内容end*********************************************************************
這次由於bin與bak目錄已經存在，就不用再進行新建目錄的工作，
ant檢查bin中有之前構建的檔案，於是將它複製至bak目錄中。
-->

<!--
在建構程式時，有些目標所定義的任務可能是可選的，
可以藉由在設定<target>時設定if條件，並在建構時指定該條件為true或 false，以決定該目標是否要執行，
例如可以這麼設定：
<target name="some" if="conditional"> 
    some task..... 
</target> 

使用if設定條件目標時，表示只有在conditional被設置時才會被執行，在執行ant指令時，您就可以如下來決定some是否要執行：

********************************************
ant -buildfile build.xml -Dconditional=true 
********************************************

您也可以使用unless來設定條件目標：
<target name="some" unless="conditional"> 
    some task..... 
</target>

由於您使用了unless來設定條件目標，所以只有在conditional沒有被設定時，目標才會被執行。
由於ant可以在一個建構檔案中調用另一個建構檔案，
在調用的時候，
兩個建構檔案之間可能會有一些重複的屬性設定，
如果您想要避免某個屬性被重複設定了，可以這麼撰寫:

<target name="setProperties" unless="setProperties"> 
    <property name="someProperty" value="someValue"/> 
    ... 
</target> 
  
你在啟動ant指令時，也可以指定目標，例如：
ant prepare

可以使用<ant>標籤，在一個建構檔案中調用另一個建構檔案，一個簡單的例子如下：
<project name="someProject" default="all"> 
    ...... 
    <target name="some" depends="other"> 
        <ant antfile="./project2/build.xml"> 
            <property name="condition_name" value="true"> 
        </ant> 
    <target> 
    ...... 
</project>
在<property>中設定value為true，當您在另一個建構中有目標使用了條件式（if或unless）時，這可以給予該條件一個true的特性值。

您也可以指定專案的 目錄 來調用預設的build.xml，例如：
<project name="someProject" default="all"> 
    .... 
    <target name="some" depends="other"> 
        <ant dir="./project2"> 
            <property name="condition_name" value="true"> 
        </ant> 
    <target> 
    .... 
</project> 
 

您也可以僅僅調用另一個建構檔案中的某個目標，例如：
<ant antfile="./project2/build.xml" target="prepare"/>  
-->

<!--show element
**********************屏幕显示内容start******************************************************************* 
**********************屏幕显示内容end*********************************************************************
--->