內容摘要:
ant是一個基于JAVA的自動化腳本引擎,腳本格式為XML。除了做JAVA編譯相關任務外,ANT還可以通過插件實現很多應用的調用。
- ANT的基本概念:
- ANT的安裝:解包,設置路徑
- ANT的使用:最好的學習只不過是一個簡單實用的例子起步……
ANT的基本概念:Java的Makefile
當一個代碼項目大了以后,每次重新編譯,打包,測試等都會變得非常復雜而且重復,因此c語言中有make腳本來幫助這些工作的批量完成。在Java
中應用是平臺無關性的,當然不會用平臺相關的make腳本來完成這些批處理任務了,ANT本身就是這樣一個流程腳本引擎,用于自動化調用程序完成項目的編譯,打包,測試等。除了基于JAVA是平臺無關的外,腳本的格式是基于XML的,比make腳本來說還要好維護一些。
每個ant腳本(缺省叫build.xml)中設置了一系列任務(target):比如對于一個一般的項目可能需要有以下任務。
- 任務1:usage 打印本腳本的幫助信息(缺省)
- 任務2:clean <-- init 清空初始化環境
- 任務3:javadoc <-- build <-- init 生成JAVADOC
- 任務4:jar <-- build <-- init 生成JAR
- 任務5:all <-- jar + javadoc <-- build <-- init 完成以上所有任務:jar javadoc
而多個任務之間往往又包含了一定了依賴關系:比如把整個應用打包任務(jar)的這個依賴于編譯任務(build),而編譯任務又依賴于整個環境初始化任務(init)等。
注:我看到很多項目的ant腳本中的命名基本上都是一致的,比如:編譯一般叫build或者compile;打包一般叫jar或war;生成文檔一般命名為javadoc或javadocs;執行全部任務all。在每個任務的中,ANT會根據配置調用一些外部應用并配以相應參數執行。雖然ANT可調用的外部應用種類非常豐富,但其實最常用的就2,3個:比如javac
javadoc jar等。
ANT的安裝
解包后在系統可執行路徑中加入指向ant的bin的路徑就可以了,比如可以在GNU/Linux上把以下配置加入/etc/profile中:
export
ANT_HOME=/home/ant
export JAVA_HOME=/usr/java/j2sdk1.4.1
export
PATH=$PATH:$JAVA_HOME/bin:$ANT_HOME/bin
這樣執行ant
后,如果不指定配置文件ant會缺省找build.xml這個配置文件,并根據配置文件執行任務,缺省的任務設置可以指向最常用的任務,比如:
build,或指向打印幫助信息:usage,告訴用戶有那些腳本選項可以使用。
ANT的使用
最好的學習過程就是看懂那些open
source項目中的build.xml腳本,然后根據自己的需要簡化成一個更簡單的,ANT和APACHE上很多非常工程派的項目:簡單易用,而且適應性非常強,因為這些項目的建立往往來源于開發人員日常最直接的需求。
以下是的一個
WebLucene應用的例子:修改自
JDOM的build.xml:
1 <project default="usage" basedir=".">
2
3 <!-- =================================================================== -->
4 <!-- Initialization target -->
5 <!-- =================================================================== -->
6 <target name="init">
7 <tstamp/>
8 <property file="${basedir}/build.properties" />
9 <property name="Name" value="ProjectFullName"/>
10 <property name="name" value="project_name"/>
11 <property name="version" value="0.2"/>
12 <property name="year" value="2003"/>
13
14 <echo message="----------- ${Name} ${version} [${year}] ------------"/>
15
16 <property name="debug" value="off"/>
17 <property name="optimize" value="on"/>
18 <property name="deprecation" value="on"/>
19
20 <property name="src.dir" value="./src/WEB-INF/src"/>
21 <property name="lib.dir" value="./src/WEB-INF/lib"/>
22 <property name="packages" value="com.chedong.*,org.apache.lucene.*"/>
23
24 <property name="build.src" value="./src/WEB-INF/build"/>
25 <property name="build.dest" value="./src/WEB-INF/classes"/>
26 <property name="build.javadocs" value="./src/doc"/>
27
28 <path id="classpath">
29 <pathelement path="${jsdk_jar}"/>
30 <fileset dir="${lib.dir}">
31 <include name="**/*.jar"/>
32 </fileset>
33 </path>
34
35 <filter token="year" value="${year}"/>
36 <filter token="version" value="${version}"/>
37 <filter token="date" value="${TODAY}"/>
38 <filter token="log" value="true"/>
39 <filter token="verbose" value="true"/>
40 </target>
41
42 <!-- =================================================================== -->
43 <!-- Help on usage -->
44 <!-- =================================================================== -->
45 <target name="usage" depends="init">
46 <echo message="${Name} Build file"/>
47 <echo message="-------------------------------------------------------------"/>
48 <echo message=""/>
49 <echo message=" available targets are:"/>
50 <echo message=""/>
51 <echo message=" jar --> generates the ${name}.jar file"/>
52 <echo message=" build --> compiles the source code"/>
53 <echo message=" javadoc --> generates the API documentation"/>
54 <echo message=" clean --> cleans up the directory"/>
55 <echo message=""/>
56 <echo message=" Please rename build.properties.default to build.properties"/>
57 <echo message=" and edit build.properties to specify JSDK 2.3 classpath."/>
58 <echo message=""/>
59 <echo message=" See the comments inside the build.xml file for more details."/>
60 <echo message="-------------------------------------------------------------"/>
61 <echo message=""/>
62 <echo message=""/>
63 </target>
64
65 <!-- =================================================================== -->
66 <!-- Prepares the source code -->
67 <!-- =================================================================== -->
68 <target name="prepare-src" depends="init">
69 <!-- create directories -->
70 <mkdir dir="${build.src}"/>
71 <mkdir dir="${build.dest}"/>
72
73 <!-- copy src files -->
74 <copy todir="${build.src}">
75 <fileset dir="${src.dir}"/>
76 </copy>
77 </target>
78
79 <!-- =================================================================== -->
80 <!-- Compiles the source directory -->
81 <!-- =================================================================== -->
82 <target name="build" depends="prepare-src">
83 <javac srcdir="${build.src}"
84 destdir="${build.dest}"
85 debug="${debug}"
86 optimize="${optimize}">
87 <classpath refid="classpath"/>
88 </javac>
89 </target>
90
91 <!-- =================================================================== -->
92 <!-- Creates the class package -->
93 <!-- =================================================================== -->
94 <target name="jar" depends="build">
95 <jar jarfile="${lib.dir}/${name}.jar"
96 basedir="${build.dest}"
97 includes="**"/>
98 </target>
99
100 <!-- =================================================================== -->
101 <!-- Creates the API documentation -->
102 <!-- =================================================================== -->
103 <target name="javadoc" depends="build">
104 <mkdir dir="${build.javadocs}"/>
105 <javadoc packagenames="${packages}"
106 sourcepath="${build.src}"
107 destdir="${build.javadocs}"
108 author="true"
109 version="true"
110 use="true"
111 splitindex="true"
112 windowtitle="${Name} API"
113 doctitle="${Name}">
114 <classpath refid="classpath"/>
115 </javadoc>
116 </target>
117
118 <!-- =================================================================== -->
119 <!-- Clean targets -->
120 <!-- =================================================================== -->
121 <target name="clean" depends="init">
122 <delete dir="${build.src}"/>
123 <delete dir="${build.dest}/org"/>
124 <delete dir="${build.dest}/com"/>
125 <delete>
126 <fileset dir="${build.dest}" includes="**/*.class"/>
127 </delete>
128 </target>
129 </project>
130 <!-- End of file -->
缺省任務:usage 打印幫助文檔,告訴有那些任務選項:可用的有build, jar,
javadoc和clean.
初始化環境變量:init
所有任務都基于一些基本環境變量的設置初始化完成,是后續其他任務的基礎,在環境初始化過程中,有2點比較可以方便設置:
1
除了使用卻缺省的property設置了JAVA源路徑和輸出路徑外,引用了一個外部的build.properties文件中的設置,
1 <property file="${basedir}/build.properties" />
這樣大部分簡單配置用戶只要會看懂build.properties就可以了,畢竟XML比起key
value的屬性文件還是要可讀性差一些。用build.properties也可以方便其他用戶從編譯的細節中解放出來。
2
CLASSPATH設置:使用了其中的:
<path id="classpath">
<pathelement path="${jsdk_jar}"/>
<fileset dir="${lib.dir}">
<include name="**/*.jar"/>
</fileset>
</path>
則相當于設置了:CLASSPATH=/path/to/resin/lib/jsdk23.jar;
/path/to/project/lib/*.jar;
文件復制:prepare-src
創建臨時SRC存放目錄和輸出目錄。
1 <!-- =================================================================== -->
2 <!-- Prepares the source code -->
3 <!-- =================================================================== -->
4 <target name="prepare-src" depends="init">
5 <!-- create directories -->
6 <mkdir dir="${build.src}"/>
7 <mkdir dir="${build.dest}"/>
8
9 <!-- copy src files -->
10 <copy todir="${build.src}">
11 <fileset dir="${src.dir}"/>
12 </copy>
13 </target>
編譯任務:build
編譯時的CLASSPATH環境通過一下方式找到引用一個path對象
1 <classpath refid="classpath"/>
打包任務:jar
對應用打包生成項目所寫名的.jar文件
1 <!-- =================================================================== -->
2 <!-- Creates the class package -->
3 <!-- =================================================================== -->
4 <target name="jar" depends="build">
5 <jar jarfile="${lib.dir}/${name}.jar"
6 basedir="${build.dest}"
7 includes="**"/>
8 </target>
生成JAVADOC文檔任務: javadoc
1 <!-- =================================================================== -->
2 <!-- Creates the API documentation -->
3 <!-- =================================================================== -->
4 <target name="javadoc" depends="build">
5 <mkdir dir="${build.javadocs}"/>
6 <javadoc packagenames="${packages}"
7 sourcepath="${build.src}"
8 destdir="${build.javadocs}"
9 author="true"
10 version="true"
11 use="true"
12 splitindex="true"
13 windowtitle="${Name} API"
14 doctitle="${Name}">
15 <classpath refid="classpath"/>
16 </javadoc>
17 </target>
清空臨時編譯文件:clean
1 <!-- =================================================================== -->
2 <!-- Clean targets -->
3 <!-- =================================================================== -->
4 <target name="clean" depends="init">
5 <delete dir="${build.src}"/>
6 <delete dir="${build.dest}/org"/>
7 <delete dir="${build.dest}/com"/>
8 <delete>
9 <fileset dir="${build.dest}" includes="**/*.class"/>
10 </delete>
11 </target>
12
TODO:
更多任務/擴展:(樣例)
- 測試任務:JUnit測試
- 代碼風格檢查任務:CheckStyle,Jalopy等
- 郵件警報任務:可以把以上這些任務的輸出警告發送到制定的用戶列表中,這個任務可以設置每天自動運行。