Java Ant build.xml详解

1）什么是Ant

ant是构建工具

2）什么是构建

概念到处可查到，形象来说，你要把代码从某个地方拿来，编译，再拷贝到某个地方去等等操作，当然不仅与此，但是主要用来干这个

3）Ant的好处

跨平台 --因为ant是使用java实现的，所以它跨平台

使用简单--与ant的兄弟make比起来

语法清晰--同样是和make相比

功能强大--ant能做的事情很多，可能你用了很久，你仍然不知道它能有多少功能。当你自己开发一些ant插件的时候，你会发现它更多的功能。

4）Ant的兄弟make

ant做的很多事情，大部分是曾经有一个叫make的所做的，不过对象不同，make更多应用于c/c++ ,ant更多应用于Java。当然这不是一定的，但大部分人如此。

5）构建Ant环境

要使用ant首先要构建一个ant环境，步骤很简单：

1)安装jdk，设置JAVA_HOME ,PATH ,CLASS_PATH(这些应该是看这篇文章的人应该知道的)

2)下载ant 地址http://www.apache.org/找一个你喜欢的版本，或者干脆最新的版本

3)解压ant 你得到的是一个压缩包，解压缩它，并把它放在一个尽量简单的目录，例如D:\ant-1.6虽然你不一 定要这么做，但这么做是有好处的。

4)设置ANT_HOME, PATH中添加ANT_HOME目录下的bin目录(我设置的：ANT_HOME:D:\apache-ant-1.8.2,PATH:%ANT_HOME%\bin)

5)测试一下你的设置,开始-->运行-->cmd进入命令行-->键入 ant 回车,如果看到

Buildfile: build.xml does not exist!

Build failed

那么恭喜你你已经完成ant的设置

6）体验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，然后我们来详细的解释每一句

<?xml version="1.0" encoding="UTF-8" ?>
<project name="HelloWorld" default="run" basedir=".">
<property name="src" value="src"/>
<property name="dest" value="classes"/>
<property name="hello_jar" value="hello1.jar"/>
<target name="init">
<mkdir dir="${dest}"/>
</target>
<target name="compile" depends="init">
<javac srcdir="${src}" destdir="${dest}"/>
</target>
<target name="build" depends="compile">
<jar jarfile="${hello_jar}" basedir="${dest}"/>
</target>
<target name="run" depends="build">
<java classname="test.ant.HelloWorld" classpath="${hello_jar}"/>
</target>
<target name="clean">
<delete dir="${dest}" />
<delete file="${hello_jar}" />
</target>
<target name="rerun" depends="clean,run">
<ant target="clean" />
<ant target="run" />
</target>
</project>

解释：

<?xml version="1.0" encoding="UTF-8" ?>

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

<project name="HelloWorld" default="run" basedir=".">

</project>

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

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

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

<target name="compile" depends="init">

<javac srcdir="${src}" destdir="${dest}"/>

</target>

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

如我们的计划

编译：

<target name="compile" depends="init">

<javac srcdir="${src}" destdir="${dest}"/>

</target>

做jar包:

<target name="build" depends="compile">

<jar jarfile="${hello_jar}" basedir="${dest}"/>

</target>

运行：

<target name="run" depends="build">

<java classname="test.ant.HelloWorld" classpath="${hello_jar}"/>

</target>

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

新建文件夹:

<target name="init">

<mkdir dir="${dest}"/>

</target>

为了更多一点的功能体现，又加入了两个target

删除生成的文件

<target name="clean">

<delete dir="${dest}" />

<delete file="${hello_jar}" />

</target>

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

<target name="rerun" depends="clean,run">

<ant target="clean" />

<ant target="run" />

</target>

好了，解释完成了，下边检验一下你的ant吧

新建一个src的文件夹，然后把HelloWorld.java按照包目录放进去

做好build.xml文件,最好将这些放到一个文件夹中,在cmd中进入该文件夹,

在命令行下键入ant ,你会发现一个个任务都完成了。每次更改完代码只需要再次键入ant

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

ant build

ant中的每一个任务都可以这样调用ant + target name

好了，这样一个简单的ant任务完成了。

7）什么时候使用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，如果是继续。

8）进一步学习一个稍微复杂一点点的ant

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

这个时候你有两种选择：

1,自己重新写一个build.xml ，这将是一个麻烦的事情

2,尽量利用他们已经写好的build.xml，减少自己的工作

举个例子：

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

<?xml version="1.0" encoding="UTF-8" ?>
<project name="main" default="build" basedir=".">
<property name="bin" value="${basedir}\bin" />
<property name="src1" value="${basedir}\src1" />
<property name="src2" value="${basedir}\src2" />
<property name="src3" value="${basedir}\src3" />
<target name="init">
<mkdir dir="${bin}" />
</target>
<target name="run">
<ant dir="${src1}" target="run" />
<ant dir="${src2}" target="run" />
<ant dir="${src3}" target="run" />
</target>
<target name="clean">
<ant dir="${src1}" target="clean" />
<ant dir="${src2}" target="clean" />
<ant dir="${src3}" target="clean" />
</target>
<target name="build" depends="init,call">
<copy todir="${bin}">
<fileset dir="${src1}">
<include name="*.jar" />
</fileset>
<fileset dir="${src2}">
<include name="*.jar" />
</fileset>
<fileset dir="${src3}">
<include name="*.jar" />
</fileset>
</copy>
</target>
<target name="rebuild" depends="build,clean">
<ant target="clean" />
<ant target="build" />
</target>
</project>

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

1）propery

2）xml include

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

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

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

9）property用法

还是以前的例子：

例如我们想把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文件了

<?xml version="1.0" encoding="UTF-8" ?>
<project name="main" default="build" basedir=".">
<property file="all.properties" />
<property name="bin" value="${basedir}\bin" />
<target name="init">
<mkdir dir="${bin}" />
</target>
<target name="run">
<ant dir="${src1}" target="run" />
<ant dir="${src2}" target="run" />
<ant dir="${src3}" target="run" />
</target>
<target name="clean">
<ant dir="${src1}" target="clean" />
<ant dir="${src2}" target="clean" />
<ant dir="${src3}" target="clean" />
</target>
<target name="build" depends="init,call">
<copy todir="${bin}">
<fileset dir="${src1}">
<include name="*.jar" />
</fileset>
<fileset dir="${src2}">
<include name="*.jar" />
</fileset>
<fileset dir="${src3}">
<include name="*.jar" />
</fileset>
</copy>
</target>
<target name="rebuild" depends="build,clean">
<ant target="clean" />
<ant target="build" />
</target>
<target name="test">
<ant dir="${src1}" target="test" />
<ant dir="${src2}" target="test" />
<ant dir="${src3}" target="test" />
</target>
</project>

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

<target name="test">

<ant dir="${src1}" target="test" />

<ant dir="${src2}" target="test" />

<ant dir="${src3}" target="test" />

</target>

10）xml include用法

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

<?xml version="1.0" encoding="UTF-8" ?>
<property name="src" value="src"/>
<property name="dest" value="classes"/>
<target name="test" >
<ant target="run" />
</target>

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

<!--include a xml file ,it can be common propery ,can be also a target -->

<!DOCTYPE project [

<!ENTITY share-variable SYSTEM "file:../include.xml">

]>

&share-variable;

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

<?xml version="1.0" encoding="UTF-8" ?>
<!--include a xml file ,it can be common propery ,can be also a target   -->
<!DOCTYPE project [
<!ENTITY share-variable SYSTEM "file:../include.xml">
]>
<project name="HelloWorld" default="run" basedir=".">
<!--use the include   -->
&share-variable;
<!--defined the property-->
<!--via include
<property name="src" value="src"/>
<property name="dest" value="classes"/>
-->
<property name="hello_jar" value="hello1.jar"/>
<!--define the op-->
<target name="init">
<mkdir dir="${dest}"/>
</target>
<target name="compile" depends="init">
<javac srcdir="${src}" destdir="${dest}"/>
</target>
<target name="build" depends="compile">
<jar jarfile="${hello_jar}" basedir="${dest}"/>
</target>
<target name="run" depends="build">
<java classname="test.ant.HelloWorld" classpath="${hello_jar}"/>
</target>
<target name="clean">
<delete dir="${dest}" />
<delete file="${hello_jar}" />
</target>
<target name="rerun" depends="clean,run">
<ant target="clean" />
<ant target="run" />
</target>
</project>

掌握了上边的那些内容之后，你就知道如何去写一个好的ant，但是你会发现当你真的想去做的时候，你不能马上作出好的build.xml，因为你知道太少的ant的默认提供的命令.这个时候如果你想完成任务，并提高自己，有很多办法：

1）很多开源的程序都带有build.xml，看看它们如何写的

2）ant的document，里边详细列写了ant的各种默认命令，及其丰富

3）google，永远不要忘记它

ok,在这之后随着你写的ant build越来越多，你知道的命令就越多，ant在你的手里也就越来越强大了。这个是一个慢慢积累的过程。

11）远程cvs用法

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

<xml version="1.0" encoding="utf-8"?>
<project>
<property name="cvsroot" value=":pserver:wang:@192.168.1.2:/cvsroot"/>
<property name="basedir" value="/tmp/testant/"/>
<property name="cvs.password" value="wang"/>
<property name="cvs.passfile" value="${basedir}/ant.cvspass"/>
<target name="initpass">
<cvspass cvsroot="${cvsroot}" password="${cvs.password}" passfile="${cvs.passfile}"/>
</target>
<target name="checkout" depends="initpass">
<cvs cvsroot="${cvsroot}" command="checkout" cvsrsh="ssh" package="myproject" dest="${basedir}"
passfile="${cvs.passfile}"/>
</target>
</project>

12）结束语

在eclipse里边先天支持ant，所以你可以在eclipse里边直接写build.xml。因为eclipse提供了提示功能，自动补充功能，它能让你事半功倍。使用方法，只需要建立一个工程，然后建立一个叫build.xml的文件。然后就可以在里边写你的ant build了，但是时刻记住http://www.apache.org/永远能找到你需要的东西~
注：本文在原文基础上进行了相应的排版。原文地址：/article/5659872.html。补充地址：http://www.blogjava.net/zhengtengfeng/archive/2007/04/20/zhtfeng.html。Using
Apache Ant Writing a Simple Buildfile http://ant.apache.org/manual/using.html

13）补充

一个典型的项目层次结构。

(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>标签

一个项目标签下可以有一个或多个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的类型。