Ant_的最完整build.xml解釋

轉載自:https://www.cnblogs.com/xionghui/archive/2012/03/13/2393679.html

作者:_安靜

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代碼

  1. <?xml version="1.0" encoding="GB2312" ?>  
  2. <!--  
  3. =======================================================================  
  4. hello-ant 項目 ,學習ant工具的build file.  
  5.   
  6. 參照ant的jakarta-ant-1.6alpha的build.xml  
  7.   
  8. Copyright (c) 2002 The Neusoft Software Foundation. All rights  
  9. reserved.  
  10.   
  11. =======================================================================  
  12. -->  
  13. <!--  
  14. 文檔結構爲:  
  15. <project>  
  16. <property/> 全局變量的定義  
  17. <property/>...  
  18.   
  19. <target name="1"> 任務組(tasks)  
  20. <javac></javac> 一項javac任務  
  21. ...  
  22. <oneTask></ontTask> 一項其它任務  
  23. </target>  
  24.   
  25. <target name="2">  
  26. <javac></javac>  
  27. ...  
  28. <oneTask></ontTask>  
  29. </target>  
  30. </project>  
  31.   
  32. project代表一個項目,  
  33. default:運行到名稱爲"dist"的target(任務組)  
  34. basedir:基準路徑。  
  35. -->  
  36. <project default="dist" basedir=".">  
  37.   
  38. <!--  
  39. ===================================================================  
  40. 定義屬性(property tasks)  
  41. 最好把用到的路徑呀,名稱呀都在這裏定義成全局變量  
  42. 例:定義  
  43. <property name="a" value="hello"/>  
  44. 以後就可以這樣用它:  
  45. <property name="b" value="${a}/b"/>  
  46. 現在:b=="hello/b"  
  47. ===================================================================  
  48. -->  
  49.   
  50. <!--主要的系統環境屬性-->  
  51. <property environment="env"/><!--取window,unix...的環境變量-->  
  52. <property name="java.home" value="${env.JAVA_HOME}"/>  
  53. <property name="ant.home" value="${env.ANT_HOME}"/>  
  54.   
  55. <!--主要的app環境屬性-->  
  56. <property name="app.name" value="hello-ant"/>  
  57. <property name="app.jar" value="${app.name}.jar"/>  
  58. <property name="app.copyright" value=" Copyright (c) 2002 The Neusoft Software Foundation. All rights reserved."/>  
  59.   
  60. <!--app中src的屬性-->  
  61. <property name="src.dir" value="src" />  
  62. <property name="src.main" value="${src.dir}/main"/>  
  63. <property name="src.script" value="${src.dir}/script"/>  
  64.   
  65. <!--app用到的lib-->  
  66. <property name="lib.dir" value="lib"/>  
  67.   
  68. <!--app的build目錄中-->  
  69. <property name="build.dir" value="build" />  
  70. <property name="build.classes" value="${build.dir}/classes"/>  
  71. <property name="build.docs" value="${build.dir}/docs"/>  
  72. <property name="build.docs.api" value="${build.docs}/api"/>  
  73. <property name="build.lib" value="${build.dir}/lib"/>  
  74.   
  75. <!--app的dist (distribution) 目錄中-->  
  76. <property name="dist.dir" value="dist"/>  
  77. <property name="dist.bin" value="${dist.dir}/bin"/>  
  78. <property name="dist.docs" value="${dist.dir}/docs"/>  
  79. <property name="dist.lib" value="${dist.dir}/lib"/>  
  80.   
  81. <!--app的docs目錄中-->  
  82. <property name="docs.dir" value="docs"/>  
  83.   
  84. <!--  
  85. 定義一組路徑以後可以通過id重用這組路徑 ,例:  
  86. <javac srcdir="src/main" destdir="build/classes">  
  87. <classpath refid="classpath"/>  
  88. </javac>  
  89. -->  
  90. <path id="classpath">  
  91. <!--本項目只有一個java,用不上classpath,這裏只是做個例子-->  
  92. <pathelement location="${build.classes}"/>  
  93. <pathelement path="${java.home}/lib/tools.jar"/>  
  94. </path>  
  95.   
  96. <!--  
  97. ===================================================================  
  98. init 準備目錄(File Tasks)  
  99. 主要的目錄結構通常是不會變的,一起生成他們  
  100. ===================================================================  
  101. -->  
  102. <target name="init">  
  103. <!--清除以前目錄-->  
  104. <delete dir="${build.dir}" failonerror="false" />  
  105. <delete dir="${dist.dir}" failonerror="false"/>  
  106.   
  107. <!--準備目錄-->  
  108. <mkdir dir="${build.dir}"/>  
  109. <mkdir dir="${build.classes}"/>  
  110. <mkdir dir="${build.docs}"/>  
  111. <mkdir dir="${build.docs.api}"/>  
  112. <mkdir dir="${build.lib}"/>  
  113.   
  114. <mkdir dir="${dist.dir}"/>  
  115. <mkdir dir="${dist.bin}"/>  
  116. <mkdir dir="${dist.lib}"/>  
  117.   
  118. </target>  
  119.   
  120. <!--  
  121. ===================================================================  
  122. Build the code (Compile Tasks,File Tasks)  
  123. ===================================================================  
  124. -->  
  125. <target name="build" depends="init">  
  126. <!--編譯-->  
  127. <javac srcdir="${src.main}" destdir="${build.classes}">  
  128. <classpath refid="classpath"/>  
  129. </javac>  
  130. </target>  
  131.   
  132. <!--  
  133. ===================================================================  
  134. 打包文檔(Archive Tasks)  
  135. Create the project jars: xxx1.jar and xxx2.jar  
  136. ===================================================================  
  137. -->  
  138. <target name="jars" depends="build">  
  139. <jar basedir="${build.classes}" jarfile="${build.lib}/${app.jar}"/>  
  140. </target>  
  141.   
  142. <!--  
  143. ===================================================================  
  144. Creates the API documentation  
  145. ===================================================================  
  146. -->  
  147. <target name="javadocs"  
  148. depends="jars"  
  149. description="--> creates the API documentation">  
  150. <!--copy docs 手冊... -->  
  151. <copy todir="${build.docs}">  
  152. <fileset dir="${docs.dir}"/>  
  153. </copy>  
  154.   
  155. <javadoc packagenames="hello.ant.*"  
  156. sourcepath="${src.main}"  
  157. defaultexcludes="yes"  
  158. destdir="${build.docs.api}"  
  159. author="true"  
  160. version="true"  
  161. use="true"  
  162. windowtitle="Docs API">  
  163. <doctitle><![CDATA[<h1>hello ant Docs API</h1>]]></doctitle>  
  164. <bottom><![CDATA[<i>${app.copyright}</i>]]></bottom>  
  165. <tag name="todo" scope="all" description="To do:" />  
  166. </javadoc>  
  167. </target>  
  168.   
  169. <!--  
  170. ===================================================================  
  171. Create the distribution that can run (Archive Tasks)  
  172. 主要是從各目錄中把該copy的copy上  
  173. ===================================================================  
  174. -->  
  175. <target name="dist" depends="javadocs">  
  176. <!--copy bin 執行文件 -->  
  177. <copy todir="${dist.bin}">  
  178. <fileset dir="${src.script}/"/>  
  179. </copy>  
  180. <copy todir="${dist.docs}">  
  181. <fileset dir="${build.docs}/"/>  
  182. </copy>  
  183. <!-- copy lib 文件 -->  
  184. <copy todir="${dist.lib}">  
  185. <fileset dir="${build.lib}/"/>  
  186. </copy>  
  187.   
  188. </target>  
  189. <!--  
  190. ===================================================================  
  191. Cleans everything(File Tasks)  
  192. 例如可以刪除build中的文件  
  193. ===================================================================  
  194. -->  
  195. </project>  

<?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>




趁熱打鐵,接着上面的再發一個實例:

Xml代碼

  1. <?xml version="1.0"?>  
  2. <project name="ssh" basedir="." default="usage">  
  3.       <property name="name" value="ssh"/>  
  4.       <property name="war.dir" value="war"/>  
  5.       <property name="src.dir" value="src"/>  
  6.       <property name="client.dir" value="client"/>  
  7.       <property name="build.dir" value=".classes"/>  
  8.       <property name="webcontent.dir" value="WebContent"/>  
  9.       <property name="prjlib.dir" value="lib"/>      
  10.       <property name="webcontentlib.dir" value="${webcontent.dir}/WEB-INF/lib"/>  
  11.       <property name="weblib.dir" value="${war.dir}/WEB-INF/lib"/>  
  12.       <property name="dist.dir" value="dist"/>  
  13.       <property environment="env"/>  
  14.       <property name="tomcat.home" value="${env.CATALINA_HOME}"/>  
  15.       <property name="webapp.dist" value="${dist.dir}/webapps"/>     
  16.       <path id="master-classpath">  
  17.           <fileset dir="${webcontentlib.dir}">  
  18.               <include name="hibernate3.jar"/>  
  19.               <include name="spring.jar"/>              
  20.               <include name="struts.jar"/>              
  21.               <include name="struts-el.jar"/>              
  22.               <include name="struts-menu-2.4.2.jar"/>              
  23.               <include name="acegi-security-1.0.2.jar"/>              
  24.               <include name="activation.jar"/>              
  25.               <include name="antlr.jar"/>              
  26.               <include name="antlr-2.7.6.jar"/>              
  27.               <include name="asm.jar"/>              
  28.               <include name="aspectjweaver-1.5.2.jar"/>              
  29.               <include name="cglib-2.1.3.jar"/>              
  30.               <include name="commons-beanutils.jar"/>              
  31.               <include name="commons-codec-1.3.jar"/>              
  32.               <include name="commons-collections.jar"/>              
  33.               <include name="commons-dbcp.jar"/>              
  34.               <include name="commons-digester.jar"/>              
  35.               <include name="commons-fileupload.jar"/>              
  36.               <include name="commons-io.jar"/>      
  37.               <include name="commons-lang.jar"/>              
  38.               <include name="commons-logging-1.1.jar"/>              
  39.               <include name="commons-pool.jar"/>              
  40.               <include name="commons-validator.jar"/>              
  41.               <include name="displaytag-1.1.jar"/>              
  42.               <include name="dom4j-1.6.1.jar"/>              
  43.               <include name="dwr.jar"/>              
  44.               <include name="ehcache-1.2.3.jar"/>              
  45.               <include name="itext-1.4.jar"/>              
  46.               <include name="jakarta-oro.jar"/>              
  47.               <include name="jstl.jar"/>              
  48.               <include name="jta.jar"/>              
  49.               <include name="log4j-1.2.11.jar"/>              
  50.               <include name="mail.jar"/>              
  51.               <include name="oscache-2.3.2.jar"/>              
  52.               <include name="mysql-connector-java-5.0.3-bin.jar"/>              
  53.               <include name="sitemesh-2.2.1.jar"/>              
  54.               <include name="standard.jar"/>              
  55.               <include name="urlrewrite-3.0-beta.jar"/>              
  56.               <include name="velocity-1.4.jar"/>              
  57.               <include name="velocity-tools-view-1.1.jar"/>              
  58.           </fileset>  
  59.           <fileset dir="${prjlib.dir}/servletapi-2.3">  
  60.               <include name="servletapi-2.3.jar"/>  
  61.           </fileset>          
  62.       </path>     
  63.       <target name="usage">  
  64.           <echo message=""/>  
  65.           <echo message="Spring JPetStore build file"/>  
  66.           <echo message="------------------------------------------------------"/>  
  67.           <echo message=""/>  
  68.           <echo message="Available targets are:"/>  
  69.           <echo message=""/>  
  70.           <echo message="clean      --> Clean output dirs"/>  
  71.           <echo message="build      --> Compile main Java sources and copy libraries"/>  
  72.           <echo message="warfile --> Build the web application archive"/>  
  73.           <echo message="all        --> Clean, build, warfile"/>  
  74.           <echo message=""/>  
  75.       </target>     
  76.       <target name="clean" description="Clean output dirs (build, weblib, dist)">  
  77.           <delete dir="${build.dir}"/>  
  78.           <delete dir="${weblib.dir}"/>  
  79.           <delete dir="${war.dir}"/>  
  80.           <delete dir="${dist.dir}"/>  
  81.           <delete file="client/${name}.jar"/>  
  82.       </target>  
  83.       <target name="build" description="Compile main source tree java files into class files, generate jar files">  
  84.           <mkdir dir="${build.dir}"/>  
  85.           <mkdir dir="${war.dir}"/>  
  86.           <javac destdir="${build.dir}" source="1.3" target="1.3" debug="true"  
  87.                   deprecation="false" optimize="false" failonerror="true">  
  88.               <src path="${src.dir}"/>  
  89.               <classpath refid="master-classpath"/>  
  90.           </javac>  
  91.           <mkdir dir="${weblib.dir}"/>  
  92.           <mkdir dir="${war.dir}/WEB-INF/classes"/>  
  93.           <jar jarfile="${weblib.dir}/${name}.jar" compress="true" basedir="${build.dir}"/>  
  94.           <copy todir="${war.dir}" preservelastmodified="true">  
  95.               <fileset dir="${webcontent.dir}">  
  96.                   <include name="**/**"/>  
  97.                   <include name="**.**"/>  
  98.               </fileset>  
  99.           </copy>  
  100.           <copy todir="${war.dir}/WEB-INF/classes" preservelastmodified="true">  
  101.               <fileset dir="${src.dir}">  
  102.                   <include name="*.xml"/>  
  103.                   <include name="**/*.properties"/>  
  104.                   <include name="**/*.vm"/>  
  105.                   <exclude name="**/.*"/>  
  106.               </fileset>  
  107.           </copy>          
  108.          
  109.           <copy file="${weblib.dir}/${name}.jar" tofile="${client.dir}/${name}.jar"/>  
  110.       </target>  
  111.       <target name="dist" depends="warfile">  
  112.           <!--   
  113.               Delegate to warfile target by depending on it. dist is just to offer  
  114.               a generic target name across all Spring sample apps that may be used  
  115.               for autobuilds testing.  
  116.           -->  
  117.       </target>  
  118.       <target name="warfile" depends="build" description="Build the web application archive">  
  119.           <mkdir dir="${dist.dir}"/>  
  120.           <war warfile="${dist.dir}/${name}.war" basedir="${war.dir}" webxml="${webcontent.dir}/WEB-INF/web.xml">  
  121.               <include name="*"/>  
  122.               <include name="images/**"/>  
  123.               <include name="common/**"/>  
  124.               <include name="decorators/**"/>  
  125.               <include name="scripts/**"/>  
  126.               <include name="styles/**"/>  
  127.               <include name="WEB-INF/*.*"/>  
  128.               <include name="WEB-INF/lib/**"/>  
  129.               <include name="WEB-INF/pages/**"/>  
  130.               <include name="WEB-INF/classes/**"/>  
  131.               <exclude name="WEB-INF/web.xml"/>  
  132.           </war>  
  133.       </target>  
  134.       <target name="all" depends="clean,build,warfile" description="Clean,build,warfile"/>  
  135. </project>  

<?xml version="1.0"?>

<project name="ssh" basedir="." default="usage">

      <property name="name" value="ssh"/>

      <property name="war.dir" value="war"/>

      <property name="src.dir" value="src"/>

      <property name="client.dir" value="client"/>

      <property name="build.dir" value=".classes"/>

      <property name="webcontent.dir" value="WebContent"/>

      <property name="prjlib.dir" value="lib"/>   

      <property name="webcontentlib.dir" value="${webcontent.dir}/WEB-INF/lib"/>

      <property name="weblib.dir" value="${war.dir}/WEB-INF/lib"/>

      <property name="dist.dir" value="dist"/>

      <property environment="env"/>

      <property name="tomcat.home" value="${env.CATALINA_HOME}"/>

      <property name="webapp.dist" value="${dist.dir}/webapps"/>  

      <path id="master-classpath">

          <fileset dir="${webcontentlib.dir}">

              <include name="hibernate3.jar"/>

              <include name="spring.jar"/>           

              <include name="struts.jar"/>           

              <include name="struts-el.jar"/>           

              <include name="struts-menu-2.4.2.jar"/>           

              <include name="acegi-security-1.0.2.jar"/>           

              <include name="activation.jar"/>           

              <include name="antlr.jar"/>           

              <include name="antlr-2.7.6.jar"/>           

              <include name="asm.jar"/>           

              <include name="aspectjweaver-1.5.2.jar"/>           

              <include name="cglib-2.1.3.jar"/>           

              <include name="commons-beanutils.jar"/>           

              <include name="commons-codec-1.3.jar"/>           

              <include name="commons-collections.jar"/>           

              <include name="commons-dbcp.jar"/>           

              <include name="commons-digester.jar"/>           

              <include name="commons-fileupload.jar"/>           

              <include name="commons-io.jar"/>   

              <include name="commons-lang.jar"/>           

              <include name="commons-logging-1.1.jar"/>           

              <include name="commons-pool.jar"/>           

              <include name="commons-validator.jar"/>           

              <include name="displaytag-1.1.jar"/>           

              <include name="dom4j-1.6.1.jar"/>           

              <include name="dwr.jar"/>           

              <include name="ehcache-1.2.3.jar"/>           

              <include name="itext-1.4.jar"/>           

              <include name="jakarta-oro.jar"/>            

              <include name="jstl.jar"/>           

              <include name="jta.jar"/>           

              <include name="log4j-1.2.11.jar"/>           

              <include name="mail.jar"/>           

              <include name="oscache-2.3.2.jar"/>           

              <include name="mysql-connector-java-5.0.3-bin.jar"/>           

              <include name="sitemesh-2.2.1.jar"/>           

              <include name="standard.jar"/>           

              <include name="urlrewrite-3.0-beta.jar"/>           

              <include name="velocity-1.4.jar"/>           

              <include name="velocity-tools-view-1.1.jar"/>           

          </fileset>

          <fileset dir="${prjlib.dir}/servletapi-2.3">

              <include name="servletapi-2.3.jar"/>

          </fileset>       

      </path>  

      <target name="usage">

          <echo message=""/>

          <echo message="Spring JPetStore build file"/>

          <echo message="------------------------------------------------------"/>

          <echo message=""/>

          <echo message="Available targets are:"/>

          <echo message=""/>

          <echo message="clean      --> Clean output dirs"/>

          <echo message="build      --> Compile main Java sources and copy libraries"/>

          <echo message="warfile --> Build the web application archive"/>

          <echo message="all        --> Clean, build, warfile"/>

          <echo message=""/>

      </target>  

      <target name="clean" description="Clean output dirs (build, weblib, dist)">

          <delete dir="${build.dir}"/>

          <delete dir="${weblib.dir}"/>

          <delete dir="${war.dir}"/>

          <delete dir="${dist.dir}"/>

          <delete file="client/${name}.jar"/>

      </target>

      <target name="build" description="Compile main source tree java files into class files, generate jar files">

          <mkdir dir="${build.dir}"/>

          <mkdir dir="${war.dir}"/>

          <javac destdir="${build.dir}" source="1.3" target="1.3" debug="true"

                  deprecation="false" optimize="false" failonerror="true">

              <src path="${src.dir}"/>

              <classpath refid="master-classpath"/>

          </javac>

          <mkdir dir="${weblib.dir}"/>

          <mkdir dir="${war.dir}/WEB-INF/classes"/>

          <jar jarfile="${weblib.dir}/${name}.jar" compress="true" basedir="${build.dir}"/>

          <copy todir="${war.dir}" preservelastmodified="true">

              <fileset dir="${webcontent.dir}">

                  <include name="**/**"/>

                  <include name="**.**"/>

              </fileset>

          </copy>

          <copy todir="${war.dir}/WEB-INF/classes" preservelastmodified="true">

              <fileset dir="${src.dir}">

                  <include name="*.xml"/>

                  <include name="**/*.properties"/>

                  <include name="**/*.vm"/>

                  <exclude name="**/.*"/>

              </fileset>

          </copy>       

      

          <copy file="${weblib.dir}/${name}.jar" tofile="${client.dir}/${name}.jar"/>

      </target>

      <target name="dist" depends="warfile">

          <!--

              Delegate to warfile target by depending on it. dist is just to offer

              a generic target name across all Spring sample apps that may be used

              for autobuilds testing.

          -->

      </target>

      <target name="warfile" depends="build" description="Build the web application archive">

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

          <war warfile="${dist.dir}/${name}.war" basedir="${war.dir}" webxml="${webcontent.dir}/WEB-INF/web.xml">

              <include name="*"/>

              <include name="images/**"/>

              <include name="common/**"/>

              <include name="decorators/**"/>

              <include name="scripts/**"/>

              <include name="styles/**"/>

              <include name="WEB-INF/*.*"/>

              <include name="WEB-INF/lib/**"/>

              <include name="WEB-INF/pages/**"/>

              <include name="WEB-INF/classes/**"/>

              <exclude name="WEB-INF/web.xml"/>

          </war>

      </target>

      <target name="all" depends="clean,build,warfile" description="Clean,build,warfile"/>

</project>


在Eclipse中使用Ant Ant是Java平臺下非常棒的批處理命令執行程序,能非常方便地自動完成編譯,測試,打包,部署等等一系列任務,大大提高開發效率。如果你現在還沒有開始使用Ant,那就要趕快開始學習使用,使自己的開發水平上一個新臺階。

Eclipse中已經集成了Ant,我們可以直接在Eclipse中運行Ant。

以前面建立的Hello工程爲例,創建以下目錄結構:



新建一個build.xml,放在工程根目錄下。build.xml定義了Ant要執行的批處理命令。雖然Ant也可以使用其它文件名,但是遵循標準能更使開發更規範,同時易於與別人交流。
通常,src存放Java源文件,classes存放編譯後的class文件,lib存放編譯和運行用到的所有jar文件,web存放JSP等web文件,dist存放打包後的jar文件,doc存放API文檔。
然後在根目錄下創建build.xml文件,輸入以下內容:

Xml代碼

  1. <?xml version="1.0"?>  
  2. <project name="Hello world" default="doc">  
  3. <!-- properies -->  
  4.      <property name="src.dir" value="src" />  
  5.      <property name="report.dir" value="report" />  
  6.      <property name="classes.dir" value="classes" />  
  7.      <property name="lib.dir" value="lib" />  
  8.      <property name="dist.dir" value="dist" />  
  9. <property name="doc.dir" value="doc"/>  
  10.      <!-- 定義classpath -->  
  11.      <path id="master-classpath">  
  12.          <fileset file="${lib.dir}/*.jar" />  
  13.          <pathelement path="${classes.dir}"/>  
  14.      </path>  
  15.      <!-- 初始化任務 -->  
  16.      <target name="init">  
  17.      </target>  
  18.      <!-- 編譯 -->  
  19.      <target name="compile" depends="init" description="compile the source files">  
  20.          <mkdir dir="${classes.dir}"/>  
  21.          <javac srcdir="${src.dir}" destdir="${classes.dir}" target="1.4">  
  22.              <classpath refid="master-classpath"/>  
  23.          </javac>  
  24.      </target>  
  25.      <!-- 測試 -->  
  26.      <target name="test" depends="compile" description="run junit test">  
  27.          <mkdir dir="${report.dir}"/>  
  28.          <junit printsummary="on"  
  29.                  haltonfailure="false"  
  30.                  failureproperty="tests.failed"  
  31.                  showoutput="true">  
  32.              <classpath refid="master-classpath" />  
  33.              <formatter type="plain"/>  
  34.              <batchtest todir="${report.dir}">  
  35.                  <fileset dir="${classes.dir}">  
  36.                      <include name="**/*Test.*"/>  
  37.                  </fileset>  
  38.              </batchtest>  
  39.          </junit>  
  40.          <fail if="tests.failed">  
  41.          ***********************************************************  
  42.          ****   One or more tests failed!   Check the output ...   ****  
  43.          ***********************************************************  
  44.          </fail>  
  45.      </target>  
  46.      <!-- 打包成jar -->  
  47.      <target name="pack" depends="test" description="make .jar file">  
  48.       <mkdir dir="${dist.dir}" />  
  49.          <jar destfile="${dist.dir}/hello.jar" basedir="${classes.dir}">  
  50.              <exclude name="**/*Test.*" />  
  51.              <exclude name="**/Test*.*" />  
  52.          </jar>  
  53.      </target>  
  54.      <!-- 輸出api文檔 -->  
  55.      <target name="doc" depends="pack" description="create api doc">  
  56.       <mkdir dir="${doc.dir}" />  
  57.       <javadoc destdir="${doc.dir}"  
  58.              author="true"  
  59.              version="true"  
  60.              use="true"  
  61.              windowtitle="Test API">  
  62.              <packageset dir="${src.dir}" defaultexcludes="yes">  
  63.                  <include name="example/**" />  
  64.              </packageset>  
  65.              <doctitle><![CDATA[<h1>Hello, test</h1>]]></doctitle>  
  66.              <bottom><![CDATA[<i>All Rights Reserved.</i>]]></bottom>  
  67.              <tag name="todo" scope="all" description="To do:" />  
  68.          </javadoc>  
  69.      </target>  
  70. </project>  

<?xml version="1.0"?>

<project name="Hello world" default="doc">

<!-- properies -->

     <property name="src.dir" value="src" />

     <property name="report.dir" value="report" />

     <property name="classes.dir" value="classes" />

     <property name="lib.dir" value="lib" />

     <property name="dist.dir" value="dist" />

<property name="doc.dir" value="doc"/>

     <!-- 定義classpath -->

     <path id="master-classpath">

         <fileset file="${lib.dir}/*.jar" />

         <pathelement path="${classes.dir}"/>

     </path>

     <!-- 初始化任務 -->

     <target name="init">

     </target>

     <!-- 編譯 -->

     <target name="compile" depends="init" description="compile the source files">

         <mkdir dir="${classes.dir}"/>

         <javac srcdir="${src.dir}" destdir="${classes.dir}" target="1.4">

             <classpath refid="master-classpath"/>

         </javac>

     </target>

     <!-- 測試 -->

     <target name="test" depends="compile" description="run junit test">

         <mkdir dir="${report.dir}"/>

         <junit printsummary="on"

                 haltonfailure="false"

                 failureproperty="tests.failed"

                 showoutput="true">

             <classpath refid="master-classpath" />

             <formatter type="plain"/>

             <batchtest todir="${report.dir}">

                 <fileset dir="${classes.dir}">

                     <include name="**/*Test.*"/>

                 </fileset>

             </batchtest>

         </junit>

         <fail if="tests.failed">

         ***********************************************************

         ****   One or more tests failed!   Check the output ...   ****

         ***********************************************************

         </fail>

     </target>

     <!-- 打包成jar -->

     <target name="pack" depends="test" description="make .jar file">

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

         <jar destfile="${dist.dir}/hello.jar" basedir="${classes.dir}">

             <exclude name="**/*Test.*" />

             <exclude name="**/Test*.*" />

         </jar>

     </target>

     <!-- 輸出api文檔 -->

     <target name="doc" depends="pack" description="create api doc">

      <mkdir dir="${doc.dir}" />

      <javadoc destdir="${doc.dir}"

             author="true"

             version="true"

             use="true"

             windowtitle="Test API">

             <packageset dir="${src.dir}" defaultexcludes="yes">

                 <include name="example/**" />

             </packageset>

             <doctitle><![CDATA[<h1>Hello, test</h1>]]></doctitle>

             <bottom><![CDATA[<i>All Rights Reserved.</i>]]></bottom>

             <tag name="todo" scope="all" description="To do:" />

         </javadoc>

     </target>

</project>


以上xml依次定義了init(初始化),compile(編譯),test(測試),doc(生成文檔),pack(打包)任務,可以作爲模板。
選中Hello工程,然後選擇“Project”,“Properties”,“Builders”,“New…”,選擇“Ant Build”:

填入Name:Ant_Builder;Buildfile:build.xml;BaseDirectory:${workspace_loc: /Hello}(按“BrowseWorkspace”選擇工程根目錄),由於用到了junit.jar包,搜索Eclipse目錄,找到 junit.jar,把它複製到Hello/lib目錄下,並添加到Ant的Classpath中:

然後在Builder面板中鉤上Ant_Build,去掉Java Builder:

再次編譯,即可在控制檯看到Ant的輸出:
Buildfile: F:\eclipse-projects\Hello\build.xml
init:
compile:
        [mkdir] Created dir: F:\eclipse-projects\Hello\classes
        [javac] Compiling 2 source files to F:\eclipse-projects\Hello\classes
test:
        [mkdir] Created dir: F:\eclipse-projects\Hello\report
        [junit] Running example.HelloTest
        [junit] Tests run: 1, Failures: 0, Errors: 0, Time elapsed: 0.02 sec
pack:
        [mkdir] Created dir: F:\eclipse-projects\Hello\dist
          [jar] Building jar: F:\eclipse-projects\Hello\dist\hello.jar
doc:
        [mkdir] Created dir: F:\eclipse-projects\Hello\doc
      [javadoc] Generating Javadoc
      [javadoc] Javadoc execution
      [javadoc] Loading source files for package example...
      [javadoc] Constructing Javadoc information...
      [javadoc] Standard Doclet version 1.4.2_04
      [javadoc] Building tree for all the packages and classes...
      [javadoc] Building index for all the packages and classes...
      [javadoc] Building index for all classes...
      [javadoc] Generating F:\eclipse-projects\Hello\doc\stylesheet.css...
      [javadoc] Note: Custom tags that could override future standardtags:   @todo. To avoid potential overrides, use at least one periodcharacter (.) in custom tag names.
      [javadoc] Note: Custom tags that were not seen:   @todo
BUILD SUCCESSFUL
Total time: 11 seconds
Ant依次執行初始化,編譯,測試,打包,生成API文檔一系列任務,極大地提高了開發效率。將來開發J2EE項目時,還可加入部署等任務。並且,即使脫離了Eclipse環境,只要正確安裝了Ant,配置好環境變量ANT_HOME=<Ant解壓目錄&gt;, Path=…;%ANT_HOME%\bin,在命令行提示符下切換到Hello目錄,簡單地鍵入ant即可。

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