ant基礎

[轉]http://hi.baidu.com/kdunzgqotvdfjze/item/02e9d1c7d199a0bb0d0a7bdc

Ant 的最完整build.xml(一)

Ant的概念
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>標籤 
一個項目標籤驢梢雜幸桓齷蚨喔?/span>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" encoding="GB2312" ?>
<!--
=======================================================================
hello-ant 項目 ,學習ant工具的build file.

參照ant的jakarta-ant-1.6alpha的build.xml

Copyright (c) 2002 The Neusoft Software Foundation. All rights
reserved.

=======================================================================
-->
<!--
文檔結構爲:
<project>
<property/> 全局變量的定義
<property/>...

<target name="1"> 任務組(tasks)
<javac></javac> 一項javac任務
...
<oneTask></ontTask> 一項其它任務
</target>

<target name="2">
<javac></javac>
...
<oneTask></ontTask>
</target>
</project>

project代表一個項目,
default:運行到名稱爲"dist"的target(任務組)
basedir:基準路徑。
-->
<project default="dist" basedir=".">

<!--
===================================================================
定義屬性(property tasks)
最好把用到的路徑呀,名稱呀都在這裏定義成全局變量
例:定義
<property name="a" value="hello"/>
以後就可以這樣用它:
<property name="b" value="${a}/b"/>
現在:b=="hello/b"
===================================================================
-->

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

<!--主要的app環境屬性-->
<property name="app.name" value="hello-ant"/>
<property name="app.jar" value="${app.name}.jar"/>
<property name="app.copyright" value=" Copyright (c) 2002 The Neusoft Software Foundation. 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"/>

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

<!--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"/>

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

<!--
定義一組路徑以後可以通過id重用這組路徑 ,例:
<javac srcdir="src/main" destdir="build/classes">
<classpath refid="classpath"/>
</javac>
-->
<path id="classpath">
<!--本項目只有一個java,用不上classpath,這裏只是做個例子-->
<pathelement location="${build.classes}"/>
<pathelement path="${java.home}/lib/tools.jar"/>
</path>

<!--
===================================================================
init 準備目錄(File Tasks)
主要的目錄結構通常是不會變的,一起生成他們
===================================================================
-->
<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}"/>

</target>

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

<!--
===================================================================
打包文檔(Archive Tasks)
Create the project jars: xxx1.jar and xxx2.jar
===================================================================
-->
<target name="jars" depends="build">
<jar basedir="${build.classes}" jarfile="${build.lib}/${app.jar}"/>
</target>

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

<javadoc packagenames="hello.ant.*"
sourcepath="${src.main}"
defaultexcludes="yes"
destdir="${build.docs.api}"
author="true"
version="true"
use="true"
windowtitle="Docs API">
<doctitle><![CDATA[<h1>hello ant Docs API</h1>]]></doctitle>
<bottom><![CDATA[<i>${app.copyright}</i>]]></bottom>
<tag name="todo" scope="all" description="To do:" />
</javadoc>
</target>

<!--
===================================================================
Create the distribution that can run (Archive Tasks)
主要是從各目錄中把該copy的copy上
===================================================================
-->
<target name="dist" depends="javadocs">
<!--copy bin 執行文件 -->
<copy todir="${dist.bin}">
<fileset dir="${src.script}/"/>
</copy>
<copy todir="${dist.docs}">
<fileset dir="${build.docs}/"/>
</copy>
<!-- copy lib 文件 -->
<copy todir="${dist.lib}">
<fileset dir="${build.lib}/"/>
</copy>

</target>
<!--
===================================================================
Cleans everything(File Tasks)
例如可以刪除build中的文件
===================================================================
-->
</project>

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