ant中build.xml文檔寫法

（一）

Ant的概念
可能有些讀者並不知道什麼是Ant以及如何使用它，但只要使用經過Linux系統得讀者，應該知道

make這個命令。當編譯Linux內核及一些軟件的源程序時，常常要用這個命令。Make命令其實就

是一個項目管理工具，而Ant所實現功能與此相似。像make，gnumake和nmake這些編譯工具都有

必定的缺陷，可是Ant卻克服了這些工具的缺陷。最初Ant開發者在開發跨平臺的應用時，用樣也

是基於這些缺陷對Ant作了更好的設計。

Ant 與 makefile
Makefile有一些不足之處，好比不少人都會碰到的煩人的Tab問題。最初的Ant開發者屢次強調」

只是我在Tab前面加了一個空格，因此個人命令就不能執行」。有一些工具在必定程度上解決了

這個問題，但仍是有不少其餘的問題。Ant則與通常基於命令的工具備所不一樣，它是Java類的擴

展。Ant運行須要的XML格式的文件不是Shell命令文件。它是由一個Project組成的，而一個

Project又可分紅可多target，target再細分又分紅不少task，每個task都是經過一個實現特

定接口的java類來完成的。

Ant的優勢

Ant是Apache軟件基金會JAKARTA目錄中的一個子項目，它有如下的優勢。
跨平臺性。Ant是存Java語言編寫的，所示具備很好的跨平臺性。
操做簡單。Ant是由一個內置任務和可選任務組成的。Ant運行時須要一個XML文件(構建文件)。

Ant經過調用target樹，就能夠執行各類task。每一個task實現了特定接口對象。因爲Ant構建文件

時XML格式的文件，因此和容易維護和書寫，並且結構很清晰。
Ant能夠集成到開發環境中。因爲Ant的跨平臺性和操做簡單的特色，它很容易集成到一些開發環

境中去。

Ant 開發

Ant的構建文件
當開始一個新的項目時，首先應該編寫Ant構建文件。構建文件定義了構建過程，並被團隊開發

中每一個人使用。Ant構建文件默認命名爲build.xml，也能夠取其餘的名字。只不過在運行的時候

把這個命名看成參數傳給Ant。構建文件能夠放在任何的位置。通常作法是放在項目頂層目錄中

，這樣能夠保持項目的簡潔和清晰。下面是一個典型的項目層次結構。
(1) src存放文件。
(2) class存放編譯後的文件。
(3) lib存放第三方JAR包。
(4) dist存放打包，發佈之後的代碼。
Ant構建文件是XML文件。每一個構建文件定義一個惟一的項目(Project元素)。每一個項目下能夠定

義不少目標(target元素)，這些目標之間能夠有依賴關係。當執行這類目標時，須要執行他們所

依賴的目標。
每一個目標中能夠定義多個任務，目標中還定義了所要執行的任務序列。Ant在構建目標時必須調

用所定義的任務。任務定義了Ant實際執行的命令。Ant中的任務能夠爲3類。
（1） 核心任務。核心任務是Ant自帶的任務。
（2） 可選任務。可選任務實來自第三方的任務，所以須要一個附加的JAR文件。
（3） 用戶自定義的任務。用戶自定義的任務實用戶本身開發的任務。
1.<project>標籤
    每一個構建文件對應一個項目。<project>標籤時構建文件的根標籤。它能夠有多個內在屬性，

就如代碼中所示，其各個屬性的含義分別以下。
(1) default表示默認的運行目標，這個屬性是必須的。
(2) basedir表示項目的基準目錄。
(3) name表示項目名。
(4) description表示項目的描述。
每一個構建文件都對應於一個項目，可是大型項目常常包含大量的子項目，每個子項目均可以有

本身的構建文件。

2.<target>標籤
一個項目標籤下能夠有一個或多個target標籤。一個target標籤能夠依賴其餘的target標籤。例

如，有一個target用於編譯程序，另外一個target用於聲稱可執行文件。在生成可執行文件以前必

須先編譯該文件，因策可執行文件的target依賴於編譯程序的target。Target的全部屬性以下。
(1).name表示標明，這個屬性是必須的。
(2).depends表示依賴的目標。
(3)if表示僅當屬性設置時才執行。
(4)unless表示當屬性沒有設置時才執行。
(5)description表示項目的描述。
Ant的depends屬性指定了target的執行順序。Ant會依照depends屬性中target出現順序依次執行

每一個target。在執行以前，首先須要執行它所依賴的target。程序中的名爲run的target的

depends屬性compile，而名爲compile的target的depends屬性是prepare，因此這幾個target執

行的順序是prepare->compile->run。
一個target只能被執行一次，即便有多個target依賴於它。若是沒有if或unless屬性，target總

會被執行。

3.<mkdir>標籤
該標籤用於建立一個目錄，它有一個屬性dir用來指定所建立的目錄名，其代碼以下：
<mkdir dir=」＄{class.root}」/>
經過以上代碼就建立了一個目錄，這個目錄已經被前面的property標籤所指定。

4<jar>標籤
該標籤用來生成一個JAR文件，其屬性以下。
(1) destfile表示JAR文件名。
(2) basedir表示被歸檔的文件名。
(3) includes表示別歸檔的文件模式。
(4) exchudes表示被排除的文件模式。

5．<javac標籤>
該標籤用於編譯一個或一組java文件，其屬性以下。
(1).srcdir表示源程序的目錄。
(2).destdir表示class文件的輸出目錄。
(3).include表示被編譯的文件的模式。
(4).excludes表示被排除的文件的模式。
(5).classpath表示所使用的類路徑。
(6).debug表示包含的調試信息。
(7).optimize表示是否使用優化。
(8).verbose 表示提供詳細的輸出信息。
(9).fileonerror表示當碰到錯誤就自動中止。

6．<java>標籤
該標籤用來執行編譯生成的.class文件，其屬性以下。
(1).classname 表示將執行的類名。
(2).jar表示包含該類的JAR文件名。
(3).classpath所表示用到的類路徑。
(4).fork表示在一個新的虛擬機中運行該類。
(5).failonerror表示當出現錯誤時自動中止。
(6).output 表示輸出文件。
(7).append表示追加或者覆蓋默認文件。

7.<delete>標籤
該標籤用於刪除一個文件或一組文件，去屬性以下。
(1)/file表示要刪除的文件。
(2).dir表示要刪除的目錄。
(3).includeEmptyDirs 表示指定是否要刪除空目錄，默認值是刪除。
(4).failonerror 表示指定當碰到錯誤是否中止，默認值是自動中止。
(5).verbose表示指定是否列出所刪除的文件，默認值爲不列出。

8.<copy>標籤
該標籤用於文件或文件集的拷貝，其屬性以下。
(1).file 表示源文件。
(2).tofile 表示目標文件。
(3).todir 表示目標目錄。
(4).overwrite 表示指定是否覆蓋目標文件，默認值是不覆蓋。
(5).includeEmptyDirs 表示制定是否拷貝空目錄，默認值爲拷貝。
(6).failonerror 表示指定如目標沒有發現是否自動中止，默認值是中止。
(7).verbose 表示制定是否顯示詳細信息，默認值不顯示。

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 的運行
安裝好Ant而且配置好路徑以後，在命令行中切換到構建文件的目錄，輸入Ant命令就能夠運行

Ant.若沒有指定任何參數，Ant會在當前目錄下查詢build.xml文件。若是找到了就用該文件做爲

構建文件。若是使用了 –find 選項，Ant 就會在上級目錄中找構建文件，直至到達文件系統得

跟目錄。若是構建文件的名字不是build.xml ，則Ant運行的時候就可使用 –buildfile file

,這裏file 指定了要使用的構建文件的名稱，示例以下：
Ant
以下說明了表示當前目錄的構建文件爲build.xml 運行 ant 執行默認的目標。

Ant –buildfile    test.xml
使用當前目錄下的test.xml 文件運行Ant ,執行默認的目標

 

（二）

<?xml version="1.0"?>
<!-- Comments are just as important in buildfiles, do not -->
<!-- avoid writing them! -->
<!-- Example build file for "Ant: The Definitive Guide" -->
<project name="irssibot" default="all" basedir=".">
<!-- Project-wide settings. All directories are relative to the -->
<!-- project directories -->
  <property name="src.dir" value="src"/>
  <property name="doc.dir" value="doc"/>
  <property name="dist.dir" value="dist"/>
  <property name="lib.dir" value="lib"/>
  <property name="bin.dir" value="bin"/>
<!-- Build directories -->
  <property name="build.dir" value="build"/>
  <property name="build.classes" value="${build.dir}/classes"/>
  <property name="build.doc" value="${build.dir}/doc"/>
  <property name="build.lib" value="${build.dir}/lib"/>
     <property name="web" value="${src.dir}/web"/>
<!-- Global settings -->
  <property name="debug.flag" value="on"/>
  <property name="java.lib" value="${java.home}/jre/lib/rt.jar"/>
<!-- Global property for <javac> -->
  <property name="build.compiler" value="modern"/>
  <path id="classpath">
   <fileset dir="${lib.dir}">
   <include name="**/*.jar"/>
   </fileset>
  </path>
 <target name="prepare">
  <mkdir dir="${build.dir}"/>
  <mkdir dir="${build.lib}"/>
  <tstamp/>
  <echo message="${TSTAMP}"/>
 </target>
 
 <target name="all" depends="cleanall,bot,modules,war"/>
 
 <target name="war">
  <war warfile="${src.dir}/web/ecom.war"
   webxml="src/web/WEB-INF/web.xml">
   <fileset dir="src/web"/>
  </war>
 </target>
 
 
<!-- Build the IRC bot application -->
 <target name="bot" depends="prepare">
  <mkdir dir="${build.classes}"/>
  <javac destdir="${build.classes}"
   debug="${debug.flag}"
   deprecation="on">
<!-- We could have used javac's srcdir attribute -->
   <src path="${src.dir}"/>
   <exclude name="irssibot/modules/**"/>
   <classpath refid="classpath"/>
  </javac>
  <jar jarfile="${build.lib}/irssibot.jar"
   basedir="${build.classes}" >
   <exclude name="irssibot/modules/**"/>
  </jar>
 </target>
<!-- Build the IRC bot modules -->
 <target name="modules" depends="prepare,bot">
  <mkdir dir="${build.classes}/modules"/>
  <javac destdir="${build.classes}/modules"
   debug="${debug.flag}"
   deprecation="on" >
<!-- We could have used javac's srcdir attribute -->
   <src path="${src.dir}"/>
   <include name="irssibot/modules/**"/>
   <classpath refid="classpath"/>
  </javac>
  <jar jarfile="${build.lib}/irssimodules.jar"
   basedir="${build.classes}/modules"
   manifest="MANIFEST.MF" >
   <manifest>
    <attribute name="ModuleType" value="irssibot"/>
   </manifest>
   <include name="irssibot/modules/**"/>
  </jar>
 </target>
<!-- Deploy the application in a "ready-to-run" state -->
 <target name="deploy" depends="bot,javadoc">
<!-- Create the distribution directory -->
  <mkdir dir="${dist.dir}"/>
  <mkdir dir="${dist.dir}/bin"/>
  <mkdir dir="${dist.dir}/lib"/>
  <mkdir dir="${dist.dir}/doc"/>
  <mkdir dir="${dist.dir}/config"/>
<!-- Copy the primary program and modules -->
  
  <copy todir="${dist.dir}/lib">
   <fileset dir="${build.classes}"/>
   <fileset dir="${build.lib}" includes="irssibot.jar"/>
   <fileset dir="${build.lib}" includes="irssimodules.jar"/>
   <fileset dir="${lib.dir}" includes="*.jar"/>
  </copy>
<!-- Copy the documentation -->
  <copy todir="${dist.dir}/doc">
   <fileset dir="${doc.dir}"/>
  </copy>
<!-- Copy the pre-fab configuration files -->
  <copy todir="${dist.dir}/config">
   <fileset dir="${lib.dir}" includes="*.xml"/>
  </copy>
<!-- Copy the running scripts -->
  <copy todir="${dist.dir}/bin">
   <fileset dir="${bin.dir}" includes="bot.sh"/>
   <fileset dir="${bin.dir}" includes="bot.bat"/>
  </copy>
 </target>
<!-- Generate the API documentation for the IRC library and the -->
<!-- IRC bot using the library -->
 <target name="javadoc" depends="bot">
  <mkdir dir="${doc.dir}/api"/>
 <!-- <javadoc packagenames="irssibot.*"
      sourcepath="${src.dir}"
   destdir="${doc.dir}/api"
   classpath="${lib.dir}/xerces.jar:${lib.dir}/mysql.jar"
   author="true"
   version="true"
   use="true" />
  -->
 </target>
<!-- Delete class files built during previous builds. Leave
directories -->
 <target name="clean">
  
  <delete>
   <fileset dir="${build.classes}" includes="**/*.class"/>
  </delete>
  <delete dir="${doc.dir}/api"/>
  
 </target>
<!-- Delete any created directories and their contents -->
 <target name="cleanall" depends="clean">
  <delete dir="${build.dir}"/>
  <delete dir="${dist.dir}"/>
  <delete dir="${doc.dir}/api"/>
  
 </target>
</project>

<?xml version="1.0"  encoding="GB2312" ?>

<project default="dist" basedir=".">

<!--
    ===================================================================
      定義屬性（property tasks）
-->

    <!--主要的系統環境屬性-->
    <property environment="env"/><!--取window,unix,solaris...的環境變量-->
    <property name="java.home" value="${env.JAVA_HOME}"/>
    <property name="ant.home"  value="${env.ANT_HOME}"/>

 <!--tomcat 變量 -->
    <property name="tomcat.home"  value="F:\\jakarta-tomcat-5.0.19\\jakarta-tomcat-5.0.19\\webapps\\javacup"/>
    <!--主要的app環境屬性-->
    <property name="app.name"      value="JavaCup"/>
    <property name="app.jar"       value="${app.name}.jar"/>
    <property name="app.copyright" value=" Copyright (c) 2005 華南理工大學電信學院 All rights reserved."/>

    <!--app中src的屬性-->
    <property name="src.dir"    value="src" />
    <property name="src.main"   value="${src.dir}/main"/>
    <!--property name="src.script" value="${src.dir}/script"/>
 <property name="src.conf"   value="${src.dir}/conf"/-->

    <!--app用到的lib-->
    <property name="lib.dir" value="lib"/>

    <!--web-->
    <property name="web.dir" value="web"/>

 <!--app的docs目錄中-->
    <property name="docs.dir"      value="docs"/>

    <!--app的build目錄中-->
    <property name="build.dir"      value="build" />
    <property name="build.classes"  value="${build.dir}/classes"/>
    <property name="build.docs"     value="${build.dir}/docs"/>
    <property name="build.docs.api" value="${build.docs}/api"/>
    <property name="build.lib"      value="${build.dir}/lib"/>

    <!--app的dist (distribution) 目錄中-->
    <property name="dist.dir"      value="dist"/>
    <property name="dist.bin"      value="${dist.dir}/bin"/>
    <property name="dist.docs"     value="${dist.dir}/docs"/>
    <property name="dist.lib"      value="${dist.dir}/lib"/>
  <property name="dist.conf"      value="${dist.dir}/conf"/>  

    <!--
    定義一組路徑之後能夠經過id重用這組路徑 ，例：
    <javac srcdir="src/main" destdir="build/classes">
            <classpath refid="classpath"/>
    </javac>
    -->
    <path id="classpath">
     <fileset dir="${lib.dir}">
                <include name="**/*.jar"/>
        </fileset>  
        <pathelement location="${build.classes}"/>
        <pathelement path="${java.home}/lib/tools.jar"/>       
    </path>

 <target name="check-java-home" unless="env.JAVA_HOME">
  <fail message="JAVA_HOME environment variable must be set!"/>
 </target>
 
 <target name="check-ant-home" unless="env.ANT_HOME">
  <fail message="ANT_HOME environment variable must be set!"/>
 </target>

 <target name="check" depends="check-java-home,check-ant-home">
  <echo message="Check environment variable finished!"/>
 </target>

    <target name="init">
        <!--清除之前目錄-->
        <delete dir="${build.dir}" failonerror="false" />
        <delete dir="${dist.dir}"  failonerror="false"/>

        <!--準備目錄-->
        <mkdir dir="${build.dir}"/>
        <mkdir dir="${build.classes}"/>
        <mkdir dir="${build.docs}"/>
        <mkdir dir="${build.docs.api}"/>
        <mkdir dir="${build.lib}"/>

        <mkdir dir="${dist.dir}"/>
        <mkdir dir="${dist.bin}"/>
        <mkdir dir="${dist.lib}"/>
  <mkdir dir="${dist.conf}"/>

    </target>

<!--
    ===================================================================
      Build the code (Compile Tasks,File Tasks)
    ===================================================================
-->
    <target name="build" depends="init">
        <javac srcdir="${src.dir}" destdir="${build.classes}">
            <classpath refid="classpath"/>
        </javac>
    </target>

<!--
    ===================================================================
      Create the project jars: xxx1.jar and xxx2.jar
    ===================================================================
-->
   <target name="jars" depends="build">
  <copy  file="${src.dir}/util/config.properties" tofile="${build.classes}/util/config.properties" overwrite="true"/>  
        <jar basedir="${build.classes}" jarfile="${build.lib}/${app.jar}"/>
    </target>

<!--
     ===================================================================
       Creates the API documentation
     ===================================================================
-->
    <target name="javadocs"           
            description=" creates the API documentation">
        <copy todir="${build.docs}">
            <fileset dir="${docs.dir}"/>
        </copy>

        <javadoc packagenames="Java_Cup"
                 defaultexcludes="yes"
                 destdir="${build.docs.api}"
                 author="true"
                 version="true"
                 use="true"
          windowtitle="Docs API">
      <fileset dir="${src.dir}" casesensitive="yes" >
     <include name="**/*.java"/>
      </fileset>
   <classpath refid="classpath"/>
      <doctitle><![CDATA[<h2>Java_Cup  API</h2>]]></doctitle>
            <bottom><![CDATA[<i>${app.copyright}</i>]]></bottom>
        </javadoc>
    </target>

<!--
     ===================================================================
       Create the distribution that can run (Archive Tasks)
     ===================================================================
-->
   <target name="dist" depends="check,build,jars,javadocs">
  <!--copy bin 執行文件 -->
        <!--copy todir="${dist.bin}">
            <fileset dir="${src.script}/"/>
        </copy>
  <copy todir="${dist.conf}">
            <fileset dir="${src.conf}/"/>
        </copy-->
    
        <copy todir="${dist.docs}">
            <fileset dir="${build.docs}/"/>
        </copy>
        <!-- copy lib 文件 -->
        <copy todir="${dist.lib}">
            <fileset dir="${build.lib}/"/>
        </copy>
        <copy todir="${dist.lib}">
            <fileset dir="${lib.dir}/"/>
        </copy>
  <!--delete dir="${build.dir}" failonerror="false" /-->
  <!-- jsp 拷貝到本機的web_inf目錄 -->
  <!--copy  file="${dist.lib}/JavaCup.jar" tofile="${tomcat.home}/WEB-INF/lib/JavaCup.jar" overwrite="true"/-->  
    
     <!--copy todir="${tomcat.home}">
         <fileset dir="${web.dir}/"/>
     </copy-->

   </target>

</project>

職場 休閒 ant　build.xml 技術研究

0

分享

微博 QQ 微信

收藏

上一篇：Struts2.0之Action... 下一篇：dos命令全集

su3390

47篇文章，32W+人氣，0粉絲

關注