Ant基本使用Word格式.docx
《Ant基本使用Word格式.docx》由会员分享,可在线阅读,更多相关《Ant基本使用Word格式.docx(28页珍藏版)》请在冰豆网上搜索。
-emacsproducelogginginformationwithoutadornments
-logfilefileusegivenfileforlogoutput
-loggerclassnametheclassthatistoperformlogging
-listenerclassnameaddaninstanceofclassasaprojectlistener
-buildfilefileusespecifiedbuildfile
-findfilesearchforbuildfiletowardstherootofthefilesystemandusethefirstonefound
-Dproperty=valuesetpropertytovalue
Ant命令行参考
从命令行调用Ant的语法如下所示:
ant[option[option...]][target[target...]]
option:
={-help
|-projecthelp
|-version
|-quiet
|-verbose
|-debug
|-emacs
|-logfilefilename
|-loggerclassname
|-listenerclassname
|-buildfilefilename
|-Dproperty=value
|-findfilename}
语法元素说明如下:
-help
显示描述Ant命令及其选项的帮助信息。
-projecthelp
显示包含在构建文件中的、所有用户编写的帮助文档。
即为各个<
target>
中description属性的文本,以及包含在<
description>
元素中的任何文
本。
将有description属性的目标列为主目标(“Maintarget”),没有此属
性的目标则列为子目标(“Subtarget”)。
-version
要求Ant显示其版本信息,然后退出。
-quiet
抑制并非由构建文件中的echo任务所产生的大多数消息。
-verbose
显示构建过程中每个操作的详细消息。
此选项与-debug选项只能选其一。
-debug
显示Ant和任务开发人员已经标志为调试消息的消息。
此选项与-verbose只
能选其一。
-emacs
对日志消息进行格式化,使它们能够很容易地由Emacs的shell模式(shellmode)
所解析;
也就是说,打印任务事件,但并不缩排,在其之前也没有
[taskname]。
-logfilefilename
将日志输出重定向到指定文件。
-loggerclassname
指定一个类来处理Ant的日志记录。
所指定的类必须实现了org.apache.
tools.ant.BuildLogger接口。
-listenerclassname
为Ant声明一个监听类,并增加到其监听者列表中。
在Ant与IDE或其他Java
程序集成时,此选项非常有用。
可以阅读第六章以了解有关监听者的更多信
息。
必须将所指定的监听类编写为可以处理Ant的构建消息接发。
-buildfilefilename
指定Ant需要处理的构建文件。
默认的构建文件为build.xml。
-Dproperty=value
在命令行上定义一个特性名-值对。
-findfilename
指定Ant应当处理的构建文件。
与-buildfile选项不同,如果所指定文件在当
前目录中未找到,-find就要求Ant在其父目录中再进行搜索。
这种搜索会继
续在其祖先目录中进行,直至达到文件系统的根为止,在此如果文件还未找
到,则构建失败。
构建文件轮廓
下面是一个通用的构建文件,它很适合作为一个模板。
构建文件包括<
元素,以及其中嵌套的<
、<
property>
和<
path>
元素。
<
projectdefault="
all"
>
propertyname="
a.property"
value="
avalue"
/>
b.property"
bvalue"
pathid="
a.path"
pathelementlocation="
${java.home}/jre/lib/rt.jar"
/path>
targetname="
javacsrcdir="
."
classpathrefid="
/javac>
/target>
/project>
关于构建文件有几点需要记住:
●所有构建文件都要有<
元素,而且至少有一个<
●对于<
元素的default属性并没有默认值。
●构建文件并不一定要被命名为build.xml。
不过build.xml是Ant要搜索的默
认文件名。
●每个构建文件只能有一个<
例子
ant
使用当前目录下的build.xml运行Ant,执行缺省的target。
ant-buildfiletest.xml
使用当前目录下的test.xml运行Ant,执行缺省的target。
ant-buildfiletest.xmldist
使用当前目录下的test.xml运行Ant,执行一个叫做dist的target。
ant-buildfiletest.xml-Dbuild=build/classesdist
使用当前目录下的test.xml运行Ant,执行一个叫做dist的target,并设定build属性的值为build/classes。
3编写build.xml
Ant的buildfile是用XML写的。
每个buildfile含有一个project。
buildfile中每个task元素可以有一个id属性,可以用这个id值引用指定的任务。
这个值必须是唯一的。
(详情请参考下面的Task小节)
3.1Projects
project有下面的属性:
AttributeDescriptionRequired
name项目名称.No
default当没有指定target时使用的缺省targetYes
basedir用于计算所有其他路径的基路径。
该属性可以被basedirproperty覆盖。
当覆盖时,该属性被忽略。
如果属性和basedirproperty都没有设定,就使用buildfile文件的父目录。
No
项目的描述以一个顶级的<
元素的形式出现(参看description小节)。
一个项目可以定义一个或多个target。
一个target是一系列你想要执行的。
执行Ant时,你可以选择执行那个target。
当没有给定target时,使用project的default属性所确定的target。
3.2Targets
一个target可以依赖于其他的target。
例如,你可能会有一个target用于编译程序,一个target用于生成可执行文件。
你在生成可执行文件之前必须先编译通过,所以生成可执行文件的target依赖于编译target。
Ant会处理这种依赖关系。
然而,应当注意到,Ant的depends属性只指定了target应该被执行的顺序-如果被依赖的target无法运行,这种depends对于指定了依赖关系的target就没有影响。
Ant会依照depends属性中target出现的顺序(从左到右)依次执行每个target。
然而,要记住的是只要某个target依赖于一个target,后者就会被先执行。
A"
B"
depends="
C"
D"
C,B,A"
假定我们要执行targetD。
从它的依赖属性来看,你可能认为先执行C,然后B,最后A被执行。
错了,C依赖于B,B依赖于A,所以先执行A,然后B,然后C,最后D被执行。
一个target只能被执行一次,即时有多个target依赖于它(看上面的例子)。
如果(或如果不)某些属性被设定,才执行某个target。
这样,允许根据系统的状态(javaversion,OS,命令行属性定义等等)来更好地控制build的过程。
要想让一个target这样做,你就应该在target元素中,加入if(或unless)属性,带上target因该有所判断的属性。
例如:
build-module-A"
if="
module-A-present"
build-own-fake-module-A"
unless="
如果没有if或unless属性,target总会被执行。
可选的description属性可用来提供关于target的一行描述,这些描述可由-projecthelp命令行选项输出。
将你的tstamptask在一个所谓的初始化target是很好的做法,其他的target依赖这个初始化target。
要确保初始化target是出现在其他target依赖表中的第一个target。
在本手册中大多数的初始化target的名字是"
init"
。
target有下面的属性:
nametarget的名字Yes
depends用逗号分隔的target的名字列表,也就是依赖表。
if执行target所需要设定的属性名。
unless执行target需要清除设定的属性名。
description关于target功能的简短描述。
3.3Tasks
一个task是一段可执行的代码。
一个task可以有多个属性(如果你愿意的话,可以将其称之为变量)。
属性只可能包含对property的引用。
这些引用会在task执行前被解析。
下面是Task的一般构造形式:
nameattribute1="
value1"
attribute2="
value2"
.../>
这里name是task的名字,attributeN是属性名,valueN是属性值。
有一套内置的(built-in)task,以及一些可选task,但你也可以编写自己的task。
所有的task都有一个task名字属性。
Ant用属性值来产生日志信息。
可以给task赋一个id属性:
tasknameid="
taskID"
这里taskname是task的名字,而taskID是这个task的唯一标识符。
通过这个标识符,你可以在脚本中引用相应的task。
例如,在脚本中你可以这样:
script...>
task1.setFoo("
bar"
);
/script>
设定某个task实例的foo属性。
在另一个task中(用java编写),你可以利用下面的语句存取相应的实例。
project.getReference("
task1"
).
注意1:
如果task1还没有运行,就不会被生效(例如:
不设定属性),如果你在随后配置它,你所作的一切都会被覆盖。
注意2:
未来的Ant版本可能不会兼容这里所提的属性,因为很有可能根本没有task实例,只有proxies。
3.4Properties
一个project可以有很多的properties。
可以在buildfile中用propertytask来设定,或在Ant之外设定。
一个property有一个名字和一个值。
property可用于task的属性值。
这是通过将属性名放在"
{"
和"
}"
之间并放在属性值的位置来实现的。
例如如果有一个propertybuilddir的值是"
build"
,这个property就可用于属性值:
{builddir}/classes。
这个值就可被解析为build/classes。
内置属性
如果你使用了<
task定义了所有的系统属性,Ant允许你使用这些属性。
例如,{os.name}对应操作系统的名字。
要想得到系统属性的列表可参考theJavadocofSystem.getProperties。
除了Java的系统属性,Ant还定义了一些自己的内置属性:
basedirproject基目录的绝对路径(与<
的basedir属性一样)。
ant.filebuildfile的绝对路径。
ant.versionAnt的版本。
ant.project.name当前执行的project的名字;
由<
的name属性设定.
ant.java.versionAnt检测到的JVM的版本;
目前的值有"
1.1"
"
1.2"
1.3"
and"
1.4"
.
projectname="
MyProject"
default="
dist"
basedir="
!
--setglobalpropertiesforthisbuild-->
src"
--Createthetimestamp-->
tstamp/>
--Createthebuilddirectorystructureusedbycompile-->
mkdirdir="
{build}"
compile"
--Compilethejavacodefrom{src}into{build}-->
{src}"
destdir="
--Createthedistributiondirectory-->
{dist}/lib"
--Puteverythingin{build}intotheMyProject-{DSTAMP}.jarfile-->
jarjarfile="
{dist}/lib/MyProject-{DSTAMP}.jar"
clean"
--Deletethe{build}and{dist}directorytrees-->
deletedir="
{dist}"
3.5Path-likeStructures
你可以用"
:
"
;
作为分隔符,指定类似PATH和CLASSPATH的引用。
Ant会把分隔符转换为当前系统所用的分隔符。
当需要指定类似路径的值时,可以使用嵌套元素。
一般的形式是
classpath>
pathelementpath="
{classpath}"
lib/helper.jar"
/classpath>
location属性指定了相对于project基目录的一个文件和目录,而path属性接受逗号或分号分隔的一个位置列表。
path属性一般用作预定义的路径--其他情况下,应该用多个location属性。
为简洁起见,classpath标签支持自己的path和location属性。
所以:
可以被简写作:
classpathpath="
也可通过<
fileset>
元素指定路径。
构成一个fileset的多个文件加入path-likestructure的顺序是未定的。
filesetdir="
lib"
includename="
**/*.jar"
/fileset>
classes"
上面的例子构造了一个路径值包括:
{classpath}的路径,跟着lib目录下的所有jar文件,接着是classes目录。
如果你想在多个task中使用相同的path-likestructure,你可以用<
元素定义他们(与target同级),然后通过id属性引用--参考Referencs例子。
path-likestructure可能包括对另一个path-likestructurede的引用(通过嵌套<
元素):
base.path"
tests.path"
pathrefid="
testclasses"
前面所提的关于<
的简洁写法对于<
也是有效的,如:
可写成:
path="
命令行变量
有些task可接受参数,并将其传递给另一个进程。
为了能在变量中包含空格字符,可使用嵌套的arg元素。
value一个命令行变量;
可包含空格字符。
只能用一个
line空格分隔的命令行变量列表。
file作为命令行变量的文件名;
会被文件的绝对名替代。
path一个作为单个命令行变量的path-like的字符串;
或作为分隔符,Ant会将其转变为特定平台的分隔符。
argvalue="
-l-a"
是一个含有空格的单个的命令行变量。
argline="
是两个空格分隔的命令行变量。
argpath="
/dir;
/dir2:
\dir3"
是一个命令行变量,其值在DOS系统上为\dir;
\dir2;
\dir3;
在Unix系统上为/dir:
/dir3。
References
buildfile元素的id属性可用来引用这些元素。
如果你需要一遍遍的复制相同的XML代码块,这一属性就很有用--如多次使用<
结构。
下面的例子:
project...>
target...>
rmic...>
lib/"
{java.class.path}/"
{additional.path}"
/rmic>
javac...>
可以写成如下形式:
project.class.path"
l