ANT build.xml文件詳解

Ant的優勢

跨平臺性。Ant是用Java語言編寫的，所示具備很好的跨平臺性。

操做簡單。Ant是由一個內置任務和可選任務組成的。

Ant運行時須要一個XML文件(構建文件)。

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

Ant開發

Ant的構建文件

Ant構建文件默認命名爲build.xml，也能夠取其餘的名字。只不過在運行的時候把這個命名看成參數傳給Ant。構建文件能夠放在任何的位置。通常作法是放在項目頂層目錄中，這樣能夠保持項目的簡潔和清晰。

下面是一個典型的項目層次結構。

(1) src存放文件。

(2) class存放編譯後的文件。

(3) lib存放第三方JAR包。

(4) dist存放打包，發佈之後的代碼。

每一個構建文件定義一個惟一的項目(Project元素)。

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

每一個目標中能夠定義多個任務，目標中還定義了所要執行的任務序列。

Ant在構建目標時必須調用所定義的任務。

任務定義了Ant實際執行的命令。

Ant中的任務能夠爲3類。

（1） 核心任務。核心任務是Ant自帶的任務。

（2） 可選任務。可選任務是來自第三方的任務，所以須要一個附加的JAR文件。

（3） 用戶自定義的任務。用戶自定義的任務實用戶本身開發的任務。

Build.XML中的標籤

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 ,執行默認的目標

=====================================================================

=====================================================================

1.目標:知足基本Java項目的全面構建和部署需求。

2.參照NetBeans的build.xml設計，結構如圖：

build.xml代碼：

<?xml version="1.0" encoding="UTF-8"?>
<project name="Project Name" default="default" basedir=".">
<description>Builds, tests, and runs the project.</description>
<!-- ********************************************************
引入資源和定義資源
******************************************************** -->
<!--
引入資源
-->
<property file="build.properties"/>
<property environment="env"/>
<!--
定義源程序文件夾
-->
<property name="src.dir" location="src/java"/>
<property name="test.dir" location="test"/>
<property name="web.dir" location="web"/>
<!--
定義目標程序文件夾
-->
<property name="build.dir" location="build"/>
<property name="build.classes.dir" location="${build.dir}/classes"/>
<property name="build.test.dir" location="${build.dir}/test"/>
<property name="dist.dir" location="dist"/>
<!--
定義其餘文件夾
-->
<property name="lib.dir" location="lib"/>
<property name="doc.dir" location="doc"/>
<property name="index.dir" location="index"/>
<property name="deploy.dir" location="${env.CATALINA_HOME}"/>
<property name="deploy.lib.dir" location="${deploy.dir}/lib"/>
<!--
定義其餘文件
-->
<property name="dist.jar" location="${dist.dir}/WEB-INF/lib/${project.name}-${project.version}.jar"/>
<property name="deploy.war" location="${deploy.dir}/webapps/${project.name}.war"/>
<!--
定義其餘屬性
-->
<available file="${dist.dir}/enduser.agreement" property="final.version"/>
<!-- ********************************************************
設置path
******************************************************** -->
<path id="project.classpath">
<pathelement location="${java.home}/jre/lib/rt.jar"/>
<pathelement location="${build.classes.dir}"/>
<pathelement location="${build.test.dir}"/>
<fileset dir="${deploy.lib.dir}">
<include name="**/*.jar"/>
</fileset>
<fileset dir="${lib.dir}">
<include name="**/*.jar"/>
</fileset>
</path>
<target name="init" description="　信息　: 顯示項目基本信息.">
<tstamp>
<format property="now" pattern="yyyy-MM-dd HH:mm"/>
</tstamp>
<echo> ==================================================
||
||   顯示項目基本信息.
||
||   項目名稱: ${project.name}
||   項目版本: ${project.version}
||   　做者　: ${author}
||   　時戳　: ${DSTAMP}-${TSTAMP}
||
||   用法:
||      ant -buildfile build.xml compile 或
||      ant compile 或
||      ant 甚至
||      ant clean dist
||   幫助:
||      ant -projecthelp
||
==================================================</echo>
</target>
<target name="prepare" depends="init" description="　準備　: 建立各類文件夾.">
<echo> ==================================================
||
||   建立各類文件夾.
||
================================================== </echo>
<!--  建立源程序文件夾  -->
<mkdir dir="${src.dir}"/>
<mkdir dir="${test.dir}"/>
<mkdir dir="${web.dir}"/>
<mkdir dir="${web.dir}/WEB-INF"/>
<!--  建立目標程序文件夾  -->
<mkdir dir="${build.dir}"/>
<mkdir dir="${build.classes.dir}"/>
<mkdir dir="${build.test.dir}"/>
<mkdir dir="${dist.dir}"/>
<mkdir dir="${dist.dir}/WEB-INF"/>
<mkdir dir="${dist.dir}/WEB-INF/lib"/>
<!--  建立其餘文件夾  -->
<mkdir dir="${lib.dir}"/>
<mkdir dir="${doc.dir}"/>
<mkdir dir="${index.dir}"/>
</target>
<target name="javadoc" depends="prepare" description="生成文檔: 生成幫助文檔.">
<echo> ==================================================
||
||   生成幫助文檔.
||
==================================================</echo>
<javadoc packagenames="*.*" sourcepath="${src.dir}" destdir="${doc.dir}" author="true" version="true" use="true" encoding="UTF-8">
<classpath refid="project.classpath"/>
</javadoc>
</target>
<target name="compile" depends="prepare" description="　編譯　: 編譯全部源程序." unless="final.version">
<echo> ==================================================
||
||   編譯全部源程序.
||
==================================================</echo>
<javac srcdir="${src.dir}" destdir="${build.classes.dir}" debug="on" deprecation="on" encoding="UTF-8">
<compilerarg value="-Xlint:unchecked"/>
<classpath refid="project.classpath"/>
</javac>
<javac srcdir="${test.dir}" destdir="${build.test.dir}" encoding="UTF-8">
<compilerarg value="-Xlint:unchecked"/>
<classpath refid="project.classpath"/>
</javac>
</target>
<target name="test" depends="compile" description="　測試　: 運行全部測試程序.">
<echo> ==================================================
||
||   運行全部測試程序.
||
==================================================</echo>
<junit haltonfailure="true">
<classpath refid="project.classpath"/>
<formatter type="brief" usefile="false"/>
<batchtest>
<fileset dir="${build.test.dir}" includes="**/*Test.class"/>
</batchtest>
<sysproperty key="doc.dir" value="${doc.dir}"/>
<sysproperty key="index.dir" value="${index.dir}"/>
</junit>
</target>
<target name="dist" depends="compile" description="　分發　: 生成分發文件.">
<echo> ==================================================
||
||   生成分發文件:
||      ${dist.jar}
||
==================================================</echo>
<!-- 從打包文件排除單元測試 -->
<jar destfile="${dist.jar}" basedir="${build.classes.dir}" includes="**/*.*" excludes="**/*Test.class">
<!-- manifest="MANIFEST.MF" > -->
<manifest>
<attribute name="Author" value="${author}"/>
</manifest>
</jar>
</target>
<!-- ********************************************************
用於調試
******************************************************** -->
<target name="debug" depends="dist" description="　調試　"/>
<!-- ********************************************************
用於效驗
******************************************************** -->
<target name="verify" depends="dist" description="　效驗　"/>
<target name="run-deploy" depends="dist" description="　部署　: 把文件部署到指定位置.">
<echo> ==================================================
||
||   把文件部署到指定位置:
||      ${deploy.war}
||
==================================================</echo>
<copy todir="${dist.dir}/WEB-INF/lib">
<fileset dir="${lib.dir}" includes="*.jar"/>
</copy>
<copy todir="${dist.dir}">
<fileset dir="${web.dir}" includes="**/*.*"/>
</copy>
<jar destfile="${deploy.war}" basedir="${dist.dir}" includes="**/*.*" excludes="**/*Test.class">
<!-- manifest="MANIFEST.MF" > -->

一個ant的build.xml文件實例

很簡單，很實用，寫完以後，發現，嘿嘿！我竟然能夠不翻doc寫build文件了。

<?xml version="1.0" encoding="utf-8" ?>
<project name="dian_bid" basedir="." default="deploy">
 
 <property name="source" location="src" />
 <property name="resource" location="res" />
 <property name="test-srouce" location="test" />
 <property name="release-resource" location="release" />
 <property name="dest" location="dest" />
 
 <property name="webroot" location="web"/>
 <property name="tomcat-root" location="D:/Java/apache-tomcat-a"/>
 
 <target name="clean">
  <echo message="清理生成過程當中的臨時文件" />
  <delete dir="${tomcat-root}/webapps/bid" />
  <delete dir="${webroot}/WEB-INF/classes" />
  <delete dir="${dest}" />
 </target>
 
 <target name="prepare" depends="clean">
  <mkdir dir="${webroot}/WEB-INF/classes"/>
  <mkdir dir="${dest}" />
 </target>
 
 <target name="build" depends="prepare">
  <echo message="編譯Java源代碼" />
  <javac destdir="${webroot}/WEB-INF/classes" srcdir="${source}">
   <sourcepath path="${test-srouce}" />
   <classpath>
    <fileset dir="${tomcat-root}/lib">
     <include name="**/*.jar"/>
    </fileset>
    <fileset dir="${webroot}/WEB-INF/lib">
     <include name="**/*.jar"/>
    </fileset>
   </classpath>
  </javac>
 </target>
 
 <target name="package" depends="build">
  <echo message="將Web工程打包成war可部署文件格式" />
  <copydir dest="${webroot}/WEB-INF/classes" src="${resource}" />
  <copydir dest="${webroot}/WEB-INF/classes" src="${release-resource}" />
  <war destfile="${dest}/bid.war"  basedir="${webroot}" webxml="${webroot}/WEB-INF/web.xml"/>
 </target>
 
 <target name="deploy" depends="package">
  <echo message="開始部署BID系統到服務器上" />
  <copy file="${dest}/bid.war" todir="${tomcat-root}/webapps" />
  <echo message="中止tomcat服務器" />
  <exec executable="${tomcat-root}/bin/shutdown.bat" />
  <echo message="啓動tomcat服務器" />
  <exec executable="${tomcat-root}/bin/startup.bat" />
  <echo message="部署BID系統完成" />
 </target>
</project>