Ant简介

    技术2022-05-19  19

    Ant简介Ant的概念 可能有些读者并不连接什么是Ant以及入可使用它,但只要使用通过Linux系统得读者,应该知道make这个命令。当编译Linux内核及一些软件的源程序时,经常要用这个命令。Make命令其实就是一个项目管理工具,而Ant所实现功能与此类似。像makegnumakenmake这些编译工具都有一定的缺陷,但是Ant却克服了这些工具的缺陷。最初Ant开发者在开发跨平台的应用时,用样也是基于这些缺陷对Ant做了更好的设计。

    Ant makefile Makefile有一些不足之处,比如很多人都会碰到的烦人的Tab问题。最初的Ant开发者多次强调只是我在Tab前面加了一个空格,所以我的命令就不能执行。有一些工具在一定程度上解决了这个问题,但还是有很多其他的问题。Ant则与一般基于命令的工具有所不同,它是Java类的扩展。Ant运行需要的XML格式的文件不是Shell命令文件。它是由一个Project组成的,而一个Project又可分成可多targettarget再细分又分成很多task,每一个task都是通过一个实现特定接口的java类来完成的。

    Ant的优点

    AntApache软件基金会JAKARTA目录中的一个子项目,它有以下的优点。 跨平台性。Ant是存Java语言编写的,所示具有很好的跨平台性。 操作简单。Ant是由一个内置任务和可选任务组成的。Ant运行时需要一个XML文件(构建文件)Ant通过调用target树,就可以执行各种task。每个task实现了特定接口对象。由于Ant构建文件时XML格式的文件,所以和容易维护和书写,而且结构很清晰。 Ant可以集成到开发环境中。由于Ant的跨平台性和操作简单的特点,它很容易集成到一些开发环境中去。

    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表示项目的描述。 Antdepends属性指定了target的执行顺序。Ant会依照depends属性中target出现顺序依次执行每个target。在执行之前,首先需要执行它所依赖的target。程序中的名为runtarget

    depends属性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 ,执行默认的目标。

     

     

    4. 编写build.xml  


        

    Antbuildfile是用XML写的。每个buildfile含有一个projectbuildfile中每个task元素可以有一个id属性,可以用这个id值引用指定的任务。这个值必须是唯一的。(详情请参考下面的Task小节)Projectsproject有下面的属性:

    Attribute

    Description

    Required

    name

    项目名称.

    No

    default

    当没有指定target时使用的缺省target

    Yes

    basedir

    用于计算所有其他路径的基路径。该属性可以被basedir property覆盖。当覆盖时,该属性被忽略。如果属性和basedir property都没有设定,就使用buildfile文件的父目录。

    No

    项目的描述以一个顶级的<description>元素的形式出现(参看description小节)。一个项目可以定义一个或多个target。一个target是一系列你想要执行的。执行Ant时,你可以选择执行那个target。当没有给定target时,使用projectdefault属性所确定的targetTargets一个target可以依赖于其他的target。例如,你可能会有一个target用于编译程序,一个target用于生成可执行文件。你在生成可执行文件之前必须先编译通过,所以生成可执行文件的target依赖于编译targetAnt会处理这种依赖关系。然而,应当注意到,Antdepends属性只指定了target应该被执行的顺序-如果被依赖的target无法运行,这种depends对于指定了依赖关系的target就没有影响。Ant会依照depends属性中target出现的顺序(从左到右)依次执行每个target。然而,要记住的是只要某个target依赖于一个target,后者就会被先执行。

    <target name="A"/><target name="B" depends="A"/><target name="C" depends="B"/><target name="D" depends="C,B,A"/>

    假定我们要执行target D。从它的依赖属性来看,你可能认为先执行C,然后B,最后A被执行。错了,C依赖于BB依赖于A,所以先执行A,然后B,然后C,最后D被执行。一个target只能被执行一次,即时有多个target依赖于它(看上面的例子)。如果(或如果不)某些属性被设定,才执行某个target。这样,允许根据系统的状态(java version, OS, 命令行属性定义等等)来更好地控制build的过程。要想让一个target这样做,你就应该在target元素中,加入if(或unless)属性,带上target因该有所判断的属性。例如:

    <target name="build-module-A" if="module-A-present"/><target name="build-own-fake-module-A" unless="module-A-present"/>

    如果没有ifunless属性,target总会被执行。可选的description属性可用来提供关于target的一行描述,这些描述可由-projecthelp命令行选项输出。将你的tstamp task在一个所谓的初始化target是很好的做法,其他的target依赖这个初始化target。要确保初始化target是出现在其他target依赖表中的第一个target。在本手册中大多数的初始化target的名字是"init"target有下面的属性:

    Attribute

    Description

    Required

    name

    target的名字

    Yes

    depends

    用逗号分隔的target的名字列表,也就是依赖表。

    No

    if

    执行target所需要设定的属性名。

    No

    unless

    执行target需要清除设定的属性名。

    No

    description

    关于target功能的简短描述。

    No

    Tasks一个task是一段可执行的代码。一个task可以有多个属性(如果你愿意的话,可以将其称之为变量)。属性只可能包含对property的引用。这些引用会在task执行前被解析。下面是Task的一般构造形式:

    <name attribute1="value1" attribute2="value2" ... />

    这里nametask的名字,attributeN是属性名,valueN是属性值。有一套内置的(built-intask,以及一些可选task,但你也可以编写自己的task所有的task都有一个task名字属性。Ant用属性值来产生日志信息。可以给task赋一个id属性:

    <taskname id="taskID" ... />

    这里tasknametask的名字,而taskID是这个task的唯一标识符。通过这个标识符,你可以在脚本中引用相应的task。例如,在脚本中你可以这样:

    <script ... >task1.setFoo("bar");</script>

    设定某个task实例的foo属性。在另一个task中(用java编写),你可以利用下面的语句存取相应的实例。

    project.getReference("task1").

    注意1:如果task1还没有运行,就不会被生效(例如:不设定属性),如果你在随后配置它,你所作的一切都会被覆盖。注意2:未来的Ant版本可能不会兼容这里所提的属性,因为很有可能根本没有task实例,只有proxiesProperties一个project可以有很多的properties。可以在buildfile中用property task来设定,或在Ant之外设定。一个property有一个名字和一个值。property可用于task的属性值。这是通过将属性名放在"${""}"之间并放在属性值的位置来实现的。例如如果有一个property builddir的值是"build",这个property就可用于属性值:${builddir}/classes。这个值就可被解析为build/classes内置属性如果你使用了<property> task 定义了所有的系统属性,Ant允许你使用这些属性。例如,${os.name}对应操作系统的名字。要想得到系统属性的列表可参考the Javadoc of System.getProperties除了Java的系统属性,Ant还定义了一些自己的内置属性:     

     basedir   project基目录的绝对路径 (<project>basedir属性一样)

     ant.file   buildfile的绝对路径。

     ant.version  Ant的版本。

     ant.project.name  当前执行的project的名字;由<project>name属性设定.

     ant.java.version  Ant检测到的JVM的版本; 目前的值有"1.1", "1.2", "1.3" and "1.4".

        

    例子

    <project name="MyProject" default="dist" basedir="."> 

     

     <!-- set global properties for this build -->

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

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

     <property name="dist" value="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">

      <!-- Compile the java code from ${src} into ${build} -->

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

     </target>

     

     <target name="dist" depends="compile">

      <!-- 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">

      <!-- Delete the ${build} and ${dist} directory trees -->

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

      <delete dir="${dist}"/>

     </target>

     

    </project>

    Token Filters一个project可以有很多tokens,这些tokens在文件拷贝时会被自动扩展,这要求在支持这一行为的task中选择过滤拷贝功能。这一功能可用filter taskbuildfile中设定。既然这很可能是一个有危害的行为,文件中的tokens必须采取@token@的形式,这里tokenfilter task中设定的token名。这种token语法与其他build系统执行类似filtering的语法相同,而且与大多数的编程和脚本语言以及文档系统并不冲突,注意:如果在一个文件中发现了一个@token@形式的token,但没有filter与这个token关连,则不会发生任何事;因此,没有转义方法-但只要你为token选择合适的名字,就不会产生问题。警告:如果你在拷贝binary文件时打开filtering功能,你有可能破坏文件。这个功能只针对文本文件。Path-like Structures你可以用":"";"作为分隔符,指定类似PATHCLASSPATH的引用。Ant会把分隔符转换为当前系统所用的分隔符。当需要指定类似路径的值时,可以使用嵌套元素。一般的形式是

     <classpath>

      <pathelement path="${classpath}"/>

      <pathelement location="lib/helper.jar"/>

     </classpath>

    location属性指定了相对于project基目录的一个文件和目录,而path属性接受逗号或分号分隔的一个位置列表。path属性一般用作预定义的路径--其他情况下,应该用多个location属性。为简洁起见,classpath标签支持自己的pathlocation属性。所以:

     <classpath>

      <pathelement path="${classpath}"/>

     </classpath>

    可以被简写作:

     <classpath path="${classpath}"/>

    也可通过<fileset>元素指定路径。构成一个fileset的多个文件加入path-like structure的顺序是未定的。

     <classpath>

      <pathelement path="${classpath}"/>

      <fileset dir="lib">

       <include name="**/*.jar"/>

      </fileset>

      <pathelement location="classes"/>

     </classpath>

    上面的例子构造了一个路径值包括:${classpath}的路径,跟着lib目录下的所有jar文件,接着是classes目录。如果你想在多个task中使用相同的path-like structure,你可以用<path>元素定义他们(与target同级),然后通过id属性引用--参考Referencs例子。path-like structure可能包括对另一个path-like structurede的引用(通过嵌套<path>元素):

     <path id="base.path">

      <pathelement path="${classpath}"/>

      <fileset dir="lib">

       <include name="**/*.jar"/>

      </fileset>

     <pathelement location="classes"/>

     </path>

      <path id="tests.path">

      <path refid="base.path"/>

      <pathelement location="testclasses"/>

     </path>

    前面所提的关于<classpath>的简洁写法对于<path>也是有效的,如:

     <path id="tests.path">

        <path refid="base.path"/>

      <pathelement location="testclasses"/>

     </path>

    可写成:

     <path id="base.path" path="${classpath}"/>

    命令行变量有些task可接受参数,并将其传递给另一个进程。为了能在变量中包含空格字符,可使用嵌套的arg元素。

    Attribute

    Description

    Required

    value

    一个命令行变量;可包含空格字符。

    只能用一个

    line

    空格分隔的命令行变量列表。

    file

    作为命令行变量的文件名;会被文件的绝对名替代。

    path

    一个作为单个命令行变量的path-like的字符串;或作为分隔符,Ant会将其转变为特定平台的分隔符。

    例子

     <arg value="-l -a"/>

    是一个含有空格的单个的命令行变量。

     <arg line="-l -a"/>

    是两个空格分隔的命令行变量。

     <arg path="/dir;/dir2:/dir3"/>

    是一个命令行变量,其值在DOS系统上为/dir;/dir2;/dir3;在Unix系统上为/dir:/dir2:/dir3 Referencesbuildfile元素的id属性可用来引用这些元素。如果你需要一遍遍的复制相同的XML代码块,这一属性就很有用--如多次使用<classpath>结构。下面的例子:

     <project ... >

      <target ... >    

       <rmic ...>      

        <classpath>        

         <pathelement location="lib/"/>        

         <pathelement path="${java.class.path}/"/>        

         <pathelement path="${additional.path}"/>      

        </classpath>    

       </rmic>  

      </target>

      <target ... >

       <javac ...>

        <classpath>

         <pathelement location="lib/"/>

         <pathelement path="${java.class.path}/"/>

         <pathelement path="${additional.path}"/>

        </classpath>

       </javac>

      </target>

     </project>

    可以写成如下形式:

     <project ... > 

      <path id="project.class.path">  

       <pathelement location="lib/"/>

       <pathelement path="${java.class.path}/"/>   

       <pathelement path="${additional.path}"/> 

      </path>

      <target ... >

       <rmic ...>

        <classpath refid="project.class.path"/>

       </rmic>

      </target>

      <target ... > 

       <javac ...>

        <classpath refid="project.class.path"/>

       </javac>

      </target>

     </project>

    所有使用PatternSets, FileSets  path-like structures嵌套元素的task也接受这种类型的引用。

     

     


    最新回复(0)