加载中…
标签：
antit |
分类： Java-Developing |
一、Ant简介
Ant是一种基于Java的build工具，有些类似于unix系统中的make命令，Ant是Apache软件基金会Jakarta目录中的一个子项目，具有
跨平台性，操作简单等特点。
这里就不说这些老套的话了，大家知道就是一种build工具就可以了，具体有什么用和怎么用，我们稍后说明。
二、Ant的主要标签及数据类型
Ant构建文件是一个xml文件，一般默认命名为build.xml，如果是web project，通常把构建文件放在顶层目录下，即和src文件夹并
列。
一个Ant构建文件需要定义一个唯一的项目元素(project元素)，还可以定义多个目标元素(target元素)，各个目标元素之间可以有
一定的依赖关系，如：
<target
name="compile"><target name="deploy"
depends="compile">
如上，deploy依赖于compile，即系统必须先compile完了，然后才能deploy。
下面简要介绍一下Ant的主要标签：
1、<project>标签
每个构建文件对应一个项目。<project>标签是构建文件的根标签。它可以有多个内在属性，其各个属性的含义分别如下：
(1)default表示默认的运行目标，这个属性是必须的。
(2)basedir表示项目的基准目录。
(3)name表示项目名。
(4)description表示项目的描述。
2、<target>标签
Target的常用属性如下：
(1).name表示目标名称，这个属性是必须的。
(2).depends表示依赖的目标。
(3)if表示仅当属性设置时才执行。
(4)unless表示当属性没有设置时才执行。
(5)description表示项目的描述。
Ant的depends属性指定了target的执行顺序。Ant会依照depends属性中target出现顺序依次执行每个target。在执行之前，首先需
要执行它所依赖的target。
3、<mkdir>标签
该标签用于创建一个目录，它有一个属性dir用来指定所创建的目录名。
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 表示指定当碰到错误是否停止，默认值是自动停止。
8、<copy>标签
该标签用于文件或文件集的拷贝，其属性如下：
(1).file 表示源文件。
(2).tofile 表示目标文件。
(3).todir 表示目标目录。
(4).overwrite 表示指定是否覆盖目标文件，默认值是不覆盖。
(5).includeEmptyDirs 表示制定是否拷贝空目录，默认值为拷贝。
(6).failonerror 表示指定如目标没有发现是否自动停止，默认值是停止。
如果我们部署一个web应用的话，经常用到的标签有：delete，mkdir，copy，jar，target和project。
最近用到了Ant，发现还是有许多功能是Ant没有提供相应Task支持，而操作系统提供了相应的系统命令。Ant说明书上说了，用
<exec>可以调用系统命令，实际操作起来才发现陷阱可不少，一不小心就会掉下去。下面以按日期倒序列举当前目录下文件为例说
明。注意我使用的是Ant 1.5.4。
对于Windows平台，命令是：dir /o:-d
对于Unix（包括Linux，下同）平台，命令是 ls –ltr
陷阱1：调用谁？
这在Ant文档中已经提到了，在Windows下，不能直接调用dir、del（因为没有这个程序！）等，必须通过cmd.exe来调用：
<?xml version="1.0" ?>
<project name="testExec" default="test">
</project>
对于Unix，则可以直接调用ls：
<?xml version="1.0" ?>
<project name="testExec" default="test">
</project>
也可以指明由Shell调用
<?xml version="1.0" ?>
<project name="testExec" default="test">
</project>
我觉得后者要好一些，否则无法保证调用的是否系统命令，因为只要Path环境变量指明的路径下有一个同名的程序，都可能被调用
到。
通过Shell调用，Windows必须加 /c，Unix则是加 –c 。
陷阱2：arg line， arg value 还有引号
假如我们扩充Windows平台下的例子，满足按修改时间倒序的要求：
<?xml version="1.0" ?>
<project name="testExec" default="test">
</project>
成功。换Unix了：
<?xml version="1.0" ?>
<project name="testExec" default="test">
</project>
对不起，失败：java.lang.IOException。
之所以这样，是因为<arg line>把每个空格分隔的字符串作为参数传给调用程序，但是对于”/bin/sh”来说，”ls –ltr”应该是
一个参数而不是两个。解决办法有两个：
加引号：
<?xml version="1.0" ?>
<project name="testExec" default="test">
</project>
或者使用<arg value>：
<?xml version="1.0" ?>
<project name="testExec" default="test">
<arg value="ls -ltr" />
</project>
陷阱3：阻塞（block）
不论是Windows还是Unix，调用一个程序后都必须等到该操作结束才能继续作下面的操作。如果你想调用一个程序的同时还做其它的
工作，必须使用<parallel>：
<?xml version="1.0" ?>
<project name="testExec" default="test">
</project>
需要注意的属性：
dir
os
failonerror
<target
在build.xml中新加一个target,如下:
<!-- 启动Tomcat -->
<target name="start"
description="启动tomcat">
</target>
dir指向tomcat的运行脚本目录
executable指定要执行的程序
arg指定在cmd中要运行的脚本
关键字: ant
1 Ant是什么？
Apache Ant 是一个基于 Java的生成工具。
生成工具在软件开发中用来将源代码和其他输入文件转换为可执行文件的形式（也有可能转换为可安装的产品映像形式）。随着应
用程序的生成过程变得更加复杂，确保在每次生成期间都使用精确相同的生成步骤，同时实现尽可能多的自动化，以便及时产生一
致的生成版本
2 下载、安装Ant
安装Ant
下载.zip文件，解压缩到c:\ant1.3(后面引用为%ANT_HOME%)
2.1 在你运行Ant之前需要做一些配置工作。
? 将bin目录加入PATH环境变量。
? 设定ANT_HOME环境变量，指向你安装Ant的目录。在一些OS上，Ant的脚本可以猜测ANT_HOME（Unix和Windos
NT/2000）－但最好
不要依赖这一特性。
? 可选地，设定JAVA_HOME环境变量（参考下面的高级小节），该变量应该指向你安装JDK的目录。
注意：不要将Ant的ant.jar文件放到JDK/JRE的lib/ext目录下。Ant是个应用程序，而lib/ext目录是为JDK扩展使用的（如JCE，
JSSE扩展）。而且通过扩展装入的类会有安全方面的限制。
2.2 运行Ant
运行Ant非常简单，当你正确地安装Ant后，只要输入ant就可以了。
? 没有指定任何参数时，Ant会在当前目录下查询build.xml文件。如果找到了就用该文件作为buildfile。如果你用 -find 选项。
Ant就会在上级目录中寻找buildfile，直至到达文件系统的根。要想让Ant使用其他的buildfile，可以用参数 -buildfile file，
这里file指定了你想使用的buildfile。
? 可以指定执行一个或多个target。当省略target时，Ant使用标签<project>的default属性所指定的target。
命令行选项总结：
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.xml运行Ant，执行缺省的target。
ant -buildfile test.xml
使用当前目录下的test.xml运行Ant，执行缺省的target。
ant -buildfile test.xml dist
使用当前目录下的test.xml运行Ant，执行一个叫做dist的target。
ant -buildfile test.xml -Dbuild=build/classes dist
使用当前目录下的test.xml运行Ant，执行一个叫做dist的target，并设定build属性的值为build/classes。
3 编写build.xml
Ant的buildfile是用XML写的。每个buildfile含有一个project。
buildfile中每个task元素可以有一个id属性，可以用这个id值引用指定的任务。这个值必须是唯一的。（详情请参考下面的Task小
节）
3.1 Projects
project有下面的属性：
Attribute Description Required
name 项目名称. No
default 当没有指定target时使用的缺省target Yes
basedir 用于计算所有其他路径的基路径。该属性可以被basedir
property覆盖。当覆盖时，该属性被忽略。如果属性和basedir
property都没有设定，就使用buildfile文件的父目录。 No
项目的描述以一个顶级的<description>元素的形式出现（参看description小节）。
一个项目可以定义一个或多个target。一个target是一系列你想要执行的。执行Ant时，你可以选择执行那个target。当没有给定
target时，使用project的default属性所确定的target。
3.2 Targets
一个target可以依赖于其他的target。例如，你可能会有一个target用于编译程序，一个target用于生成可执行文件。你在生成可
执行文件之前必须先编译通过，所以生成可执行文件的target依赖于编译target。Ant会处理这种依赖关系。
然而，应当注意到，Ant的depends属性只指定了target应该被执行的顺序－如果被依赖的target无法运行，这种depends对于指定了
依赖关系的target就没有影响。
Ant会依照depends属性中target出现的顺序（从左到右）依次执行每个target。然而，要记住的是只要某个target依赖于一个
target，后者就会被先执行。
<target name="A"/>
<target name="B" depends="A"/>
<target name="C" depends="B"/>
<target name="D"
depends="C,B,A"/>
假定我们要执行target
D。从它的依赖属性来看，你可能认为先执行C，然后B，最后A被执行。错了，C依赖于B，B依赖于A，所以先
执行A，然后B，然后C，最后D被执行。
一个target只能被执行一次，即时有多个target依赖于它（看上面的例子）。
如 果（或如果不）某些属性被设定，才执行某个target。这样，允许根据系统的状态（java version, OS, 命令行属性定义等等）
来更好地控制build的过程。要想让一个target这样做，你就应该在target元素中，加入if（或unless）属性，带 上target因该有
所判断的属性。例如：
<target name="build-module-A"
if="module-A-present"/>
<target name="build-own-fake-module-A"
unless="module-A-present"/>
如果没有if或unless属性，target总会被执行。
可选的description属性可用来提供关于target的一行描述，这些描述可由-projecthelp命令行选项输出。
将你的tstamp task在一个所谓的初始化target是很好的做法，其他的target依赖这个初始化target。要确保初始化target是出现在
其他target依赖表中的第一个target。在本手册中大多数的初始化target的名字是"init"。
target有下面的属性：
Attribute Description Required
name target的名字 Yes
depends 用逗号分隔的target的名字列表，也就是依赖表。 No
if 执行target所需要设定的属性名。 No
unless 执行target需要清除设定的属性名。 No
description 关于target功能的简短描述。 No
3.3 Tasks
一个task是一段可执行的代码。
一个task可以有多个属性（如果你愿意的话，可以将其称之为变量）。属性只可能包含对property的引用。这些引用会在task执行
前被解析。
下面是Task的一般构造形式：
<name attribute1="value1" attribute2="value2" ...
/>
这里name是task的名字，attributeN是属性名，valueN是属性值。
有一套内置的（built-in）task，以及一些可选task，但你也可以编写自己的task。
所有的task都有一个task名字属性。Ant用属性值来产生日志信息。
可以给task赋一个id属性：
<taskname id="taskID" ... />
这里taskname是task的名字，而taskID是这个task的唯一标识符。通过这个标识符，你可以在脚本中引用相应的task。例如，在脚
本中你可以这样：
<script ... >
task1.setFoo("bar");
</script>
设定某个task实例的foo属性。在另一个task中（用java编写），你可以利用下面的语句存取相应的实例。
project.getReference("task1").
注意1：如果task1还没有运行，就不会被生效（例如：不设定属性），如果你在随后配置它，你所作的一切都会被覆盖。
注意2：未来的Ant版本可能不会兼容这里所提的属性，因为很有可能根本没有task实例，只有proxies。
3.4 Properties
一 个project可以有很多的properties。可以在buildfile中用property task来设定，或在Ant之外设定。一个property有一个名字
和一个值。property可用于task的属性值。这是通过将属性名放在"${" 和"}"之间并放在属性值的位置来实现的。例如如果有一个
property builddir的值是"build"，这个property就可用于属性值：${builddir}/classes。这个值就可被解析为 build/classes。
内置属性
如果你使用了<property> task 定义了所有的系统属性，Ant允许你使用这些属性。例如，${os.name}对应操作系统的名字。
要想得到系统属性的列表可参考the Javadoc of System.getProperties。
除了Java的系统属性，Ant还定义了一些自己的内置属性：
basedir project基目录的绝对路径
(与<project>的basedir属性一样)。
ant.file buildfile的绝对路径。
ant.version Ant的版本。
ant.project.name
当前执行的project的名字；由<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
你可以用":"和";"作为分隔符，指定类似PATH和CLASSPATH的引用。Ant会把分隔符转换为当前系统所用的分隔符。
当需要指定类似路径的值时，可以使用嵌套元素。一般的形式是
<classpath>
<pathelement
path="${classpath}"/>
<pathelement
location="lib/helper.jar"/>
</classpath>
location属性指定了相对于project基目录的一个文件和目录，而path属性接受逗号或分号分隔的一个位置列表。path属性一般用作
预定义的路径－－其他情况下，应该用多个location属性。
为简洁起见，classpath标签支持自己的path和location属性。所以：
<classpath>
<pathelement
path="${classpath}"/>
</classpath>
可以被简写作：
<classpath
path="${classpath}"/>
也可通过<fileset>元素指定路径。构成一个fileset的多个文件加入path-like
structure的顺序是未定的。
<classpath>
<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>的简洁写法对于<path>也是有效的，如：
<path id="tests.path">
<path refid="base.path"/>
<pathelement
location="testclasses"/>
</path>
可写成：
<path id="base.path"
path="${classpath}"/>
命令行变量
有些task可接受参数，并将其传递给另一个进程。为了能在变量中包含空格字符，可使用嵌套的arg元素。
Attribute Description Required
value 一个命令行变量；可包含空格字符。 只能用一个
line 空格分隔的命令行变量列表。
file 作为命令行变量的文件名；会被文件的绝对名替代。
path 一个作为单个命令行变量的path-like的字符串；或作为分隔符，Ant会将其转变为特定平台的分隔符。
例子
<arg value="-l -a"/>
是一个含有空格的单个的命令行变量。
<arg line="-l -a"/>
是两个空格分隔的命令行变量。
<arg path="/dir;/dir2:\dir3"/>
是一个命令行变量，其值在DOS系统上为\dir;\dir2;\dir3；在Unix系统上为/dir:/dir2:/dir3 。
References
buildfile元素的id属性可用来引用这些元素。如果你需要一遍遍的复制相同的XML代码块，这一属性就很有用－－如多次使用
<classpath>结构。
下面的例子：
<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>
可以写成如下形式：
<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也接受这种类型的引用。
<zip destfile="output.zip"
basedir="output"/><!--在1.4中,应当把destfile改成zipfile.-->
tar与此相同
<gzip src="output.tar"
zipfile="output.tar.gz"/>
解压缩
<unzip src="output.tar.gz"
dest="extractDir"/>
还可以包括 overwrite 属性来控制覆盖行为。默认设置是覆盖与正在被提取的归档文件中的条目相匹配的所有现有文件。相关的任务名称是
untar、unjar、gunzip 和 bunzip2
顶