Ant教程

Ant是什么？
Ant是一种基于Java和XML的build工具。

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就可以了。

n 没有指定任何参数时，Ant会在当前目录下查询build.xml文件。如果找到了就用该文件作为buildfile。如果你用 -find 选项。Ant就会在上级目录中寻找buildfile，直至到达文件系统的根。要想让Ant使用其他的buildfile，可以用参数 -buildfile file，这里file指定了你想使用的buildfile。

n 可以指定执行一个或多个target。当省略target时，Ant使用标签的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小节）。

一个项目可以定义一个或多个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 D。从它的依赖属性来看，你可能认为先执行C，然后B，最后A被执行。错了，C依赖于B，B依赖于A，所以先执行A，然后B，然后C，最后D被执行。

一个target只能被执行一次，即时有多个target依赖于它（看上面的例子）。

如果（或如果不）某些属性被设定，才执行某个target。这样，允许根据系统的状态（java version, OS, 命令行属性定义等等）来更好地控制build的过程。要想让一个target这样做，你就应该在target元素中，加入if（或unless）属性，带上target因该有所判断的属性。例如：


如果没有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是task的名字，attributeN是属性名，valueN是属性值。

有一套内置的（built-in）task，以及一些可选task，但你也可以编写自己的task。

所有的task都有一个task名字属性。Ant用属性值来产生日志信息。

可以给task赋一个id属性：

这里taskname是task的名字，而taskID是这个task的唯一标识符。通过这个标识符，你可以在脚本中引用相应的task。例如，在脚本中你可以这样：

设定某个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。

内置属性

如果你使用了 task 定义了所有的系统属性，Ant允许你使用这些属性。例如，${os.name}对应操作系统的名字。

要想得到系统属性的列表可参考the Javadoc of System.getProperties。

除了Java的系统属性，Ant还定义了一些自己的内置属性：
basedir project基目录的绝对路径 (与的basedir属性一样)。
ant.file buildfile的绝对路径。
ant.version Ant的版本。
ant.project.name 当前执行的project的名字；由的name属性设定.
ant.java.version Ant检测到的JVM的版本； 目前的值有"1.1", "1.2", "1.3" and "1.4".
???
例子

???






?

3.5 Path-like Structures
你可以用":"和";"作为分隔符，指定类似PATH和CLASSPATH的引用。Ant会把分隔符转换为当前系统所用的分隔符。

当需要指定类似路径的值时，可以使用嵌套元素。一般的形式是




location属性指定了相对于project基目录的一个文件和目录，而path属性接受逗号或分号分隔的一个位置列表。path属性一般用作预定义的路径－－其他情况下，应该用多个location属性。

为简洁起见，classpath标签支持自己的path和location属性。所以：



可以被简写作：

也可通过元素指定路径。构成一个fileset的多个文件加入path-like structure的顺序是未定的。







上面的例子构造了一个路径值包括：${classpath}的路径，跟着lib目录下的所有jar文件，接着是classes目录。

如果你想在多个task中使用相同的path-like structure，你可以用元素定义他们（与target同级），然后通过id属性引用－－参考Referencs例子。

path-like structure可能包括对另一个path-like structurede的引用（通过嵌套元素）：











前面所提的关于的简洁写法对于也是有效的，如：

?


可写成：

命令行变量

有些task可接受参数，并将其传递给另一个进程。为了能在变量中包含空格字符，可使用嵌套的arg元素。
Attribute Description Required
value 一个命令行变量；可包含空格字符。 只能用一个
line 空格分隔的命令行变量列表。
file 作为命令行变量的文件名；会被文件的绝对名替代。
path 一个作为单个命令行变量的path-like的字符串；或作为分隔符，Ant会将其转变为特定平台的分隔符。

例子

是一个含有空格的单个的命令行变量。

是两个空格分隔的命令行变量。

是一个命令行变量，其值在DOS系统上为\dir;\dir2;\dir3；在Unix系统上为/dir:/dir2:/dir3 。

References

buildfile元素的id属性可用来引用这些元素。如果你需要一遍遍的复制相同的XML代码块，这一属性就很有用－－如多次使用结构。

下面的例子：

???
?????
???????
???????
???????
?????
???
?











可以写成如下形式：

?

??













所有使用PatternSets, FileSets 或 path-like structures嵌套元素的task也接受这种类型的引用。

4.1 File（Directory）类
4.1.1 Mkdir
n 创建一个目录，如果他的父目录不存在，也会被同时创建。
n 例子：

n 说明： 如果build不存在，也会被同时创建
4.1.2 Copy
n 拷贝一个（组）文件、目录
n 例子：
1. 拷贝单个的文件：

2. 拷贝单个的文件到指定目录下

3. 拷贝一个目录到另外一个目录下
?
???
?
4. 拷贝一批文件到指定目录下
?
???
?????
???
?

?
???
?
5. 拷贝一批文件到指定目录下，将文件名后增加。Bak后缀
?
???
???
?
6. 拷贝一组文件到指定目录下，替换其中的@标签@内容
?
???
???
?????
???
?
4.1.3 Delete
n 删除一个（组）文件或者目录
n 例子
1. 删除一个文件

2. 删除指定目录及其子目录
?
3. 删除指定的一组文件
?
???
?
4. 删除指定目录及其子目录，包括他自己
?
???
?
4.1.4 Move
n 移动或重命名一个（组）文件、目录
n 例子：
1. 移动或重命名一个文件

2. 移动或重命名一个文件到另一个文件夹下面

3. 将一个目录移到另外一个目录下



4. 将一组文件移动到另外的目录下






5. 移动文件过程中增加。Bak后缀

时间：2007-3-8 10:51:13 |

ant教程

1,什么是ant
?ant是构建工具
2,什么是构建
?概念到处可查到，形象来说，你要把代码从某个地方拿来，编译，再拷贝到某个地方去等等操作，当然不仅与此，但是主要用来干这个
3,ant的好处
?跨平台? --因为ant是使用java实现的，所以它跨平台
?使用简单--与ant的兄弟make比起来
?语法清晰--同样是和make相比
?功能强大--ant能做的事情很多，可能你用了很久，你仍然不知道它能有多少功能。当你自己开发一些ant插件的时候，你会发现它更多的功能。
4,ant的兄弟make
?ant做的很多事情，大部分是曾经有一个叫make的所做的，不过对象不同，make更多应用于c/c++ ,ant更多应用于Java。当然这不是一定的，但大部分人如此。
一,构建ant环境
要使用ant首先要构建一个ant环境，步骤很简单：
1),安装jdk，设置JAVA_HOME ,PATH ,CLASS_PATH(这些应该是看这篇文章的人应该知道的)
2),下载ant 地址找一个你喜欢的版本，或者干脆最新的版本
3),解压ant 你得到的是一个压缩包，解压缩它，并把它放在一个尽量简单的目录，例如D:\ant-1.6虽然你不一 定要这么做，但这么做是有好处的。
4),设置ANT_HOME PATH中添加ANT_HOME目录下的bin目录
5),测试一下你的设置,开始-->运行-->cmd进入命令行-->键入 ant 回车,如果看到
Buildfile: build.xml does not exist!
Build failed
那么恭喜你你已经完成ant的设置
二,体验ant
就像每个语言都有HelloWorld一样，一个最简单的应用能让人感受一下Ant
1,首先你要知道你要干什么，我现在想做的事情是：
编写一些程序
编译它们
把它打包成jar包
把他们放在应该放置的地方
运行它们
这里为了简单起见只写一个程序，就是HelloWorld.java程序代码如下：
package test.ant;
public class HelloWorld{
?public static void main(String[] args){
? System.out.println("Hello world1");
?}
};

2，为了达到上边的目的，你可以手动的用javac 、copy 、jar、java来完成，但是考虑一下如果你有成百上千个类，在多次调试，部署的时候，一次次的javac 、copy、jar、

java那将是一份辛苦的工作。现在看看ant怎么优雅的完成它们。

要运行ant需要有一个build.xml虽然不一定要叫这个名字，但是建议你这么做
下边就是一个完整的build.xml，然后我们来详细的解释每一句


?
?
?
?
?
?
?
?
?
?
?
?
?
?
?
?
?
?
?
?
?
?
?

解释：

build.xml中的第一句话，没有实际的意义

ant的所有内容必须包含在这个里边，name是你给它取的名字，basedir故名思意就是工作的根目录 .代表当前目录。default代表默认要做的事情。

类似程序中的变量，为什么这么做想一下变量的作用

?

把你想做的每一件事情写成一个target ，它有一个名字，depends是它所依赖的target，在执行这个target 例如这里的compile之前ant会先检查init是否曾经被执行过，如果执行

过则直接直接执行compile，如果没有则会先执行它依赖的target例如这里的init，然后在执行这个target

如我们的计划
编译：

?

做jar包:

?

运行：

?

为了不用拷贝，我们可以在最开始定义好目标文件夹，这样ant直接把结果就放在目标文件夹中了
新建文件夹:

?

为了更多一点的功能体现，又加入了两个target
删除生成的文件

?
?

再次运行，这里显示了如何在一个target里边调用其他的target

?
?

好了，解释完成了，下边检验一下你的ant吧
新建一个src的文件夹，然后把HelloWorld.java按照包目录放进去
做好build.xml文件
在命令行下键入ant ,你会发现一个个任务都完成了。每次更改完代码只需要再次键入ant

有的时候我们可能并不想运行程序，只想执行这些步骤中的某一两个步骤，例如我只想重新部署而不想运行，键入
ant build

ant中的每一个任务都可以这样调用ant + target name
好了，这样一个简单的ant任务完成了。

?

?

一,什么时候使用ant
也许你听到别人说起ant，一时冲动准备学习一下ant，当你看完了上边的第一个实例，也许你感觉ant真好，也许你感觉ant不过如此，得出这些结论都不能说错，虽然ant很好用，

但并不是在任何情况下都是最好的选择，例如windows上有更多更简单，更容易使用的工具，比如eclipse+myeclipse eclipse+wtp等等，无论是编译，部署，运行使用起来比ant更

容易，方便但有些情况则是ant发挥的好地方：
1,服务器上部署的时候
当你的程序开发完成，部署人员要部署在服务器上的时候，总不能因为因为安装一个程序就配置一个eclipse+myeclipse吧，ant在这个时候是个很好的选择，因为它小巧，容易配

置，你带着你写好的build.xml到任何一台服务器上，只需要做简单的修改（一些设定，例如目录），然后一两个命令完成，这难道不是一件美好的事情吗。
2,linux上，很多时候是这样的，程序开发是在windows下，但是程序要在linux或者unix上运行，在linux或者
在unix(特别是unix上)部署是个麻烦的事情，这个时候ant的特点又出来了，因为ant是跨平台的，你在build.xml可以在大多数操作系统上使用，基本不需要修改。
3,当服务器维护者不懂编程的时候
很多人都有过这样的经历，使用你们程序的人，并不懂得写程序。你得程序因为版本更新，因为修正bug需要一次又一次得重新部署。这个时候你会发现教一个人是如此得困难。但

是有ant后，你只需要告诉他，输入ant xxx等一两个命令，一切ok.
以上是我遇到得一些情况。

看完以上得情况，好好考虑一下，你是否需要使用ant，如果是继续。

?

进一步学习一个稍微复杂一点点的ant
在实际的工作过程中可能会出现以下一些情况，一个项目分成很多个模块，每个小组或者部门负责一个模块，为了测试，他们自己写了一个build.xml,而你负责把这些模块组合到

一起使用，写一个build.xml
这个时候你有两种选择：
1,自己重新写一个build.xml ，这将是一个麻烦的事情
2,尽量利用他们已经写好的build.xml，减少自己的工作

举个例子：
假设你下边有三个小组，每个小组负责一个部分，他们分别有一个src 和一个写好的build.xml
这个时候你拿到他们的src，你需要做的是建立三个文件夹src1 ,src2, src3分别把他们的src和build.xml放进去，然后写一个build.xml

?
?
?
?
?
?
?
?
?
?
?
?
?
?
?
?
?
?
?
??
???
??
??
???
??
??
???
??
?
?
?
?
?
?

ok你的任务完成了。

?

ok,上边你完成了任务，但是你是否有些感触呢，在那些build.xml中，大多数是重复的，而且更改一次目录需要更改不少东西。是否能让工作做的更好一点呢，答案是肯定的。
引入两个东西：
1,propery
2,xml include

这两个东西都有一个功能，就是能把build.xml中中的内容分离出来，共同使用
除此之外它们各有特点：

propery的特点是维护简单，只需要简单的键值对，因为并不是所有人都喜欢xml的格式

xml include的特点是不单可以提取出属性来，连target也可以。

还是以前的例子：
例如我们想把src1 src2 src3这三个属性从xml中提出来，可以新建一个文件叫all.properties
里边的内容
src1=D:\\study\\ant\\src1
src2=D:\\study\\ant\\src2
src3=D:\\study\\ant\\src3
然后你的build.xml文件可以这样写，别人只需要更改配置文件，而不许要更改你的build.xml文件了

?
?
?
?
?
?
?
?
?
?
?
?
?
?
?
?
?
??
???
??
??
???
??
??
???
??
?
?
?
?
?
?
?
?
?
?
?

如果你自己看的话你会看到这样一个target

?
?
?

有的时候你想给每个小组的build.xml加入几个target，一种做法是每个里边写，然后在这里调用
但是有一种更好的方法。
你可以写一个include.xml文件，内容如下




?

然后更改你三个小组的build.xml文件,每个里边加入如下内容


]>
&share-variable;
变成如下的样子
这个时候，你只要在include.xml添加propery , 添加target，三个build.xml会同时添加这些propery和target
而且不会让三个组的build.xml变得更复杂。

]>

?
?&share-variable;
?
?
?
?
?
?
?
?
?
?
?
?
?
?
?
?
?
?
?
?
?
?
?
?

?

掌握了上边的那些内容之后，你就知道如何去写一个好的ant，但是你会发现当你真的想去做的时候，你不能马上作出好的build.xml，因为你知道太少的ant的默认提供的命令.这

个时候如果你想完成任务，并提高自己，有很多办法：
1,很多开源的程序都带有build.xml，看看它们如何写的
2,ant的document，里边详细列写了ant的各种默认命令，及其丰富
3,google，永远不要忘记它
ok,在这之后随着你写的ant build越来越多，你知道的命令就越多，ant在你的手里也就越来越强大了。
这个是一个慢慢积累的过程。

ant的例子很好找，各种开源框架都会带有一个build.xml仔细看看，会有很大收获
另外一个经常会用到的，但是在开源框架的build.xml一般没有的是cvs

如果使用的是远程的cvs，可以这样使用


????
????
????
????
????
????????????
????
????
???????????? ????????????? passfile="${cvs.passfile}"/>
?????

在eclipse里边先天支持ant，所以你可以在eclipse里边直接写build.xml
因为eclipse提供了提示功能，自动补充功能，它能让你事半功倍。
使用方法，只需要建立一个工程，然后建立一个叫build.xml的文件。然后就可以在里边写你的ant build了

但是时刻记住永远能找到你需要的东西

?