<project name="MyProject" default="dist" basedir="."><description>simple example build file</description><!-- set global properties for this build -->
<property name="src" location="src"/><property name="build" location="build"/><property name="dist" location="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"description="compile the source " ><!-- Compile the java code from ${src} into ${build} -->
<javac srcdir="${src}" destdir="${build}"/></target><target name="dist" depends="compile"description="generate the distribution" ><!-- 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"description="clean up" ><!-- Delete the ${build} and ${dist} directory trees -->
<delete dir="${build}"/><delete dir="${dist}"/></target></project>以上给出了一个典型的ant的build文件,就从这个例子中说说ant的相关部分。
每个build文件,默认名称为build.xml,每个build文件中只能有一个唯一的项目project节点,每个项目中可以有多个target元素,这些target元素之间可以有依赖关系,target元素的depends属性来标识target之间的依赖。ant在构建时会根据depends属性,去构建一个build的树形结构,target一般都只会执行一次,被依赖的target不会被执行多次。project标签为跟标签,包含几个属性,各属性含义分别如下:
1、default标识默认的运行目标(target)
2、basedir标识项目的基准目录
3、name标识项目名
4、description标识项目的描述
target标签,在一个项目中可以有一个或多个target标签(至少一个),一个target标签可以依赖其他的target。target标签的所有属性如下:
1、name标识名称,该属性必须
2、depends标识target的依赖目标target的名称
3、if标识仅当属性设置时才执行
4、unless标识当属性没有设置时执行
5、description标识项目的描述
例如:有一个target用于编译程序,另外一个target用于声称可执行文件。那么在生成可执行文件之前必须先编译程序的target,因为此可执行文件的target依赖于编译程序的target,之前给的一个例子中比较完整的表述出整个过程,先执行init,再compie,再dist,最后可选择执行clean。
mkdir标签,该标签用于创建一个目录,它有一个属性dir用来指定创建的目录名。
jar标签,该标签用来生成一个jar文件,其属性如下:
1、distfile标识jar的文件名
2、basedir标识被归档的文件名,就是待打包的文件的目录
3、includes标识被归档的文件模式
4、excludes标识被排除的文件模式
javac标签,该标签用于编译一个或一组java文件,其属性如下:
1、srcdir标识源程序的目录
2、destdir标识编译后的class文件的输出目录
3、include标识被编译的文件的模式
4、exclude标识被排除的文件的模式
5、classpath标识所使用的类的路径
6、debug标识包含的调试信息
7、optimize标识是否使用优化
8、verbose标识提供详细的输出信息
9、failonerror标识当碰到错误就自动停止
java标签,该标签用来执行编译生成的class文件,其属性如下:
1、classname 表示将执行的类名
2、jar表示包含该类的JAR文件名
3、classpath所表示用到的类路径
4、fork表示在一个新的虚拟机中运行该类
5、failonerror表示当出现错误时自动停止
6、output 表示输出文件
7、append表示追加或者覆盖默认文件
delete标签,用来标识删除一个文件或一组文件,其属性如下:
1、file 标识要删除的文件
2、dir标识要删除的目录
3、includeEmptyDirs 表示指定是否要删除空目录,默认值是删除
4、failonerror 表示指定当碰到错误是否停止,默认值是自动停止
5、verbose表示指定是否列出所删除的文件,默认值为不列出
copy标签,该标签用于文件或文件集的拷贝,其属性如下:
1、file标识源文件
2、tofile标识目标文件
3、todir标识目标目录
4、overwrite 表示指定是否覆盖目标文件,默认值是不覆盖
5、includeEmptyDirs 表示制定是否拷贝空目录,默认值为拷贝
6、failonerror 表示指定如目标没有发现是否自动停止,默认值是停止
7、verbose 表示制定是否显示详细信息,默认值不显示
Ant的数据类型,在build文件中,为了标识文件或文件组,经常需要用到一些数据类型,ant中定义的数据类型放在org.apache.tool.ant.types包中,简要记录下常用数据类型的使用。
argument 类型
有ant的build文件调用的程序,可以通过<arg>元素向其传递命令行参数,例如apply、exec和java任务均可接收嵌套的<arg>元素,可以为各自的过程调用指定参数。以下是<arg>的所有属性:
1、values 是一个命令参数。如果参数种有空格,但又想将它作为单独一个值,则使用此属性
2、file表示一个参数的文件名。在构建文件中,此文件名相对于当前的工作目录
3、line表示用空格分隔的多个参数列表
4、path表示路径
ervironment 类型
由ant的build文件调用外部命令或程序时,<env>元素指定了哪些环境变量要传递给正在执行的系统命令,<env>元素可以接受以下属性:
1、file表示环境变量值得文件名。此文件名要被转换位一个绝对路径
2、path表示环境变量的路径。Ant会将它转换为一个本地约定
3、value 表示环境变量的一个直接变量
4、key 表示环境变量名
注意,file path或value只能取一个。
filelist 类型
filelist是一个支持命名的文件列表的数据类型,包含在一个filelist类型中的文件不一定是存在的文件,其属性如下:
1、dir是用于计算绝对文件名的目录
2、files 是用逗号分隔的文件名列表
3、refid 是对某处定义的一个<filelist>的引用
注意:dir和files都是必须的,除非指定了refid(这种情况下,dir和files都不允许使用)。
fileset 类型
fileset数据类型定义了一组文件,并通常表示为<fileset>元素,而且他们支持所有的fileset的属性和嵌套元素,以下为fileset的属性:
1、dir表示fileset 的基目录
2、casesensitive的值如果为false,那么匹配文件名时,fileset不是区分大小写的,其默认值为true
3、defaultexcludes 用来确定是否使用默认的排除模式,默认为true
4、excludes 是用逗号分隔的需要派出的文件模式列表
5、excludesfile 表示每行包含一个排除模式的文件的文件名
6、includes 是用逗号分隔的,需要包含的文件模式列表
7、includesfile 表示每行包括一个包含模式的文件名
Selector一般用作fileset的子元素,用来帮助筛选文件,常用的selector有:
<contains> - 用来选择包含指定字符串的文件
<depend> - Select files that have been modified more recently than equivalent files elsewhere
<depth> - 用来选择指定目录深度的文件
<different> - Select files that are different from those elsewhere
<filename> - 用来选择文件名匹配特定模式的文件。等价于include和exclude的patternset
<present> - 用来选择在某个位置存在或不存在的文件
<containsregexp> - 用来选择匹配指定正则表达式的文件
<size> - 用来选择比指定size大或小的文件
<type> - Select files that are either regular files or directories
<modified> - Select files if the return value of the configured algorithm is different from that stored in a cache
<signedselector> - Select files if they are signed, and optionally if they have a signature of a certain name
<scriptselector> - Use a BSF or JSR 223 scripting language to create your own selector
<readable> - 选择有readable属性的文件
<writable> - 选择有writable属性的文件
patternset 类型
fileset是对文件的分组,而patternset是对模式的分组,他们是紧密联系,相关的概念。
<patternset>支持4个属性:includes excludex includexfile 和 excludesfile,与fileset相同,patternset还允许以下嵌套元素:include,exclude,includefile 和 excludesfile。
patternset一般用作FileSet的子元素,用来帮助筛选文件
filterset 类型
filterset定义了一组过滤器,这些过滤器在文件移动或复制时完成文件的文本替换。主要属性如下:
1、begintoken 表示嵌套过滤器所搜索的记号,这是标识其开始的字符串
2、endtoken表示嵌套过滤器所搜索的记号这是标识其结束的字符串
3、id是过滤器的唯一标志符
4、refid是对构建文件中某处定义一个过滤器的引用
Path类型
path元素用来表示一个类的路径,不过也可以用来标识其他的路径,在用它的属性时,路径中的各项用分号或冒号隔开。再构建的时候,此分隔符将代替当前平台中所有的路径分隔符,其拥有的属性如下:
1、location 表示一个文件或目录。Ant在内部将此扩展为一个绝对路径
2、refid 是对当前构建文件中某处定义的一个path的引用
3、path表示一个文件或路径名列表
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会在当前目录下找build.xml文件,若找到了则用该文件作为构建文件。若使用了 -find选项,则ant会在上级目录中查找构建文件,直到文件系统的根目录。如果构建文件的名字不是build.xml,则在运行ant的时候需要使用 –buildfile file来指定构建文件,这里file指要使用的构建文件的名称。