Ant学习-基础入门

一、              Ant 与 Makefile :

  GNU Make 缺乏平台无关性，为了调用一个 Java 类，必须用命令行 java 调用 JVM, 再将类名作为命令行参数进行传递

  Makefile 的 tab 问题

  Make 不能使用 Java 工具的任何库

  Ant 与一般的基于命令的工具不同，它是 Java 类的扩展， Ant 运行需要的 Xml 格式的文件而不是 Shell 命令文件，它是由一个 Project 组成，而一个 Project 又可以分成多个 Target ， target 再细分成许多 task, 每一个 task 都是通过一个实现特定接口的 java 类完成

二、              Ant 开发

Ant 构建文件默认命名为 build.xml ，也可以取其他的名字。只不过在运行的时候把这个命名当作参数传给 Ant 。

1)         一个典型的项目层次结构

a)         src 存放文件

b)         class 存放编译后的文件

c)         lib 存放第三方 jar 包

d)         dist 存放打包，发布以后的代码

2)         标签说明

a)         <project>

                                                     i.              default 表示默认的运行目标，这个属性是必须 的

                                                   ii.              basedir 表示项目的基准目录

                                                  iii.              name 表示项目名

                                                  iv.              description 表示项目的描述

b)         <target>

                                                     i.              name 表示表明，这个属性是必须 的

                                                   ii.              depends 表示依赖的目标

                                                  iii.              unless 表示当属性没有设置时才执行

                                                  iv.              description 表示项目的描述

c)         <mkdir>

<mkdir dir=”${class.root}”/>

d)         <jar>

                                                                   i.              destfile 表示 jar 文件名

                                                                 ii.              basedir 表示被归档的文件名

                                                                iii.              include 表示被归档的文件模式

                                                                iv.              exclueds 表示被排除的文件模式

e)         <javac>

                                                                   i.              srcdir 表示源文件的目录

                                                                 ii.              destdir 表示 class 文件的输出目录

                                                                iii.              include 表示被编译的文件的模式

                                                                iv.              excludes 表示被排除的文件的模式

                                                                 v.              classpath 表示使用的类路径

                                                                vi.              debug 表示包含的调试信息

                                                              vii.              optimize 表示是否使用优化

                                                             viii.              verbose 表示提供详细的输出信息

                                                                ix.              fileonerror 表示当碰到错误就自动停止

f)          <delete>

                                                                   i.              file 表示要删除的文件

                                                                 ii.              dir 表示要删除的目录

                                                                iii.              includEmptyDirs 表示是否要删除空目录，默认值是删除

                                                                iv.              failonerror 表示指定当碰到错误是否停止，默认值是自动停止

                                                                 v.              verbose 是否列出所删除的文件，默认是不列出

g)         <java>

                                                                   i.              classname 表示将执行是类名

                                                                 ii.              jar 表示包含该类的 jar 文件名

                                                                iii.              classpath 所表示用到类路径

                                                                iv.              fork 表示一个新的虚拟中运行该类

                                                                 v.              failonerror 表示当出现错误时自动停止

                                                                vi.              output 表示输出文件

                                                              vii.              append 表示追加或者覆盖默认文件

h)         <copy>

                                                                   i.              file 表示源文件

                                                                 ii.              tofile 表示目标文件

                                                                iii.              todir 表示目标目录

                                                                iv.              overwrite 表示指定是否覆盖目标文件，默认值是不覆盖

                                                                 v.              includeEmptyDirs 表示指定是否拷贝空目录，默认是拷贝

                                                                vi.              failonerror 表示指定如目标没有发现是否自动台停止，默认是停止

                                                              vii.              verbose 表示是否显示详细信息，默认值不显示

3)         数据结构 ( 包含在 org.apache.tool.ant.types 包中

a)         argument 类型： 文件调用的程序，用于 apply,exec,java 任务

                                                     i.              value 是一个命令参数（如果参数中有空格，又想作为单独的一个值使用）

                                                   ii.              file 一个参数的文件名，相当于当前工作目录

                                                  iii.              line 表示用空格分隔的多个参数列表

                                                  iv.              path 表示路径

b)         environment 类型 : 文件调用的外部命令程序，指定哪些参数要传递给正在执行的系统命令

                                                     i.              file 表示环境变量值的文件名，这个文件名要转换为一个绝对路径

                                                   ii.              path 表示环境变量的路径， ant 会把它转换为一个本地约定

                                                  iii.              value 表示环境变量的一个直接变量

                                                  iv.              key 表示环境变量名

注意 : path 和 value 只能选其一

c)         filelist 类型 : 支持命名的文件列表的数据类型，包含在 filelist 中的文件名不一定是存在的文件

                                                     i.              dir 用于计算绝对文件名的目录

                                                   ii.              files 用逗号分隔开的文件名列表

                                                  iii.              refid 对某处定义的一个 <filelist> 的引用

                                                  iv.              注意： dir 和 files 是必须的，除非指定了 refid （这种情况下， dir 和 files 都不能使用）

d)         fileset 类型：

                                                                   i.              dir 表示 fileset 的基目录

                                                                 ii.              casesensitive 如果为 false ，那么匹配文件名时，不分大小写，默认是 true

                                                                iii.              defaultexcludes 用来确定是否使用默认的排除模式，默认是 true

                                                                iv.              exclues 用逗号分隔开的，需要排除的文件模式列表

                                                                 v.              excludesfiles 表示每行包含一个排除模式的文件的文件名

                                                                vi.              includes 用逗号分隔开，需要包含的文件模式列表

                                                              vii.              includesfile 表示每行包括一个包含模式的文件的文件名

e)         patternset 元素：对模式分组

includes,excludes,includesfile,excludesfile,

f)          filterset 元素：在文件移动的过程中或者复制时完成文件的文本替换

                                                                   i.              begintoken

                                                                 ii.              endtoken

                                                                iii.              id 过滤器唯一标识符

                                                                iv.              refid 表示构建文件中某处定义一个过滤器的引用

g)         path 类型：

                                                                   i.              location 表示一个文件或目录

                                                                 ii.              refid 表示构建文件中某处定义一个 path 的引用

h)         mapper 类型：定义一组输入文件和输出文件间的关系

                                                                   i.              classname 表示实现 mapper 的类名，用于定制

                                                                 ii.              classpath 表示查找一个定制 mapper 时使用的类型路径

                                                                iii.              classpathref 对某处一个类路径的引用

                                                                iv.              from 取决于所用的 mapper

                                                                 v.              to 取决于所用的 mapper

                                                                vi.              type ： identity,flatten glob merge regexp 其中之一，定义内置 mapper 类型

三、              术语

a)         标签（ tag ）指的是构建文件中由括号扩起来的标记

b)         元素（ element ）是标签及其孩子

c)         任务（ task ）完成操作，并相当于 Ant 引擎中的模块部件

d)         DataType 则为 Ant 引擎定义了复杂的数据分组通常是路径或文件集

四、              最简单的实例

<?xml version ="1.0"?>

<!-- build.xml - a simple Ant buildfile -->

<project name="Simple Buildfile" default="compile" basedir=".">

<!-- The directory containing source code -->

<property name="src.dir" value="src"/>



<!-- Temporary build directory -->

<property name="build.dir" value="build"/>

<property name="build.classes" value="${build}/classes"/>

<property name="build.lib" value="${build}/lib"/>



<!-- Target to create the build directories prior to the compile target -->

<target name="prepare">

<mkdir dir="${build.dir}"/>

<mkdir dir="${build.classes}"/>

<mkdir dir="${build.lib}"/>

</target>



<target name="clean" description="Remove all generated files.">

<delete dir="${build.dir}"/>

</target>



<target name="compile" depends="prepare" description="Compiles all source code">

  <javac srcdir="${src.dir}" destdir="${build.classes}"/>

</target>



<target name="jar" depends="compile" description="Generate oreilly.jar in the 'dist' directory">

<!-- Exclude unit tests from the final JAR file -->

<jar jarfile="${build.lib}/oreilly.jar" basedir="${build.classes}" excludes="**/*Test.class"/>

</target>

<target name="all" depends="clean,jar" description="Clean ,compiles,the builds the JAR file."/>

</project>

注意：第一行为 xml 声明，在其之前不允许出现空行

      Xml 对大小写，引号，正确的标签语法很挑剔。

五、              Ant 命令行参考

a)           ant [option [option…]][target [target…]]

b)         option ： ={ -help

            |=-projecthelp

            |=-version

            |=-quiet

            |=-verbose

            |=-emacs

            |=-logfile filename

            |=-logger classname

            |=-listener classname

            |=-buildfile filename

            |=-Dproperty=value

            |=-find filename}





六、              ant 对构建语法的要求 :

a)         首先，此语法对新用户必须简单，从而使他们容易上手

b)         必须有可用的 Java 库，这样新的基于 Java 的构建引擎才可以很容易的实现和维护

c)         新的构建引擎应该不需要重新写一个语法解析程序 — 现有库是最重要的

d)         能够表示一种层次树的构建结构

e)         能用组件和包的方式描述构建，还同时能用操作的方式来描述

七、              经验

a)         目标为粗粒度的操作更为合适，任务可以比目标更好地解决细粒度问题。编写构建文件时候，维护一致的粒度，你会得到更好的结果。

b)         设计和实现一个工程结构绝非易事，因此不要任务仅花一小时就能很好的完成了工作，这个工作并不困难，但相当繁琐。大多数 java 程序都有跨平台功能，你在考虑如何组织工程时应该记住这个目标，以往只会考虑到不同操作系统和不同硬件配置之间的情况，不过在开发小组中不同的平台还意味着异构工作站之间小到工具集的差别，功能要做到明显分离，要能够做到自包含，而且没有外来的需求，这些都应作为 java 工程的目标。

c)         由你的构建创建一组可部署的目录和包文件，然后先停下来，此时你可以查看将如何安装应用，并确定是否可以继续

d)         不适合将 ant 当成脚本语言

                         i.              没有数据结构

                       ii.              缺乏 DTD

1.         由于 ant 使用了一种有着定义完善的语法规则的语言，所以他必须总是遵循这些规则：它通过使用现有的 xml 库来加载构建文件，从而实现这一点。构建文件只有在得到加载时才被认为是“良构”的。再来分析这句话， ant 不验证文件的完整性，而是在读取 xml 元素时才对他们进行验证，另外，“语法上正确“与“良构”不是同一个概念。为了加载时候做到语法上正确， xml 需要有一个响应的 DTD ，但是它没有，而且不能有，作为补偿， ant 在 xml 中做迭代处理，仅仅解析和执行那些需要执行的元素，并在此过程中检查器语法。这样做有一个好处，即可以使 ant 更快，因为如果试图做完全的语法检查， ant 就会很慢。而且更有可能的是，作为一个需要大量内存的程序，它还会比现在需要更多内存。

2.         理论上不能有一个 DTD ，由于定制的任务模型， ant 的构建文件 DTD 应当随每个新的任务而有所改变，创建一个 DTD 的任务是存在的（ antstructure ） , 但它仅仅创建了核心任务模型的 DTD ，另外它会忽略任务所需的属性。

                      iii.              没有流控制

1.         没有定制任务的概念， ant 的生命力就不会这么强

八、              任务

a)         构建文件中的最小构建块，它们解决构建中更小粒度的目标，这些任务完成具体工作，包括编译源代码，对类打包，由 CVS 获取修订情况或者是复制文件和目录。 Ant 不像其他一些构建工具那样提供对底层 shell 的直接通道，而是将所有操作包装成任务定义。每个任务对应为 ant 对象模型中的一个 Java 对象。在 ant 中不存在没有相应对象的任务。比较而言， shell 不仅可以运行可执行程序还可以运行不对应为可执行程序的命令。“每个任务都是对象”这种体系结构为 ant 提供了灵活的扩展性。

九、              数据元素

a)         特性

                         i.              在构建文件中由 <property> 标签表示的名值对

                       ii.              其值是类型不可见的，总是字符串。

b)         DataType ：如 fileset

                         i.                一类表示复杂数据集合的元素

c)         数据元素（ data element ）

                         i.              这个词覆盖了特性和 DataType

十、              设计构建文件

a)         构建文件如何开始？

                         i.              所有的构建文件都由一个工程描述文件 (project descriptor) 开始，它指定了诸如工程名，默认的构建文件目标以及工程基目录等内容

                       ii.              应该定义那些特性和 DataType 以用于整个构建中？

1.         所有的工程目录是由根工程目录展开，这样所有与目录相关的数据元素都应当是相对的。我们为每个主要的子目录定义一个特性，并根据它的作用为之命名。这样做可以保证如果目录名有所调整，那么只需在构建文件中修改一处即可

                      iii.              在对目标进行编译或打包之前，需要创建哪些目录？

                      iv.              要编译这个工程，需要回答几个问题：

1.         整个程序又哪些内容组成

2.         库的情况如何

3.         用于安装或执行的脚本是怎样的

4.         静态的和生成的文档是怎样的？

5.         清除

a)         修改文件后如何重新构建工程

b)         需要修改所有的类文件吗？

c)         需要删除所生成的 Jar 吗？

                                                                   i.              Java 编译器的依赖关系检查程序并不能很好的确定类之间的每个依赖关系，而且，为了完成其自己的依赖关系检查 ,javadoc 任务要对已编译的类文件进行时间栈检查。尽管大多数情况下是有效的，但时间栈检查并不是最佳的。对于无依赖关系的类，带有静态最终处理的类，以及其他特殊情况，即使编译步骤遗漏了某些类，仍可能导致成功的构建。正因为如此，开发人员应该总是能够将构建过程中生成的所有内容都予以删除，并重新开始构建，只有这样才能保证所有需要编译的内容确实得到编译。（干净的构建）

                                                                 ii.              可能需要在工程的构建文件中包含一个 distribution clean 目标，这个目标会删除所有生成的文件，目录，以及所有的源代码。这对于处于版本控制下的过程来说是非常有用的。如果你的工程不在版本控制之下，就不要删除源代码。

6.         发布

a)         在应用准备发布之前，需要创建哪些目录

b)         是否需要将源代码与应用同时发布

c)         应用的发布由哪些内容组成

7.         工程级数据元素：定义目录的特性，对应于 javac 任务的全局属性，作为一个 path DataType 的编译类路径

a)         特性有两个主要特点：

                                                                   i.              他们是不可变的，且不论在哪里定义，总是有全局作用域

                                                                 ii.              级联构建文件

1.         可以改变特性不可变性和作用域的规则

b)         DataType 不同于特性，只在同一个构建文件中起作用

十一、       Ant DataType

a)         Fileset 定义一个文件的命名列表，这些文件必须确实存在

                         i.              Dir fileset 的及目录

                       ii.              Casesensitive 匹配文件名时是否区分大小写

                      iii.              Defaultexcludes 确定是否使用默认的排除方式 , 默认为 true （默认的排除模式： **/*~,**/#*#,**/%*%,**/CVS,**/CVS/**,**/.cvsignore,**/SCCS,**/SCCS/** 和 **/vssver.scc ）

                      iv.              Excludes 用逗号分隔的需要排除的文件模式列表（对默认的补充）

                       v.              Excluesfile 每行包括一个排除模式的文件的文件名（对默认的补充）

                      vi.              Includes 用逗号分隔的需要包含的文件模式列表

                    vii.              Includesfile 每行包括一个包含模式的文件的文件名

                   viii.              示例

1.         <fileset id=”sources1” dir=”src” includes=”**/*.java”> </fileset>

2.         <fileset id=”source2” dir=”src”>

  <include name=”**/*.java”>

      <exclude name=”**/test/**/*.java”/>

</fileset>

3.         <fileset id=”source3” dir=”src” >

<patternset>

<include name=”**/*.java”/>

<exclude name=”**/test/**/*.java”/>

</patternset>

</fileset>

4.         <patternset id=”non.test.source”>

<include name=”**/*.java”/>

<exclude name=”**/test/**/*.java”/>

</patternset>

<fileset id=”sources4” dir=”src”>

<patternset refid=”non.test.source”/>

</fileset>

<fileset id=”sources5” dir=”othersrc”>

<patternset refid=”non.test.source”/>

</fileset>

b)         Argument 对于一个由 Ant 构建文件调用的程序，向其传递命令行参数

                         i.              File 作为一个参数的文件名，在构建文件中，此文件名相对于当前的工作目录，作为一个参数传递时，此文件名要转换为一个绝对路径

                       ii.              Line 用空格分隔的多个参数列表

                      iii.              Path 路径

                      iv.              Value 一个命令行参数，如果你的参数中有空格但又想作为单独的一个值，则用此属性

                       v.              至少取一个

c)         Environment 对于由 ant 构建文件调用的外部命令或程序，指定向其传递的环境变量

                         i.              File

                       ii.              Key 环境变量名

                      iii.              Path 作为环境变量的路径， ant 会将它转换为一个本地约定

                      iv.              Value 环境变量的一个直接量值

                       v.              File.path 或 value 只取其一

                      vi.              <property environment=”env”/> 之后，通过在变量名前加上前缀“ env. ”可以引用任何环境变量

d)         Filelist 定义一个文件的命名列表，这些文件无需确实存在

                         i.              Files 用逗号分隔的文件名列表

                       ii.              Refid 对某处定义的一个 <filelist> 的引用

                      iii.              Dir 用于计算绝对文件名的目录

                      iv.              Dir,files 都是必要的，除非指定了 refid （此时 dir 和 files 都不能使用）

e)         Patternset 将一组模式分组在一起

                         i.              Includes

                       ii.              Excludes

                      iii.              Includesfile

                      iv.              Excluesfile

                       v.              都支持以下属性

1.         name 包含和排除模式的文件的文件名

2.         if 只有设置了该特性 ant 才读取

3.         unless 只有未设置该特性时 ant 才读取

f)          Filterset 将一组过滤器分组在一起

                         i.              记号过滤器

                       ii.              可能作为 copy 和 move 任务中嵌套的内容出现，或者作为目标级构建文件元素出现

                      iii.              Begintoken, 默认为 @

                      iv.              Endtoken 默认为 @

                       v.              Id 唯一标识符

                      vi.              Refid 过滤器引用

                    vii.              嵌套元素

1.         filter

a)         token ，指定要替换的记号，不包括定界符

b)         value 指定遇到记号时的替换文本

2.         filtersfile

a)         file 包含过滤器的特性文件的文件名

g)         Path 以某种在不同操作系统间可移植的方式指定路径（如类路径）

                         i.              Location 表示一个文件或目录， ant 内部将其扩展为一个绝对文件名

                       ii.              Path 一个文件和路径名列表，并以；或：分隔

                      iii.              Refid 对当前构建文件中某处定义的一个 path 的引用

                      iv.              Location 和 path 均是可选的，除非指定了 refid （这种情况下， location 和 path 都不可用）

                       v.              嵌套元素

1.         pathelement

2.         fileset

3.         path

h)         Mapper 定义一组输入文件和一组输出文件间的一个复杂关系

                         i.              Classname 实现 mapper 类的类名

                       ii.              Classpath 查找一个定制 mapper 时所用的类路径

                      iii.              Classpathref 对某处定义的一个类路径的引用

                      iv.              From 此属性含义取决于所用的 mapper

                       v.              Refid 对另一个 mapper 的引用，如果指定了它，这应当是唯一所列的属性

                      vi.              To 此属性含义取决于所用的 mapper

                    vii.              Type 取值为 identity,flatten,glob,merge 或 regexp 其中一个

                   viii.              Identity mapper 将源文件与同名的目标文件进行匹配

                      ix.              Flatten mapper 从文件名中删除所有路径信息

                       x.              Glob 基于简单的通配模式确定目标文件名

                      xi.              Merge mapper 将所有源文件名与 to 属性所指定的相同目标文件相匹配。 From 属性将被忽略。如果想比较一组源文件和某个目标文件的时间栈 ,merge mapper 就很有用，这正是 uptodate 任务的工作

                    xii.              Regexp mapper 类似于 glob mapper ，不过是使用正则表达式而不是简单的 * 字符

i)           类结构

j)           包含排除模式语法 :

                         i.              * 与 0 或多个字符相匹配

                       ii.              ? 与 1 个字符相匹配

                      iii.              ** 与 0 个或多个目录相匹配