Ant 使用指南

梦里梦外; 2022-06-13 13:20 209阅读 0赞

Ant 使用指南  
Ant 介绍  
Apache Ant 是一个基于 Java 的生成工具。 生成工具在软件开发中用来将源代码和其他输入文件转换为可执行文件的形式 （也有可能转 换为可安装的产品映像形式） 。随着应用程序的生成过程变得更加复杂，确保在每次生成期 间都使用精确相同的生成步骤， 同时实现尽可能多的自动化， 以便及时产生一致的生成版本 优点： 1.语言简单易学，脚本使用 xml 格式编写 2.易于使用，构建过程简单 3.跨平台（因为是 java） ，java 类路径和目录结构都是可以移植方式进行处理(比如 window linux 路径问题) 4.速度快，像编译打包这样的 java 常规工作都可以在 ant 的 jvm 中进行，节省了其他 jvm 所 消耗的时间 5.集成 jUnit 6.易于使用 java 进行功能扩展 7.支持 j2ee 部署 8.善意 java 项目部署 9.已经成为大多数开源项目的构建工具 10.支持测试和部署过程，可用于“编译-测试-部署”的过程  
Ant 安装  
Ant 的安装为”绿色安装”，具体步骤如下： 1、 下载。从 apache 官网下载 apache-ant-1.8.2 并解压。 2、 配置环境变量 ANT\_HOME，为 ant 的顶级目录 3、 在环境变量 Path 下添加%ANT\_HOME%\\bin(其实就是指向 bin 目录， 这样的话就能在 DOS 环境下使用—ANT 命令) Ant 安装测试： 在 DOS 下运行 ANT,如果出现下面的命令则表示安装成功！ Buildfile: build.xml does not exist! Build failed  
Ant 命令  
Ant 命令指安装 Ant 完成后可以在 Dos 环境下运行相应的命令， 如-ant version 则显示本机 ant 的版本号。执行-ant help 可以获得 Ant 命令帮助。 由于在开发中使用不是很多，在此不做过多解释。  
做出色的自己  
Van 出品  
\-2-  
如果有需要可查看 Ant 相关文档。  
Ant 系统属性  
Ant 系统属性指的是 Ant 获取本地及操作系统方面的相关属性。 在 build.xml 文件可以用$\{\}来获取这些值。如$\{os.name\}. 如 build.xml 为以下内容 <?xml version="1.0" encoding="UTF-8"?> <project name="fdx" default="main" basedir="."> <echo>操作系统$\{os.name\}</echo> </project> 执行该 Ant 文件则可以看到效果。 其他系统属性可以查看相关文档。  
build.xml 文件的编辑  
基本结构  
build.xml 本身为一个 XML 文件，严格遵从 XML 语法，其基本结构为：  
<project><target name="init"></target></project> Project为根，其中可以包含多个target(目标), target中可以包含多个任务 项目 目标 任务  
Project 节点的配置  
Name：工程名称 Basedir：基础路径，很重要，可以设置路径 Default：默认启动的 target，很重要，build 文件执行的入口。  
Target 节点的配置  
Name：Target 的名称 Description：描述，注释作用 Depends：在该 Target 执行前先去执行的 Target 名称 depends 属性指定了 target 的执行顺序,Ant 会依照 depends 属性中target 标签出现顺序依次 执行每个 target,在执行之前首先执行它所依赖的 target 标签，例如： 项目中的名为 run 的 target 的 depends 属性 compile，而名为 compile 的 target 的 depends 属性是 init,所以这几个 target 标签的执行顺序是 init—》compile—》run。一个 target 只能被  
做出色的自己  
Van 出品  
\-3-  
执行一次，即使有多个 target 依赖于它。如果没有 if 或 unless 属性，target 总会被执行。  
Ant 常用标签  
<project>节点 节点  
每个构建文件对应一个项目,project 标签是构建文件的跟标签,它可以有多个内在属性,各个 属性的含义分别如下所示： default 表示默认的执行目标,这个属性是必须的。 basedir 表示项目的基准路径,这个属性是必须的。 name 表示项目名称。 description 表示项目的描述(或者是对这个标签的作用进行表述)。 每个构建文件都对应于一个项目， 但是大型项目经常包含大量的子项目， 每一个子项目都可 以有自己的构建文件。  
<target>标签 标签  
一个项目标签下可以有一个或多个 target 标签,一个 target 标签可以依赖其他 target 标 签,target 所有属性如下所示： name 表示这个标签的名字,这个属性是必须的。 depends 表示依赖的目标。 if 表示仅当属性设置时才执行。 unless 表示当属性没有设置时才执行。 description 表示项目的描述(或者是对这个标签的作用进行表述)。 Ant 的 depends 属性指定了 target 的执行顺序,Ant 会依照 depends 属性中 target 标签出现顺 序依次执行每个 target,在执行之前首先执行它所依赖的 target 标签，例如： 项目中的名为 run 的 target 的 depends 属性 compile，而名为 compile 的 target 的 depends 属性是 init,所以这几个 target 标签的执行顺序是 init—》compile—》run。一个 target 只能被 执行一次，即使有多个 target 依赖于它。如果没有 if 或 unless 属性，target 总会被执行。  
<ant>标签 标签  
<ant antfile="build.xml"></ant> 执行另外的 build.xml 文件  
做出色的自己  
Van 出品  
\-4-  
<mkdir>标签 标签  
该标签用户创建一个目录,它有一个属性 dir 用户指定所创建的目录,其代码如下： <mkdir dir="目录名"/>  
<jar>标签 标签  
该标签用来生成一个 JAR 包,其属性如下: jarfile 表示生产 JAR 文件名。 basedir 表示被归档的目录。 includes 表示别归档的文件模式。 exchudes 表示被排除的文件模式。  
<javac 标签 标签>  
该标签用于编译一个或一组 java 文件，其属性如下： srcdir 表示 java 源程序的目录。 destdir 表示 class 文件的输出目录。 includes 表示别归档的文件模式。 exchudes 表示被排除的文件模式。 debug 表示包含的调试信息。 optimize 表示是否使用优化。 classpath 表示所使用的类路径。 verbose 表示提供详细的输出信息。 fileonerror 表示当碰到错误就自动停止。  
<java>标签 标签  
该标签用来执行编译生成的.class 文件，其属性如下: classname 表示将执行的类名。 jar 表示包含该类的 JAR 文件名。 classpath 所表示用到的类路径。 fork 表示在一个新的虚拟机中运行该类。 failonerror 表示当出现错误时自动停止。 output 表示输出文件。 append 表示追加或者覆盖默认文件。  
做出色的自己  
Van 出品  
\-5-  
<delete>标签 标签  
该标签用于删除一个文件或一组文件，其属性如下: file 表示要删除的文件。 dir 表示要删除的目录。 includeEmptyDirs 表示指定是否要删除空目录，默认值是删除。 failonerror 表示指定当碰到错误是否停止，默认值是自动停止。 verbose 表示指定是否列出所删除的文件，默认值为不列出。  
<copy>标签 标签  
该标签用于文件或文件集的拷贝，其属性如下: file 表示源文件。 tofile 表示目标文件。 todir 表示目标目录。 overwrite 表示指定是否覆盖目标文件，默认值是不覆盖。 includeEmptyDirs 表示制定是否拷贝空目录，默认值为拷贝。 failonerror 表示指定如目标没有发现是否自动停止，默认值是停止。 verbose 表示制定是否显示详细信息，默认值不显示。  
<war>标签 标签  
该标签用来生成一个 WAR 包,其属性如下: destfile 表示生产 JAR 文件名。 dir 表示被归档的文件目录。 includes 表示别归档的文件模式。 exchudes 表示被排除的文件模式。  
<echo>标签 标签  
该标签用来在控制台输出信息,其输入如下： message 表示输入的内容。  
<exec>标签 标签  
执行相关命令  
做出色的自己  
Van 出品  
\-6-  
<fail>标签 标签  
强制 Ant 退出.  
<aviliable>标签 标签  
查看相关资源是否存在，property 将结果注册，在别处可以使用 <available classname="javax.servlet.http.HttpSessionEvent" property="fff"> <classpath refid="lujing"></classpath> </available> <fail unless="fff" message="成功"/>  
<uptodate>标签 标签  
用于配置属性  
<tstamp>标签 标签  
<tstamp/>完成后可以使用$\{DSTAMP\} $\{TSTAMP\}得到当前时间  
Filter Mapper 过滤器 映射  
Filter 过滤器： 在 copy 等任务的时候可以过滤相关的内容 Mapper： 在做有关任务的时候对某些资源进行有关的映射。 Type: identity(于原来的一致) flatten(去除文件夹)  
做出色的自己  
Van 出品  
\-7-  
第三方任务  
Javamake  
使用 taskdef 标签进行注册，然后再 Target 节点下进行使用 <taskdef name="javamake" classname="com.sun.tools.javamake.ant.JavaMake"> <classpath><pathelement location="../WebPro\_Package/javamake/javamake.jar"/> </classpath> <classpath><pathelement location="../WebPro\_Package/javamake/javamake-ant15.jar"/> </classpath> </taskdef>  
Junit  
Ant 属性引用  
Ant 属性的几种使用方式： 1、 在 build.xml 文件中添加属性文件 <property file="test.properties"></property> 在 properties 文件中注册信息，不如 test=name 在 build.xml 中使用$\{test\}即可得到 name 2、 在 dos 命令行下使用 ant –Dtest=name build.xml 来运行配置文件 build.xml 即可使用$\{test\}得到 name 3、 在 build.xml 中直接使用<property name="one" value="yyyy"></property> 即可使用$\{test\}得到 name  
Ant 的数据类型  
在构建文件中为了标识文件或文件组，经常需要使用数据类型。数据类型包含在 org.apache.tool.ant.types 包中。简单介绍构建文件中一些常用的数据类型。 下面的数据类型可以在<property></property>节点下进行注册，然后进行使用。  
做出色的自己  
Van 出品  
\-8-  
1. argument 类型  
由 Ant 构建文件调用的程序， 可以通过<arg>元素向其传递命令行参数，如 apply,exec 和 java 任务均可接受嵌套<arg>元素，可以为各自的过程调用指定参数。以下是<arg>的所有属性: values 是一个命令参数,如果参数有空格,但又想将它作为单独一个值,则使用此属性。 file 表示一个参数的文件名。在构建文件中，此文件名相对于当前的工作目录。 line 表示用空格分隔的多个参数列表。 path 表示路径。  
2.ervironment 类型  
由 Ant 构建文件调用的外部命令或程序，<env>元素制定了哪些环境变量要传递给正在执行 的系统命令，<env>元素可以接受以下属性: file 表示环境变量值得文件名。此文件名要被转换位一个绝对路径。 path 表示环境变量的路径。Ant 会将它转换为一个本地约定。 value 表示环境变量的一个直接变量。 key 表示环境变量名。 注意 file path 或 value 只能取一个。  
3.filelist 类型  
Filelist 是一个支持命名的文件列表的数据类型， 包含在一个 filelist 类型中的文件不一定是存 在的文件。以下是其所有的属性: dir 是用于计算绝对文件名的目录。 files 是用逗号分隔的文件名列表。 refid 是对某处定义的一个<filelist>的引用。 注意 dir 和 files 都是必要的，除非指定了 refid(这种情况下，dir 和 files 都不允许使用)。  
4.fileset 类型  
Fileset 数据类型定义了一组文件，并通常表示为<fileset>元素。不过，许多 ant 任务构建成 了隐式的 fileset,这说明他们支持所有的 fileset 属性和嵌套元素。 以下为 fileset 的属性列表。 dir 表示 fileset 的基目录。 casesensitive 的值如果为 false，那么匹配文件名时，fileset 不是区分大小写的，其默认值为 true.  
做出色的自己  
Van 出品  
\-9-  
defaultexcludes 用来确定是否使用默认的排除模式，默认为 true。 excludes 是用逗号分隔的需要派出的文件模式列表。 excludesfile 表示每行包含一个排除模式的文件的文件名。 includes 是用逗号分隔的，需要包含的文件模式列表。 includesfile 表示每行包括一个包含模式的文件名。  
5.patternset 类型  
Fileset 是对文件的分组，而 patternset 是对模式的分组，他们是紧密相关的概念。 <patternset>支持 4 个属性：includes excludex includexfile 和 excludesfile,与 fileset 相 同。Patternset 还允许以下嵌套元素：include,exclude,includefile 和 excludesfile.  
6.filterset 类型  
Filterset 定义了一组过滤器，这些过滤器将在文件移动或复制时完成文件的文本替换。 主要属性如下： begintoken 表示嵌套过滤器所搜索的记号，这是标识其开始的字符串。 endtoken 表示嵌套过滤器所搜索的记号这是标识其结束的字符串。 id 是过滤器的唯一标志符。 refid 是对构建文件中某处定义一个过滤器的引用。  
7.Path 类型  
Path 元素用来表示一个类路径，不过它还可以用于表示其他的路径。在用作多个属性时， 路径中的各项用分号或冒号隔开。 在构建的时候， 此分隔符将代替当前平台中所有的路径分 隔符，其拥有的属性如下： location 表示一个文件或目录。Ant 在内部将此扩展为一个绝对路径。 refid 是对当前构建文件中某处定义的一个 path 的引用。 path 表示一个文件或路径名列表。  
8.mapper 类型  
Mapper 类型定义了一组输入文件和一组输出文件间的关系，其属性如下： classname 表示实现 mapper 类的类名。 当内置 mapper 不满足要求时， 用于创建定制 mapper. classpath 表示查找一个定制 mapper 时所用的类型路径。 classpathref 是对某处定义的一个类路径的引用。  
做出色的自己  
Van 出品  
\- 10 -  
from 属性的含义取决于所用的 mapper. to 属性的含义取决于所用的 mapper. type 属性的取值为 identity，flatten glob merge regexp 其中之一，它定义了要是用的内置 mapper 的类型。  
Ant 命令行参考  
(来自网络) 命令行选项总结： 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。  
文档说明  
1、 本文档以 apache-ant-1.8.2 为基础。 2、 本文档以 XP 操作系统作为测试环境。  
做出色的自己  
Van 出品  
\- 11 -  
3、 本文档中有些内容只写了一般常用的属性，如有缺失请查看具体官方文档。 4、 文档内容部分来自网上。