ant-document属性文档.doc

ant的各个元素的属性介绍2009-09-02 17:28原文地址：/huanwang32/blog/static/7488552120097189217770/关于ANT的起源，最权威的莫过于官方站点：:URL:下面是我的学习笔记，主要是对些关键的地方的总结，还有就是一些我个人觉得比较有难度和技巧的地方的总结。首先是一些在使用ant前应该思考的问题，基本上这些问题的答案可以指导你怎么样用好antbuildfile怎么开始在build过程中我需要定义哪些property和datatypebuild过程中需要创建哪些目录谁负责一个完整的创建，还有库文件，安装和运行的脚本文件，以及静态的和生成的动态的文档？如果文件发生了变化，怎么重建？是否需要删除所有的class文件？是否需要删除生成的jar文件？哪些目录应该在发布前准备好？是否需要将源码和应用一起发布？谁负责发布？一、ANT的安装和配置（略）二、ANT入门（略）三、ANT的学习方法 学习ANT应该从“到底要用ANT来做什么”开始，针对自己的目的来学习，只要能够满足自己的工作的需要就可以了，ANT设计为可扩展的插件式的结构，每天都有人为ANT增加新的插件，因此要将ANT的所有应用掌握是不可能的，从我们的工作需求出发，ANT主要就是用来 compile, test, build, package, deloy, integration test，这也是我使用ANT的一种模式，我已经为这个模式写了一个模板，每次编写新的ANT的时候只需要针对具体的项目把这个模板修改一下就可以了，其实使用ANT是很简单的。使用来build项目有两个需要重点关注的地方：项目的组织和ANT的buildfile。四、buildfile的结构 对于ANT的使用者来说，理解ANT的配置文件是最重要的，ANT的XML配置文件的结构很简单，这也是ANT的一个优点，简单易懂，容易上手，ANT的配置文件主要由project，target和task三层树型结构组成如下： 关于project,target,task的概念，请参考官方文档的6 Using Ant部分。五、ANT的DataType 前面说到了ANT的配置文件的结构主要由project,target和task组成，其实project，target和task是ANT的四个重要的概念里面的三个，还有一个很重要的概念就是Data Elements，这是ANT最容易让人搞不清楚的一个方面，它们表达的是数据而不是任务。数据类型定义包括三个级别，project-level，target-level和task-level，有点类似于类里面定义全局变量，局部变量的方式，不同的是，这里代表了其在ant里面的可视性，如果直接定义在project节点下那就是project-level，所有的target和task都可以引用它们，以次类推。数据类型分为两个部分：property和DataTperty：标签里定义了name-value对。DataType：用于表示一套复杂的数据集，例如FileSet和Path 数据类型的定义通常和target平级，也就是是数据类型一般直接在project下一层定义，当然也有一些直接定义在task里面，通常我们定义在和target平级的时候，可以在task下面引用这些数据类型。总结ANT的数据类型如下：argument参数：从命令行传递到buildfile的参数environment环境变量：传递到buildfile的环境变量filelist文件列表：文件不一定存在fileset文件集：文件必须存在patternset模式集filterset过滤集path路径，还有classpathmapper映射：定义了输入与输出文件之间的一套复杂的关系。ANT的数据类型很多，以上列出的是一些常用的数据类型，下面重点总结一些我自己常用的数据类型，如environment，fileset，patternset，path1、property属性 一个项目可以配置很多property，property可以在在buildfile里面设置，也是可以在外部设置，在task中可以引用property，通过和符号来引用ANT属性的定义原则是取第一次定义的值，也就是说相同的属性，定义了多次，只有第一次定义的值是有效的。例如：#pertiestest=first因为perties文件中已经设置了test的值，所以在buildfile里面第二次设置的值是无效的，test的值仍然是firstbuild-in propertiesANT提供了访问系统properties的机制，也就是build-in properites，所谓系统properties，可以查看System.getProperties返回的值，以下是我的机器上的系统properties- listing properties -=Java(TM) 2 Runtime Environment, Stand.sun.boot.library.path=D:jdk1.3.1_03jrebinjava.vm.version=1.3.1_03-b03java.vm.vendor=Sun Microsystems Inc.java.vendor.url=:URL:/path.separator=;=Java HotSpot(TM) Client VMfile.encoding.pkg==Java Virtual Machine Specificationuser.dir=G:serverjava.runtime.version=1.3.1_03-b03java.awt.graphicsenv=sun.awt.Win32GraphicsEnvironmentos.arch=x86java.io.tmpdir=C:TMPline.separator=java.vm.specification.vendor=Sun Microsystems Inc.java.awt.fonts==Windows 2000java.library.path=D:jdk1.3.1_03bin;.;C:WINNT=Java Platform API Specificationjava.class.version=47.0os.version=5.0user.home=C:Documents and Settingsanonymoususer.timezone=java.awt.printerjob=sun.awt.windows.WPrinterJobfile.encoding=GBKjava.specification.version=1.3=anonymousjava.class.path=D:eclipse2.1.2pluginsorg.eclipse.j.java.vm.specification.version=1.0java.home=D:jdk1.3.1_03jreuser.language=zhjava.specification.vendor=Sun Microsystems Inc.awt.toolkit=sun.awt.windows.WT=interpreted modejava.version=1.3.1_03java.ext.dirs=D:jdk1.3.1_03jrelibextsun.boot.class.path=D:jdk1.3.1_03jrelibrt.jar;D:jdk1.java.vendor=Sun Microsystems Inc.file.separator=java.vendor.url.bug=:URL:/ cgi-bin/bugreport.sun.cpu.endian=littlesun.io.unicode.encoding=UnicodeLittleuser.region=CNsun.cpu.isalist=pentium i486 i386这些build-in properties可以直接象引用properties那样，例如：java.home除此之外，ANT还提供了自身的build-in properties:ant.java.version2、Environment环境变量假设你根据你的工作环境配置了下面的property：显然你的buildfile到其他开发人员的环境下面能够成功运行的可能性很小，因为其他人的xalan很可能在其他目录，使用Environment环境变量可以解决这个问题关键是：设置了这个属性之后，以后可以直接引用环境变量，只要前面加一个env.的前缀就可以了。3、fileset文件集fileset 表示了一套文件的集合，通常定义为project-level，ANT的task可以通过显式（explicit）的方式来引用或者直接嵌套 fileset，如果是直接嵌套，这个时候fileset是task-level的，很多ANT的task都支持隐式（implicit）的 fileset，也就是说这些TASK支持fileset的所有属性和嵌套的子元素，和filelist不同的是fileset所表示的文件必须存在。 Fileset可以定义为target-level的，并通过他们的id来引用。fileset支持以下常用的属性（casesensitive，defaultexcludes请查阅官方文档）：dir 必须指定，用于指定文件所在的目录excludes 可选，用于指定在dir指定的目录下那些不应该包括进来的文件，内容是逗号分割的文件模式(file pattern)。excludesfile 跟excludes类似，区别是只能包括一个模式，通常情况下我习惯使用excludes，因为excludes也包括了excludesfile的功能includes 可选，用于指定在dir指定的目录下那些需要包括进来的文件，内容是逗号分割的文件模式(file pattern)。includesfile 跟includes类似，区别是只能包括一个模式，通常情况下我习惯使用includes，因为includes也包括了includesfile的功能除了上面的属性之外，fileset还可以嵌套多个（或0个）以下的patternset元素 , , , .关于patternset的用法，我会在patternset这个部分专门总结。例子：等价于等价于也等价于4、patternset模式集 fileset 将文件合成一个组，patternset将模式合成一个组，它们的概念很接近，其实fileset依赖于patternset来选择文件，patternset可以表达为target-level，然后通过它的id来引用，也可以直接嵌套在fileset下面，那些支持隐式 (implicit)的fileset的task也支持嵌套的patternset。patternset支持includes, excludes, includesfile,excludesfile四个属性，这跟fileset的用法一样，还支持以下的嵌套的元素：0.n 个嵌套的 和元素，它们支持以下属性name 必须指定，内容为相应的include和exclude的模式。if 可选，和target的if属性的用法一样unless 可选，和target的unless属性的用法一样0.n 个嵌套的 和 元素，它们支持以下属性：name 必须指定，内容为相应的include和exclude的模式，但是只能是单个if 可选，和target的if属性的用法一样unless 可选，和target的unless属性的用法一样例子：patternset的定义patternset的引用5、path路径 path这个DataType可以是attribute也可以是一个嵌套的元素，最常用的是classpath这个形式，但是也用于其他用途。当作为XML元素使用的时候，path的用法非常的灵活，path支持以下attributelocation 可选，表示单个文件或者单个路径，它跟path的区别是数量上的，path可以表示多个文件和路径path 可选，路径或者文件列表，用;或者:作为分隔符refid 可选，引用其他的path的id，如果在buildfile里面会经常用到同样的path，可以将其定义为一个公用的，然后在使用到这个path的地方通过 refid来引用，如果refid被指定了，path的其他attribute和其嵌套的元素都是禁止使用的。path支持的嵌套元素如下：0.n 个嵌套的 pathlelement定义在路径下的一个或者多个文件， pathelement支持location和path这两个attribute，用法和path元素一样。0.n 个嵌套的 0.n 个嵌套的 classpath是path元素的一个针对类路径的特殊的元素，具有和path用样的使用语法，但是使用的场合主要是task下面。例子：等价于等价于六、目标驱动ANT为什么说目标驱动ANT呢，这其实是我的学习方法，也就是说我使用ANT来做什么，而“做什么”就是我们的目标，也就是buildfile里面的 target，只学习跟我们的目标有关的部分，其他的留到用的时候查阅有关资料，现学现卖，我学习ANT的目的是为了更好的辅助我的项目的创建，而不是要成为ANT的专家。就我目前的工作内容出发，我需要ANT协助我完成编译，测试，打包，发布，生成文档，有些时候，还会使用到版本控制系统。组织一个良好的目录结构是完成一次成功的build所必须的，apache的开源项目的目录结构提供了事实上(de facto)的标准，如非特殊需要，我们可以直接采取那样的目录结构。project_home #项目所在目录 src #源码 java #Java主程序代码 test #Java测试程序代码 conf #manifest声明文件 lib #库文件目录 doc #项目有关说明文档，如果是开源项目，通常该目录下是相应的web content api #生成项目的Java API文档的地方 build #用于创建的临时目录 classes #编译的结果保存在该目录 dist #用于发布的临时目录，通常会将buildclasses下的文件打包成jar，保存在该目录下 README #项目的说明文件 RELEASE #项目的发布文件 LICENSE #项目的license文件 下面是一个和目录有关的配置的例子：编译：1。编译器的选择 对于，除了classic（JDK 1.1/1.2）和modern（JDK 1.3/1.4/1.5），还有不同的编译器可以选择，例如：jikes,jvc,kjc,gcj,sj等等，不过我还没有用过这些编译器，默认的编译器是你用来运行ANT的 JDK 1.X所带的编译器，如果你想使用自己的编译器，需要如下声明，ANT运行的时候会自动用你配置的编译器来编译：2。的语法 编译可以说是ANT里面最基本的任务，首先回顾一下命令行下进行编译的命令：c:hellworldjavac -d buildclasses -classpath %CLASSPATH%;liboutlib.jar -sourcepath src -g 下面是常用的语法列表，并附上对应到javac命令的参数srcdir Java文件所在的目录，相当于javac命令的-sourcepath参数，srcdir也是的隐式(implicit)的FileSet，因此srcdir支持FileSet的所有特征，有关FileSet的用法请参考前面。destdir classes文件输出的目录，相当于javac命令的-d参数debug 生成并输出调试信息，debug=yes相当于javac命令的-g参数，debug=no相当于javac命令的-g:none参数deprecation 输出对于那些使用了deprecation的API的源文件的位置，默认是off，deprecation=on相当于javac命令的-deprecation参数optimize 优化，默认是off，optimize=on相当于javac命令的-o参数fork 使用外部的JDK编译器来运行javac，默认是no，采用yes可以取得更好的效率，当然对机器的要求也高failonerror 如果编译错误，build是否继续，默认是truecompiler 类似于全局的属性piler，不过这里是的attribute而已，直接指定的编译器，用法和piler一样。还有很多attribute，请参考官方文档吧。补充两点：支持隐式的FileSet，支持的所有attribute，不同的是dir在里面是srcdir。 的srcdir, classpath, sourcepath, bootclasspath, 和extdirs attributes都是 path-like 结构，可以完全通过嵌套的 , , , and 元素来代替。例子： 测试和：JUnit是事实上(de facto)的Java单元测试工具，ANT集成了JUnit，可以在build过程中执行test suite，并捕获结果和生成报表，关于JUnit的用法，请查阅有关资料，这里只总结ANT怎么将JUnit集成到Build里面去的方法。发布让我们先看看发布前必须做的一些准备工作：1。撰写文档。2。撰写和平台相关的自启动脚本(bootstrap script)，批处理文件(batch file) ,或者程序。3。撰写安装脚本，使用安装工具。4。检查版本控制系统中和项目相关的源码，文档，以及其他资料。5。将版本控制系统中的源码打上标签。6。运行一次完整的build。7。运行一次完整的测试。8。将软件打包成适当的形式，用于发布和安装。对于打包这个步骤，如下图Data files Java source Documentation | | | | _|_ | | | | | | | | | | | |_| |_| | | jar | | | jar file | |_| | | | | Distribution package 将源码和数据文件打包成JAR，将文档和生成的文档保存在某个目录，然后将整体打包zip或者tar，为不同的平台提供最终的版本以供下载，这就是打包的过程。打包和发布的一个通用的过程是复制和移动文件的过程，在深入打包的细节之前，有必要总结一下ANT里面和复制，移动以及删除有关的任务（这部分内容大部分来自官方文档，经过翻译和整理）。将文件或者FileSet复制到一个新的文件或者目录。FileSet用于指定用于复制的文件集合，如果使用了FileSet，的todir必须指定一个值，支持的常用的attribute如下：attribute | description-|-file | 要复制的文件tofile | 复制到新的文件的文件名todir | 复制到新的目录的目录名overwrite | 默认值为false，也就是只有当被复制的文件比目标文件新的时候才复制， | 如果需要强制覆盖目标文件，需要将overwrite设置为true嵌套用于选择用于复制的文件集合，这个时候需要指定todir下面的例子均选自官方文档例一例二例三 例四 例五 跟的区别是移动而不是复制，语法跟一样，这里不多写了，只提供一些例子：下面的例子均选自官方文档例一例二例三 例四 删除单个文件，单个目录，多个文件，多个目录，支持FileSet，通常在清除build产生的临时文件和目录的时候会用到，一个典型的buildfile一般都会有一个名叫clean的target。支持的最常见的attribute如下：attribute | description-|-file | 指定文件，dir | 指定目录，可以嵌套，但是如果没有指定FileSet，file和dir其中之一必须指定。下面的例子均选自官方文档例一例二例三 例四 例五 补充：关于复制，移动，删除，还有一个重要的用法就是filter，不过我用到的机会不多，所以没有怎么研究过，有关详细的资料请查阅官方文档。发布前还应该准备文档，特别是javadoc文档，是一个非常复杂的task，一共有50多个attribute，幸好只有三个attribute是必须的，那就是sourcepath，sourcefiles，sourcepathref，destdir，对于 sourcepath，sourcefiles，sourcepathref只需要指定其中一个，如果都没有指定，那么必须提供嵌套的, 或者 ，从字面上很容易理解 sourcepath，sourcefiles，sourcepathref是源文件所在的目录，而destdir是生成的javadoc API所在的目录。下面是一些我们常用的attribute，没有必要去死记这些attribute，最好的学习方式是理解它们的意义，然后写一个template，再用到的时候根据需要修改这个template就可以了：attribute | description-|-sou