apache ant介绍

 

apache ant是一个基于java的编译工具。它从功能上类似于make,但它以克服了make的缺点。 
为什么在make, gnumake, nmake, jam这些编译工具后,还要产生一个ant呢?因为这些编译工具都有一定的限制。ant的最初开发者在开发跨平台的应用时,发现以前的那些开发工具都有一定的限制。例如make工具,它是基于shell的,它判断一系列的条件,并像在shell下面那样执行编译命令,这样做的好处的:针对特定的平台(如 unix),可以容易的利用这些工具做编译;但同时,这也意味着,你的编译限制在固定的操作系统下,如只能用于unix 
同时,make文件也有一些先天的缺陷。好多人都会遇到恐怖的tab问题。ant的最初开发者多次说我的命令不能执行因为我在tab前面加了一个空格!。一些工具如jam一定程序上解决了这个问题,但仍有其它的格式问题。 
ant
与从基于命令的那些扩展开来的那些工具不同,ant是由java类扩展的。不用编写shell命令,而是配置基于xml的文件,形成多个任务的目标配置树。每一个任务都是通过一个实现了一个规定接口的java类来运行的。 
ant
缺少了一些直接执行shell命令的能力,如find . -name foo -exec rm {},但它给用户提供了跨平台的能力,可以在任何地方工作。实际上,ant也提供了命令execute用来执行shell命令,这就是它的<exec>任务,它允许执行基于操作系统的命令。 
安装ant 
下载antant有两个版本,二进制版本和原代码版本。 
要编译和使用ant,你必须要有一个兼容jaxpxml解析器。 
二进制版本中自己带有了最新的apache xerces2 xml解析器。如果 你想用不同的兼容jaxp的解析器,你可以移去ant库目录下的xercesimpl.jarxml-apis.jar两个文件。你可以要用的解析器放到ant的库目录下,也可以把jars文件放到系统的类路径中。 
ant的当前版本中,还需要安装jdk。下面的二进制片版本的安装后的目录结构。 

  ant   
安装目录 

  ant/bin     
包含了运行脚本 

  ant/lib      ant
运行所需的类库 

  ant/docs     
文档 

  ant/etc      
一些配置,如何通过任务的xml输出建立详细的报告, 

移动编译后的文件,忽略错误警告 

   
在运行前还要做一些设置: 

1)     
path路径中加入ant/bin目录; 

2)     
设置ant_home为安装目录; 
3)     
通常还要设置java_homejava的安装路径。 
例如下: 
set ant_home=c:/ant 



set java_home=c:/jdk1.5.1 

set path=%path%;%ant_home%/bin 


使用ant 

1  
写一个简单的编译文件 


ant
的编译文件是写成xml格式的,每一个编译文件包含一个project和至少一个 





target
targets包含了一些task元素。每一个task元素可以有一个id 属性 
(attribute)
可以被其它的引用。 

2   projects 
一个projext可以有如下的属性attribute 
attribute 

说明 

是否必须 
name 

项目名称 

no 
default 

当没有target支持时,缺省使用的target 

yes. 
basedir 

基目录,其它的目录都是相对于此. 这个attribute可以被"basedir" property 覆盖。当"basedir" property设置后,basedir attribute就不起作用了。如果两者都没有设置,则buildfile本身的父目录作为基目录。 

no 
根据需要,还可以设定项目的说明,在<description>元素中。 
   
第一个project可以有一个或多个targets。一个target就是一系列的你要执行的任务组。在运行ant时, 
你可以选择哪一个任务组被执行。如果没有给出执行的任务组,则project缺省的任务组被执行。 

3   targets 
target
可能依赖于其它的target而存在。你可能用一个target用来编译,用 
另一个 target且用来布署。只有编译完成后,布署才可执行,这样布署就 
依赖于编译。 
要说明的是,antdepends attribute只是规定了target之间的前后执行 
关系,并不表示真正的依赖性。 
依赖的次序是按照排列次序从左到右。但如果这些依赖本身之间还有依赖 
关系,也可能在后面的先执行,如下面的例子: 
<target name="a"/> 



<target name="b" depends="a"/> 

<target name="c" depends="b"/> 

<target name="d" depends="c,b,a"/> 

如果我们要运行target d。从它的依赖attribute列表上看,可能先执行c 
然后b,再后是a。其实这是不对的。c依赖于bb依赖于a。因此是a先执行, 
然是b,然后c,最后是d 
一个target只执行一次,虽然可能好多的target都依赖于它。如上例中所示。 
target
还可以根据它的attribute的设置情况来判定执行情况。这允许根据 
系统的状况(如java版本,os,命令行属性定义等等)更好的控制编译过程。 
这就引入ifunless属性(attribute) 
注意:ant只是检查属性(attribute)是否被设置,而不查它的值,即使属性 
(attribute)
值为空字符串,它仍认为这是一个存在的属性(attribute) 
例如: 
<target name="build-module-a" if="module-a-present"/> 
<target name="build-own-fake-module-a" unless="module-a-present"/> 
在第一行中,如果module-a-present属性(attribute)被设置,则target执行。 
在第二个中,如果module-a-present属性(attribute)被设置,同target不执行。 
如果没有ifunless属性(attribute),则目标总会被执行。 
可选的description属性(attribute)可以用来表示一行的target的说明,可以 
在命令行中用-projecthelp参数显示出来。没有description属性(attribute) 
target被认为是内部的,并不显示出来,除非利用了-verbose-debug参数。 
初始化target,所有的其它target都依赖于它。通常都位于依赖列表的第一项。 
在这个手册中,大都的初始化targetsinit来命名。 
target
有如下的属性: 
属性(attribute) 

说明 

是否必须 
name 

target
的名字 

yes 
depends 

依赖target列表 

no 
if 

要执行target,某属性(attribute)必须要被设置 

no 
unless 

要执行target,某属性(attribute)必须不能被设置 

no 
description 

有关target功能的简短说明 

no 
target
命名说明:可以使用任何xml编码支持的字母表中的字符,如空串,逗号, 
空格。但最好避免使用它们,为了避免引起歧义,将来版本的ant不支持这些特殊 
的字符。而各种ide中时target的命名规则,则跟具体的开发厂家相关。 
以横线开头的target名,如”-restart”是有效的命名,但不能被用来在命令行 
中执行。 
4   tasks 
task
是一段可执行的代码。 
task
可以有多种属性(attribute)(或参数,只要你喜欢), 
属性(attribute)的值可能包含了对属性(attribute)的引用。 这些引用在task执行 
以前要解析开。 
task
的通用结构如下: 
<name attribute1="value1" attribute2="value2" ... /> 
name
task的名字,attributen是属性(attribute)的名字,而valuen则是属性 
(attribute)
的值。 
一些是内建的任务,而另一些是可选的任务,用户可自由定义。 
所有的tasks都有共享task名字,属性(attribute)值将会在ant生成消息时用到。 
task
可以指定一个id属性(attribute)<taskname id="taskid" ... /> 



taskname
task的名字,taskid是一个独一无二的标识。你可以在脚本程序或 
其它的task中通过这个名字引用相应的task对象。例如: 
<script ... > 



task1.setfoo("bar"); 

</script> 

这样可以task1foo属性值为bar;而在java程序中,则通过project.getreference 
("task1")
访问task1实例。 
5     properties 
项目可以有一系列的属性(property)。这些可能在编译文件通过property任务 
task)设置,或可能在ant外设置。一个属性(property)由名字和值对应起来。 
名字是大小写敏感的。属性(property)可以用在task(attribute)中。能够在 
”{property
}”的方式进行引用。例如,如果有一个builddir属性 
property),值为build,则在属性(attribute)中可以这样用:${builddir}/classes 
在运行时,它被转换成build/classes 
内建的properties 
ant
提供了所有的系统属性的访问就像这些系统属性(property)已经定义在 
<property>
任务中一样。 
例如:${os.name}表示操作系统的名称。 
下面列出了一些内建属性(property): 
basedir
项目的绝对路径 (就像在<project>basedir属性中定义中的一样) 



ant.file     
编译文件的绝对路径 

ant.version   ant
的版本 

ant.project.name   
正在执行的项目的名字,(就像在<project>name属性中设置的那样). 

ant.java.version    jvm
的版本,其值可能是"1.1", "1.2", "1.3" and "1.4". 

编译文件的例子: 

<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> 
上面,我们把属性(property)定义在任何target的外部,<property> 
<typedef>
<taskdef>这些task是特殊的task,可以在任何的target外部定义。 
这样做时,它们会在任何target执行前被执行。其它任何的task不能target目录 
外定义。 
   
上面一些target给了description,这样,在使用projecthelp选项时,会列出 
这些公共的 targets,而那些没有descriptiontarget则被认为是内部的, 
并不显示。 
   
最后,要使target工作,则source子目录要存在相应的位置。 

注: 英文中有两个单词都是属性attribute, property,这里不好区分。因此, 
实际翻译时,把原文的这两个单词也写了出来。

 

 

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.<project>
标签

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

(1) default表示默认的运行目标,这个属性是必须的。
(2) basedir
表示项目的基准目录。
(3) name
表示项目名。
(4) description
表示项目的描述。
每个构建文件都对应于一个项目,但是大型项目经常包含大量的子项目,每一个子项目都可以有自己的构建文件。

2.<target>标签 
一个项目标签下可以有一个或多个target标签。一个target标签可以依赖其他的target标签。例如,有一个target用于编译程序,另一个target用于声称可执行文件。在生成可执行文件之前必须先编译该文件,因策可执行文件的target依赖于编译程序的targetTarget的所有属性如下。

(1).name表示标明,这个属性是必须的。
(2).depends
表示依赖的目标。
(3)if
表示仅当属性设置时才执行。
(4)unless
表示当属性没有设置时才执行。
(5)description
表示项目的描述。
Ant
depends属性指定了target的执行顺序。Ant会依照depends属性中target出现顺序依次执行每个target。在执行之前,首先需要执行它所依赖的target。程序中的名为runtargetdepends属性compile,而名为compiletargetdepends属性是prepare,所以这几个target执行的顺序是prepare->compile->run

一个target只能被执行一次,即使有多个target依赖于它。如果没有ifunless属性,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,execjava

务均可接受嵌套<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(这种情况下,dirfiles都不允许使用)

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
属性的取值为identityflatten 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 ,执行默认的目标。

 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值