【轉】Ant之build.xml詳解

賀滿發表於2013-12-18

關鍵字: 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 ,執行預設的目標

相關文章