初涉Ant
初识Ant
ApacheAnt,是一个将软件编译、测试、部署等步骤联系在一起加以自动化的一个工具,大多用于Java环境中的软件开发。
Ant的原名为Anotherneattool,翻译过来为另外一个干净的工具,在Java程序的开发中,ant是一个极好的助手。Ant使用XML格式的文件作为其运行的脚本,xml已经被大多数组织承认为通用的数据交换协议,具有容易阅读,编写,修改等良好的特性,被大多数人所接受。Ant运行的XML脚本文件中的每个元素都代表一个动作,ant通过动作调用相应的程序来执行任务,完成用户的操作。执行命令是ant的基本目标,把完成一项任务所需的命令按照正常的顺序写入ant脚本文件,ant调用脚本顺序执行,便可以完成一项大的任务。脚本具有一次完成编写,多次使用的特性,适合可重复的,顺序完成的任务。
默认情况下,XML文件名为build.xml。
构建ant环境
要使用ant首先要构建一个ant环境,步骤很简单:
1),安装jdk,设置JAVA_HOME,PATH,CLASS_PATH
2),下载ant地址www.apache.org
3),解压ant你得到的是一个压缩包,解压缩它,并把它放在一个尽量简单的目录
4),设置ANT_HOMEPATH中添加ANT_HOME目录下的bin目录
5),测试一下你的设置,开始-->运行-->cmd进入命令行-->键入ant回车,如果看到
Buildfile:build.xmldoesnotexist!
Buildfailed
那么恭喜你你已经完成ant的设置
myeclipse 自带ant 详情见下面
使用Ant
<?xml version="1.0" encoding="UTF-8"?> <project name="HelloWorld" default="run" basedir="./"> <property name="src" value="src" /> <property name="build.dir" value="build" /> <property name="build.classes" value="${build.dir}/classes" /> <property name="build.lib" value="${build.dir}/lib" /> <property name="hello_jar" value="${build.lib}/hello1.jar" /> <target name="init"> <mkdir dir="${build.dir}" /> <mkdir dir="${build.lib}" /> <mkdir dir="${build.classes}" /> </target> <target name="compile" depends="init"> <javac srcdir="${src}" destdir="${build.classes}" /> </target> <target name="build" depends="compile"> <jar jarfile="${hello_jar}" basedir="${build.classes}" /> </target> <target name="run" depends="build"> <java classname="com.javachen.ant.HelloWorld" classpath="${build.classes}" /> </target> <target name="clean"> <delete dir="${build.dir}" /> <delete file="${hello_jar}" /> </target> <target name="rerun" depends="run,clean"> <ant target="clean" /> <ant target="run" /> </target> </project> <project name="HelloWorld" default="run" basedir="."> </project>
分析说明:
ant的所有内容必须包含在这个里边,name是你给它取的名字,basedir故名思意就是工作的根目录.代表当前目录。default代表默认要做的事情。
特性定义允许我们避免在构建文件中将目录名硬编码。这些路径通常都是相对于<project>元素所指定的基目录。
例如,以下标签设置了源文件目录名。
<propertyname="src"value="src"/>
类似程序中的变量,为什么这么做想一下变量的作用
其后,这个构建文件定义了多个目标。每个目标都有一个名字,如“prepare”、“clean”或“compile”。开发人员从命令行调用Ant时要结合这些目标名。每个目标定义了0个或多个依赖关系(dependency),同时还有一个可选的description属性(attribute)。依赖关系指定了在当前目标执行之前,Ant必须先执行的目标。例如“prepare”必须在“compile”之前执行。对于Ant将显示的目标,description属性为其提供一个适合阅读的描述。
把你想做的每一件事情写成一个target,它有一个名字,depends是它所依赖的target,在执行这个target例如这里的compile之前ant会先检查init是否曾经被执行过,如果执行过则直接执行compile,如果没有则会先执行它依赖的target例如这里的init,然后在执行这个target。
如我们的计划
编译:
<target name="compile" depends="init"> <javac srcdir="${src}" destdir="${build.classes}" /> </target>
做jar包:
<target name="build" depends="compile"> <jar jarfile="${hello_jar}" basedir="${build.classes}" /> </target>
运行:
<target name="run" depends="build"> <java classname="com.javachen.ant.HelloWorld" classpath="${build.classes}" /> </target>
为了不用拷贝,我们可以在最开始定义好目标文件夹,这样ant直接把结果就放在目标文件夹中了.
新建文件夹:
<target name="init"> <mkdir dir="${build.dir}" /> <mkdir dir="${build.lib}" /> <mkdir dir="${build.classes}" /> </target>
为了更多一点的功能体现,又加入了两个target:
删除生成的文件
<target name="clean"> <delete dir="${build.dir}" /> <delete file="${hello_jar}" /> </target>
再次运行,这里显示了如何在一个target里边调用其他的target
<target name="rerun" depends="clean,run"> <ant target="clean" /> <ant target="run" /> </target>
命令行 直接输入ant 会执行target name=run
如果想执行指定target ant clean 或 ant rerun
Ant build.xml配置文件解释
<project>标签
每个构建文件对应一个项目。<project>标签时构建文件的根标签。它可以有多个内在属性,就如代码中所示,其各个属性的含义分别如下。
(1)default表示默认的运行目标,这个属性是必须的。
(2)basedir表示项目的基准目录。
(3)name表示项目名。
(4)description表示项目的描述。
<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总会被执行。
<mkdir>标签
该标签用于创建一个目录,它有一个属性dir用来指定所创建的目录名,其代码如下:
<mkdirdir=”${class.root}”/>
通过以上代码就创建了一个目录,这个目录已经被前面的property标签所指定。
<jar>标签
该标签用来生成一个JAR文件,其属性如下:
(1)destfile表示JAR文件名。
(2)basedir表示被归档的文件名。
(3)includes表示别归档的文件模式。
(4)excludes表示被排除的文件模式。
<javac标签>
该标签用于编译一个或一组java文件,其属性如下。
(1)srcdir表示源程序的目录。
(2)destdir表示class文件的输出目录。
(3)include表示被编译的文件的模式。
(4)excludes表示被排除的文件的模式。
(5)classpath表示所使用的类路径。
(6)debug表示包含的调试信息。
(7)optimize表示是否使用优化。
(8)verbose表示提供详细的输出信息。
(9)fileonerror表示当碰到错误就自动停止。
<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的数据类型
在构建文件中为了标识文件或文件组,经常需要使用数据类型。数据类型包含在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表示环境变量名。
注意filepath或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的类型。
关于构建文件有几点需要记住:
●所有构建文件都要有<project>元素,而且至少有一个<target>元素。
●对于<project>元素的default属性并没有默认值。
●构建文件并不一定要被命名为build.xml。不过build.xml是Ant要搜索的默认文件名。
●每个构建文件只能有一个<project>元素。
根据《ANT十五大最佳实践》,必须遵循以下几个原则:
1.采用一致的编码规范
精选含意明确、容易读懂的词汇来命名任务和属性。比如,dir.reports就比rpts好。特定的编码规范并不重要,只要拿出一套规范并坚持使用就行。
2.将build.xml放在项目根目录中
以下是一个典型的项目目录层次:
[rootdir]
|build.xml
+--src
+--lib(包含第三方JAR包)
+--build(由build任务生成)
+--dist(由build任务生成)
当build.xml在顶级目录时,假设你处于项目某个子目录中,只要输入:ant-findcompile命令,不需要改变工作目录就能够以命令行方式编译代码。参数-find告诉Ant寻找存在于上级目录中的build.xml并执行。
3.使用单一的构建文件
4.提供良好的帮助说明
5.提供清除任务
6.使用ANT管理任务从属关系
7.定义并重用文件路径
8.定义恰当的任务从属关系
9.使用属性
10.保持构建过程独立
11.使用版本控制系统
12.使用版本控制系统
13.使用zipfileset属性
14.测试Clean任务
15.避免特定平台的Ant封装
MyEclipse自动生成AntBuild.xml
关于MyEclipse自动生成AntBuild.xml配置文件,生成的方法很隐蔽,是自己无意中找到的.
选择你要生成Build.xml文件的项目,右键.Export-> General -> Ant Buildfiles .
点Next,再点Finish.OK,生成完毕.然后自己再根据需求去修改.
参考资料:
ant入门:http://www.blogjava.net/dreamstone/archive/2006/09/20/70649.html
ANT十五大最佳实践:http://oreilly.com.cn/news/ant15toppractices.php?c=java
《Ant权威指南》:http://oreilly.com.cn/book.php?bn=7-5083-1417-4