??xml version="1.0" encoding="utf-8" standalone="yes"?>
Apache Ant 是一个基?Java的生成工兗?br />单点说就?java中的MAKEFILE,它根据build.xml的内容自动编译java
2 下蝲、安装Ant
安装Ant
下蝲.zip文gQ解压羃到c:\ant1.3(后面引用?ANT_HOME%)
2.1 在你q行Ant之前需要做一些配|工作?br />? bin目录加入PATH环境变量?
? 讑֮ANT_HOME环境变量Q指向你安装Ant的目录。在一些OS上,Ant的脚本可以猜ANT_HOMEQUnix和Windos NT/2000Q-但最好不要依赖这一Ҏ?
? 可选地Q设定JAVA_HOME环境变量Q参考下面的高节Q,该变量应该指向你安装JDK的目录?br />注意Q不要将Ant的ant.jar文g攑ֈJDK/JRE的lib/ext目录下。Ant是个应用E序Q而lib/ext目录是ؓJDK扩展使用的(如JCEQJSSE扩展Q。而且通过扩展装入的类会有安全斚w的限制?br />2.2 q行Ant
q行Ant非常单,当你正确地安装Ant后,只要输入ant可以了?/p>
一般以:ant 打头 加一个build.xml中target 中的name属性的?..下一我讲介lbuild.xml各个d的作?/p>
? 没有指定M参数ӞAnt会在当前目录下查询build.xml文g。如果找Cq该文件作为buildfile。如果你?-find 选项。Ant׃在上U目录中LbuildfileQ直臛_达文件系l的栏V要惌Ant使用其他的buildfileQ可以用参数 -buildfile fileQ这里file指定了你想用的buildfile?/p>
? 可以指定执行一个或多个target。当省略targetӞAnt使用标签<project>的default属性所指定的target?/p>
命o行选项ȝQ?br />ant [options] [target [target2 [target3] ...]]
Options:
-help print this message
-projecthelp print project help information
-version print the version information and exit
-quiet be extra quiet
-verbose be extra verbose
-debug print debugging information
-emacs produce logging information without adornments
-logfile file use given file for log output
-logger classname the class that is to perform logging
-listener classname add an instance of class as a project listener
-buildfile file use specified buildfile
-find file search for buildfile towards the root of the filesystem and use the first one found
-Dproperty=value set property to value
例子
ant
使用当前目录下的build.xmlq行AntQ执行缺省的target?br />ant -buildfile test.xml
使用当前目录下的test.xmlq行AntQ执行缺省的target?br />ant -buildfile test.xml dist
使用当前目录下的test.xmlq行AntQ执行一个叫做dist的target?br />ant -buildfile test.xml -Dbuild=build/classes dist
使用当前目录下的test.xmlq行AntQ执行一个叫做dist的targetQƈ讑֮build属性的gؓbuild/classes?/p>
3 ~写build.xml
Ant的buildfile是用XML写的。每个buildfile含有一个project?/p>
buildfile中每个task元素可以有一个id属性,可以用这个id值引用指定的d。这个值必L唯一的。(详情请参考下面的Task节Q?/p>
3.1 Projects
project有下面的属性:
Attribute Description Required
name 目名称. No
default 当没有指定target时用的~省target Yes
basedir 用于计算所有其他\径的\径。该属性可以被basedir property覆盖。当覆盖Ӟ该属性被忽略。如果属性和basedir property都没有设定,׃用buildfile文g的父目录?No
目的描qC一个顶U的<description>元素的Ş式出玎ͼ参看description节Q?/p>
一个项目可以定义一个或多个target。一个target是一pd你想要执行的。执行AntӞ你可以选择执行那个target。当没有l定targetӞ使用project的default属性所定的target?/p>
3.2 Targets
一个target可以依赖于其他的target。例如,你可能会有一个target用于~译E序Q一个target用于生成可执行文件。你在生成可执行文g之前必须先编译通过Q所以生成可执行文g的target依赖于编译target。Ant会处理这U依赖关pR?/p>
然而,应当注意刎ͼAnt的depends属性只指定了target应该被执行的序Q如果被依赖的target无法q行Q这Udepends对于指定了依赖关pȝtarget没有媄响?/p>
Ant会依照depends属性中target出现的顺序(从左到右Q依ơ执行每个target。然而,要记住的是只要某个target依赖于一个targetQ后者就会被先执行?br /><target name="A"/>
<target name="B" depends="A"/>
<target name="C" depends="B"/>
<target name="D" depends="C,B,A"/>
假定我们要执行target D。从它的依赖属性来看,你可能认为先执行CQ然后BQ最后A被执行。错了,C依赖于BQB依赖于AQ所以先执行AQ然后BQ然后CQ最后D被执行?/p>
一个target只能被执行一ơ,x有多个target依赖于它Q看上面的例子)?/p>
如果Q或如果不)某些属性被讑֮Q才执行某个target。这P允许Ҏpȝ的状态(java version, OS, 命o行属性定义等{)来更好地控制build的过E。要惌一个targetq样做,你就应该在target元素中,加入ifQ或unlessQ属性,带上target因该有所判断的属性。例如:
<target name="build-module-A" if="module-A-present"/>
<target name="build-own-fake-module-A" unless="module-A-present"/>
如果没有if或unless属性,targetM被执行?/p>
可选的description属性可用来提供关于target的一行描qͼq些描述可由-projecthelp命o行选项输出?/p>
你的tstamp task在一个所谓的初始化target是很好的做法Q其他的target依赖q个初始化target。要保初始化target是出现在其他target依赖表中的第一个target。在本手册中大多数的初始化target的名字是"init"?/p>
target有下面的属性:
Attribute Description Required
name target的名?Yes
depends 用逗号分隔的target的名字列表,也就是依赖表?No
if 执行target所需要设定的属性名?No
unless 执行target需要清除设定的属性名?No
description 关于target功能的简短描q?No
3.3 Tasks
一个task是一D可执行的代码?/p>
一个task可以有多个属性(如果你愿意的话,可以其UC为变量)。属性只可能包含对property的引用。这些引用会在task执行前被解析?/p>
下面是Task的一般构造Ş式:
<name attribute1="value1" attribute2="value2" ... />
q里name是task的名字,attributeN是属性名QvalueN是属性倹{?/p>
有一套内|的Qbuilt-inQtaskQ以及一些可选taskQ但你也可以~写自己的task?/p>
所有的task都有一个task名字属性。Ant用属性值来产生日志信息?/p>
可以ltask赋一个id属性:
<taskname id="taskID" ... />
q里taskname是task的名字,而taskID是这个task的唯一标识W。通过q个标识W,你可以在脚本中引用相应的task。例如,在脚本中你可以这P
<script ... >
task1.setFoo("bar");
</script>
讑֮某个task实例的foo属性。在另一个task中(用java~写Q,你可以利用下面的语句存取相应的实例?br />project.getReference("task1").
注意1Q如果task1q没有运行,׃会被生效Q例如:不设定属性)Q如果你在随后配|它Q你所作的一切都会被覆盖?/p>
注意2Q未来的Ant版本可能不会兼容q里所提的属性,因ؓ很有可能Ҏ没有task实例Q只有proxies?/p>
3.4 Properties
一个project可以有很多的properties。可以在buildfile中用property task来设定,或在Ant之外讑֮。一个property有一个名字和一个倹{property可用于task的属性倹{这是通过属性名攑֜"${"?}"之间q放在属性值的位置来实现的。例如如果有一个property builddir的值是"build"Q这个property可用于属性|${builddir}/classes。这个值就可被解析为build/classes?/p>
内置属?/p>
如果你用了<property> task 定义了所有的pȝ属性,Ant允许你用这些属性。例如,${os.name}对应操作pȝ的名字?/p>
要想得到pȝ属性的列表可参考the Javadoc of System.getProperties?/p>
除了Java的系l属性,Antq定义了一些自q内置属性:
basedir project基目录的l对路径 (?lt;project>的basedir属性一??br />ant.file buildfile的绝对\径?br />ant.version Ant的版本?br />ant.project.name 当前执行的project的名字;?lt;project>的name属性设?
ant.java.version Ant到的JVM的版本; 目前的值有"1.1", "1.2", "1.3" and "1.4".
例子
<project name="MyProject" default="dist" basedir=".">
<!-- set global properties for this build -->
<property name="src" value="."/>
<property name="build" value="build"/>
<property name="dist" value="dist"/>
<target name="init">
<!-- Create the time stamp -->
<tstamp/>
<!-- Create the build directory structure used by compile -->
<mkdir dir="${build}"/>
</target>
<target name="compile" depends="init">
<!-- Compile the java code from ${src} into ${build} -->
<javac srcdir="${src}" destdir="${build}"/>
</target>
<target name="dist" depends="compile">
<!-- Create the distribution directory -->
<mkdir dir="${dist}/lib"/>
<!-- Put everything in ${build} into the MyProject-${DSTAMP}.jar file -->
<jar jarfile="${dist}/lib/MyProject-${DSTAMP}.jar" basedir="${build}"/>
</target>
<target name="clean">
<!-- Delete the ${build} and ${dist} directory trees -->
<delete dir="${build}"/>
<delete dir="${dist}"/>
</target>
</project>
3.5 Path-like Structures
你可以用":"?;"作ؓ分隔W,指定cMPATH和CLASSPATH的引用。Ant会把分隔W{换ؓ当前pȝ所用的分隔W?/p>
当需要指定类D\径的值时Q可以用嵌套元素。一般的形式?br /><classpath>
<pathelement path="${classpath}"/>
<pathelement location="lib/helper.jar"/>
</classpath>
location属性指定了相对于project基目录的一个文件和目录Q而path属性接受逗号或分号分隔的一个位|列表。path属性一般用作预定义的\径-Q其他情况下Q应该用多个location属性?/p>
为简zv见,classpath标签支持自己的path和location属性。所以:
<classpath>
<pathelement path="${classpath}"/>
</classpath>
可以被简写作Q?br /><classpath path="${classpath}"/>
也可通过<fileset>元素指定路径。构成一个fileset的多个文件加入path-like structure的顺序是未定的?br /><classpath>
<pathelement path="${classpath}"/>
<fileset dir="lib">
<include name="**/*.jar"/>
</fileset>
<pathelement location="classes"/>
</classpath>
上面的例子构造了一个\径值包括:${classpath}的\径,跟着lib目录下的所有jar文gQ接着是classes目录?/p>
如果你想在多个task中用相同的path-like structureQ你可以?lt;path>元素定义他们Q与target同Q,然后通过id属性引用-Q参考Referencs例子?/p>
path-like structure可能包括对另一个path-like structurede的引用(通过嵌套<path>元素Q:
<path id="base.path">
<pathelement path="${classpath}"/>
<fileset dir="lib">
<include name="**/*.jar"/>
</fileset>
<pathelement location="classes"/>
</path>
<path id="tests.path">
<path refid="base.path"/>
<pathelement location="testclasses"/>
</path>
前面所提的关于<classpath>的简z写法对?lt;path>也是有效的,如:
<path id="tests.path">
<path refid="base.path"/>
<pathelement location="testclasses"/>
</path>
可写成:
<path id="base.path" path="${classpath}"/>
命o行变?/p>
有些task可接受参敎ͼq将其传递给另一个进E。ؓ了能在变量中包含I格字符Q可使用嵌套的arg元素?br />Attribute Description Required
value 一个命令行变量Q可包含I格字符?只能用一?br />line I格分隔的命令行变量列表?
file 作ؓ命o行变量的文g名;会被文g的绝对名替代?
path 一个作为单个命令行变量的path-like的字W串Q或作ؓ分隔W,Ant会将其{变ؓ特定q_的分隔符?
例子
<arg value="-l -a"/>
是一个含有空格的单个的命令行变量?br /><arg line="-l -a"/>
是两个空格分隔的命o行变量?br /><arg path="/dir;/dir2:\dir3"/>
是一个命令行变量Q其值在DOSpȝ上ؓ\dir;\dir2;\dir3Q在Unixpȝ上ؓ/dir:/dir2:/dir3 ?/p>
References
buildfile元素的id属性可用来引用q些元素。如果你需要一遍遍的复制相同的XML代码块,q一属性就很有用-Q如多次使用<classpath>l构?/p>
下面的例子:
<project ... >
<target ... >
<rmic ...>
<classpath>
<pathelement location="lib/"/>
<pathelement path="${java.class.path}/"/>
<pathelement path="${additional.path}"/>
</classpath>
</rmic>
</target>
<target ... >
<javac ...>
<classpath>
<pathelement location="lib/"/>
<pathelement path="${java.class.path}/"/>
<pathelement path="${additional.path}"/>
</classpath>
</javac>
</target>
</project>
可以写成如下形式Q?br /><project ... >
<path id="project.class.path">
<pathelement location="lib/"/>
<pathelement path="${java.class.path}/"/>
<pathelement path="${additional.path}"/>
</path>
<target ... >
<rmic ...>
<classpath refid="project.class.path"/>
</rmic>
</target>
<target ... >
<javac ...>
<classpath refid="project.class.path"/>
</javac>
</target>
</project>
所有用PatternSets, FileSets ?path-like structures嵌套元素的task也接受这U类型的引用?/p>
4.1 FileQDirectoryQ类
4.1.1 Mkdir
? 创徏一个目录,如果他的父目录不存在Q也会被同时创徏?br />? 例子Q?br /><mkdir dir="build/classes"/>
? 说明Q?如果build不存在,也会被同时创?br />4.1.2 Copy
? 拯一个(l)文g、目?br />? 例子Q?br />1. 拯单个的文Ӟ
<copy file="myfile.txt" tofile="mycopy.txt"/>
2. 拯单个的文件到指定目录?br /><copy file="myfile.txt" todir="../some/other/dir"/>
3. 拯一个目录到另外一个目录下
<copy todir="../new/dir">
<fileset dir="src_dir"/>
</copy>
4. 拯一Ҏ件到指定目录?br /><copy todir="../dest/dir">
<fileset dir="src_dir">
<exclude name="**/*.java"/>
</fileset>
</copy>
<copy todir="../dest/dir">
<fileset dir="src_dir" excludes="**/*.java"/>
</copy>
5. 拯一Ҏ件到指定目录下,文件名后增加。Bak后缀
<copy todir="../backup/dir">
<fileset dir="src_dir"/>
<mapper type="glob" from="*" to="*.bak"/>
</copy>
6. 拯一l文件到指定目录下,替换其中的@标签@内容
<copy todir="../backup/dir">
<fileset dir="src_dir"/>
<filterset>
<filter token="TITLE" value="Foo Bar"/>
</filterset>
</copy>
4.1.3 Delete
? 删除一个(l)文g或者目?br />? 例子
1. 删除一个文?br /><delete file="/lib/ant.jar"/>
2. 删除指定目录及其子目?br /><delete dir="lib"/>
3. 删除指定的一l文?br /><delete>
<fileset dir="." includes="**/*.bak"/>
</delete>
4. 删除指定目录及其子目录,包括他自?br /><delete includeEmptyDirs="true">
<fileset dir="build"/>
</delete>
4.1.4 Move
? Ud或重命名一个(l)文g、目?br />? 例子Q?br />1. Ud或重命名一个文?br /><move file="file.orig" tofile="file.moved"/>
2. Ud或重命名一个文件到另一个文件夹下面
<move file="file.orig" todir="dir/to/move/to"/>
3. 一个目录移到另外一个目录下
<move todir="new/dir/to/move/to">
<fileset dir="src/dir"/>
</move>
4. 一l文件移动到另外的目录下
<move todir="some/new/dir">
<fileset dir="my/src/dir">
<include name="**/*.jar"/>
<exclude name="**/ant.jar"/>
</fileset>
</move>
5. Ud文gq程中增加。Bak后缀
<move todir="my/src/dir">
<fileset dir="my/src/dir">
<exclude name="**/*.bak"/>
</fileset>
<mapper type="glob" from="*" to="*.bak"/>
</move>
4.2 Java相关
4.2.1 Javac
? ~译java原代?br />? 例子
1. <javac srcdir="${src}"
destdir="${build}"
classpath="xyz.jar"
debug="on"
/>
~译${src}目录及其子目录下的所有。Java文gQ。Class文g放?{build}指定的目录下,classpath表示需要用到的cL件或者目录,debug讄为on表示输出debug信息
2. <javac srcdir="${src}:${src2}"
destdir="${build}"
includes="mypackage/p1/**,mypackage/p2/**"
excludes="mypackage/p1/testpackage/**"
classpath="xyz.jar"
debug="on"
/>
~译${src}?{src2}目录及其子目录下的所有。Java文gQ但是package/p1/**,mypackage/p2/**被~译Q而mypackage/p1/testpackage/**不会被~译。Class文g放?{build}指定的目录下,classpath表示需要用到的cL件或者目录,debug讄为on表示输出debug信息
3. <property name="classpath" value=".;./xml-apis.jar;../lib/xbean.jar;./easypo.jar"/>
<javac srcdir="${src}"
destdir="${src}"
classpath="${classpath}"
debug="on"
/>
路径是在property中定义的
4.2.2 java
? 执行指定的javac?/p>
? 例子Q?br />1. <java classname="test.Main">
<classpath>
<pathelement location="dist/test.jar"/>
<pathelement path="${java.class.path}"/>
</classpath>
</java>
classname中指定要执行的类Qclasspath讑֮要用的环境变量
2. <path id="project.class.path">
<pathelement location="lib/"/>
<pathelement path="${java.class.path}/"/>
<pathelement path="${additional.path}"/>
</path>
<target ... >
<rmic ...>
<classpath refid="project.class.path"/>
</rmic>
</target>
4.3 打包相关
4.3.1 jar
? 一l文件打?br />? 例子Q?br />1. <jar destfile="${dist}/lib/app.jar" basedir="${build}/classes"/>
?{build}/classes下面的所有文件打包到${dist}/lib/app.jar?br />2. <jar destfile="${dist}/lib/app.jar"
basedir="${build}/classes"
includes="mypackage/test/**"
excludes="**/Test.class"
/>
?{build}/classes下面的所有文件打包到${dist}/lib/app.jar中,但是包括mypackage/testQ所有文件不包括所有的Test.class
3. <jar destfile="${dist}/lib/app.jar"
basedir="${build}/classes"
includes="mypackage/test/**"
excludes="**/Test.class"
manifest=”my.mf?br />/>
manifest属性指定自qMETA-INF/MANIFEST.MF文gQ而不是由pȝ生成
4.3.2 war
? 对Jar的扩展,用于打包Web应用
? 例子Q?br />? 假设我们的文件目录如下:
thirdparty/libs/jdbc1.jar
thirdparty/libs/jdbc2.jar
build/main/com/myco/myapp/Servlet.class
src/metadata/myapp.xml
src/html/myapp/index.html
src/jsp/myapp/front.jsp
src/graphics/images/gifs/small/logo.gif
src/graphics/images/gifs/large/logo.gif
? 下面是我们的d的内容:
<war destfile="myapp.war" webxml="src/metadata/myapp.xml">
<fileset dir="src/html/myapp"/>
<fileset dir="src/jsp/myapp"/>
<lib dir="thirdparty/libs">
<exclude name="jdbc1.jar"/>
</lib>
<classes dir="build/main"/>
<zipfileset dir="src/graphics/images/gifs"
prefix="images"/>
</war>
? 完成后的l果Q?br />WEB-INF/web.xml
WEB-INF/lib/jdbc2.jar
WEB-INF/classes/com/myco/myapp/Servlet.class
META-INF/MANIFEST.MF
index.html
front.jsp
images/small/logo.gif
images/large/logo.gif
4.3.3 ear
? 用于打包企业应用
? 例子
<ear destfile="${build.dir}/myapp.ear" appxml="${src.dir}/metadata/application.xml">
<fileset dir="${build.dir}" includes="*.jar,*.war"/>
</ear>
4.4 旉?br />在生成环境中使用当前旉和日期,以某U方式标记某个生成Q务的输出Q以便记录它是何时生成的Q这l常是可取的。这可能涉及~辑一个文Ӟ以便插入一个字W串来指定日期和旉Q或这个信息合q到 JAR ?zip 文g的文件名中?br />q种需要是通过单但是非常有用的 tstamp d来解决的。这个Q务通常在某ơ生成过E开始时调用Q比如在一?init 目标中。这个Q务不需要属性,许多情况下只需 <tstamp/> p够了?br />tstamp 不生Q何输出;相反Q它Ҏ当前pȝ旉和日期设|?Ant 属性。下面是 tstamp 讄的一些属性、对每个属性的说明Q以及这些属性可被设|到的值的例子Q?br />属?说明 例子
DSTAMP 讄为当前日期,默认格式为yyyymmdd 20031217
TSTAMP 讄为当前时_默认格式?hhmm 1603
TODAY 讄为当前日期,带完整的月䆾 2003 q?12 ?17 ?br />例如Q在前一节中,我们按如下方式创Z一?JAR 文gQ?/p>
<jar destfile="package.jar" basedir="classes"/>
在调?tstamp d之后Q我们能够根据日期命名该 JAR 文gQ如下所C:
<jar destfile="package-${DSTAMP}.jar" basedir="classes"/>
因此Q如果这个Q务在 2003 q?12 ?17 日调用,?JAR 文g被命名?package-20031217.jar?br />q可以配|?tstamp d来设|不同的属性,应用一个当前时间之前或之后的时间偏U,或以不同的方式格式化该字W串。所有这些都是用一个嵌套的 format 元素来完成的Q如下所C:
<tstamp>
<format property="OFFSET_TIME"
pattern="HH:mm:ss"
offset="10" unit="minute"/>
</tstamp>
上面的清单将 OFFSET_TIME 属性设|ؓ距离当前旉 10 分钟之后的小时数、分钟数和秒数?br />用于定义格式字符串的字符?java.text.SimpleDateFormat cL定义的那些格式字W相?/p>
4.5 执行SQL语句
? 通过jdbc执行SQL语句
? 例子Q?br />1. <sql
driver="org.gjt.mm.mysql.Driver"
url="jdbc:mysql://localhost:3306/mydb"
userid="root"
password="root"
src="data.sql"
/>
2. <sql
driver="org.database.jdbcDriver"
url="jdbc:database-url"
userid="sa"
password="pass"
src="data.sql"
rdbms="oracle"
version="8.1."
>
</sql>
只有在oracle、版本是8.1的时候才执行
4.6 发送邮?br />? 使用SMTP服务器发送邮?br />? 例子Q?br /><mail mailhost="smtp.myisp.com" mailport="1025" subject="Test build">
<from address="me@myisp.com"/>
<to address="all@xyz.com"/>
<message>The ${buildname} nightly build has completed</message>
<fileset dir="dist">
<includes name="**/*.zip"/>
</fileset>
</mail>
? mailhostQ?SMTP服务器地址
? mailportQ?服务器端?br />? subjectQ?主题
? fromQ?发送h地址
? toQ?接受人地址
? messageQ?发送的消息
? filesetQ?讄附g