ANT-build.xml文件详解

 

Ant 的概念

可能有些读者并不连接什么是 Ant 以及入可使用它，但只要使用通过 Linux 系统得读者，应该知道 make 这个命令。当编译 Linux 内核及一些软件的源程序时，经常要用这个命令。 Make 命令其实就是一个项目管理工具，而 Ant 所实现功能与此类似。像 make ， gnumake 和 nmake 这些编译工具都有一定的缺陷，但是 Ant 却克服了这些工具的缺陷。最初 Ant 开发者在开发跨平台的应用时，用样也是基于这些缺陷对 Ant 做了更好的设计。

Ant 与 makefile

Makefile 有一些不足之处，比如很多人都会碰到的烦人的 Tab 问题。最初的 Ant 开发者多次强调 ” 只是我在 Tab 前面加了一个空格，所以我的命令就不能执行 ” 。有一些工具在一定程度上解决了这个问题，但还是有很多其他的问题。 Ant 则与一般基于命令的工具有所不同，它是 Java 类的扩展。 Ant 运行需要的 XML 格式的文件不是 Shell 命令文件。它是由一个 Project 组成的，而一个 Project 又可分成可多 target ， target 再细分又分成很多 task ，每一个 task 都是通过一个实现特定接口的 java 类来完成的。

Ant 的优点

Ant 是 Apache 软件基金会 JAKARTA 目录中的一个子项目，它有以下的优点。跨平台性。 Ant 是存 Java 语言编写的，所示具有很好的跨平台性。操作简单。 Ant 是由一个内置任务和可选任务组成的。 Ant 运行时需要一个 XML 文件 ( 构建文件 ) 。 Ant 通过调用 target 树，就可以执行各种 task 。每个 task 实现了特定接口对象。由于 Ant 构建文件时 XML 格式的文件，所以和容易维护和书写，而且结构很清晰。 Ant 可以集成到开发环境中。由于 Ant 的跨平台性和操作简单的特点，它很容易集成到一些开发环境中去。

Ant 开发

Ant 的构建文件当开始一个新的项目时，首先应该编写 Ant 构建文件。构建文件定义了构建过程，并被团队开发中每个人使用。 Ant 构建文件默认命名为 build.xml ，也可以取其他的名字。只不过在运行的时候把这个命名当作参数传给 Ant 。构建文件可以放在任何的位置。一般做法是放在项目顶层目录中，这样可以保持项目的简洁和清晰。下面是一个典型的项目层次结构。

(1) src 存放文件。

(2) class 存放编译后的文件。

(3) lib 存放第三方JAR包。

(4) dist 存放打包，发布以后的代码。

Ant 构建文件是 XML 文件。每个构建文件定义一个唯一的项目 (Project 元素 ) 。每个项目下可以定义很多目标 (target 元素 ) ，这些目标之间可以有依赖关系。当执行这类目标时，需要执行他们所依赖的目标。每个目标中可以定义多个任务，目标中还定义了所要执行的任务序列。 Ant 在构建目标时必须调用所定义的任务。任务定义了 Ant 实际执行的命令。 Ant 中的任务可以为 3 类。

(1)  核心任务。核心任务是 Ant 自带的任务。

(2)  可选任务。可选任务实来自第三方的任务，因此需要一个附加的 JAR 文件。

(3)  用户自定义的任务。用户自定义的任务实用户自己开发的任务。

1. 标签

每个构建文件对应一个项目。 标签时构建文件的根标签。它可以有多个内在属性，就如代码中所示，其各个属性的含义分别如下。

(1) default 表示默认的运行目标，这个属性是必须的。

(2) basedir 表示项目的基准目录。

(3) name 表示项目名。

(4) description 表示项目的描述。

每个构建文件都对应于一个项目，但是大型项目经常包含大量的子项目，每一个子项目都可以有自己的构建文件。

2. 标签

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

该标签用于创建一个目录，它有一个属性 dir 用来指定所创建的目录名，其代码如下： ＄ {class.root}”/> 通过以上代码就创建了一个目录，这个目录已经被前面的 property 标签所指定。

4. 标签

该标签用来生成一个 JAR 文件，其属性如下。

(1) destfile 表示JAR文件名。

(2) basedir 表示被归档的文件名。

(3) includes 表示别归档的文件模式。

(4) exchudes 表示被排除的文件模式。

5 ． 标签

该标签用于编译一个或一组 java 文件，其属性如下 :

(1).srcdir 表示源程序的目录。

(2).destdir 表示 class 文件的输出目录。

(3).include 表示被编译的文件的模式。

(4).excludes 表示被排除的文件的模式。

(5).classpath 表示所使用的类路径。

(6).debug 表示包含的调试信息。

(7).optimize 表示是否使用优化。

(8).verbose 表示提供详细的输出信息。

(9).fileonerror 表示当碰到错误就自动停止。

6 ． 标签

该标签用来执行编译生成的 .class 文件，其属性如下。

(1).classname 表示将执行的类名。

(2).jar 表示包含该类的 JAR 文件名。

(3).classpath 所表示用到的类路径。

(4).fork 表示在一个新的虚拟机中运行该类。

(5).failonerror 表示当出现错误时自动停止。

(6).output 表示输出文件。

(7).append 表示追加或者覆盖默认文件。

7. 标签

该标签用于删除一个文件或一组文件，去属性如下 :

(1).file 表示要删除的文件。

(2).dir 表示要删除的目录。

(3).includeEmptyDirs 表示指定是否要删除空目录，默认值是删除。

(4).failonerror 表示指定当碰到错误是否停止，默认值是自动停止。

(5).verbose 表示指定是否列出所删除的文件，默认值为不列出。

8. 标签

该标签用于文件或文件集的拷贝，其属性如下。

(1).file 表示源文件。

(2).tofile 表示目标文件。

(3).todir 表示目标目录。

(4).overwrite 表示指定是否覆盖目标文件，默认值是不覆盖。

(5).includeEmptyDirs 表示制定是否拷贝空目录，默认值为拷贝。

(6).failonerror 表示指定如目标没有发现是否自动停止，默认值是停止。

(7).verbose 表示制定是否显示详细信息，默认值不显示。

Ant 的数据类型

在构建文件中为了标识文件或文件组，经常需要使用数据类型。数据类型包含在

org.apache.tool.ant.types 包中。下面简单介绍构建文件中一些常用的数据类型。

1. argument 类型

由 Ant 构建文件调用的程序，可以通过 元素向其传递命令行参数，如 apply,exec 和 java 任务均可接受嵌套 元素，可以为各自的过程调用指定参数。以下是 的所有属性。

(1).values 是一个命令参数。如果参数种有空格，但又想将它作为单独一个值，则使用此属性。

(2).file 表示一个参数的文件名。在构建文件中，此文件名相对于当前的工作目录。

(3).line 表示用空格分隔的多个参数列表。

(4).path 表示路径。

2.ervironment 类型

由 Ant 构建文件调用的外部命令或程序， 元素制定了哪些环境变量要传递给正在执行的系统命令， 元素可以接受以下属性。

(1).file 表示环境变量值得文件名。此文件名要被转换位一个绝对路径。

(2).path 表示环境变量的路径。 Ant 会将它转换为一个本地约定。

(3).value 表示环境变量的一个直接变量。

(4).key 表示环境变量名。

注意   file path 或 value 只能取一个。

3.filelist 类型

Filelist 是一个支持命名的文件列表的数据类型，包含在一个 filelist 类型中的文件不一定是存在的文件。以下是其所有的属性。

(1).dir 是用于计算绝对文件名的目录。

(2).files 是用逗号分隔的文件名列表。

(3).refid 是对某处定义的一个 的引用。

注意   dir 和 files 都是必要的，除非指定了 refid( 这种情况下， dir 和 files 都不允许使用 ) 。

4.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 是对模式的分组，他们是紧密相关的概念。 支持 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 的类型。

Ant 的运行

安装好 Ant 并且配置好路径之后，在命令行中切换到构建文件的目录，输入 Ant 命令就可以运行 Ant. 若没有指定任何参数， Ant 会在当前目录下查询 build.xml 文件。如果找到了就用该文件作为构建文件。如果使用了 –find 选项， Ant 就会在上级目录中找构建文件，直至到达文件系统得跟目录。如果构建文件的名字不是 build.xml ，则 Ant 运行的时候就可以使用 –buildfile file, 这里 file 指定了要使用的构建文件的名称，示例如下：

Ant 如下说明了表示当前目录的构建文件为 build.xml 运行 ant 执行默认的目标。

Ant –buildfile  test.xml 使用当前目录下的 test.xml 文件运行 Ant , 执行默认的目标