ANT

一、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依赖于编译程序的target。Target的所有属性如下。
(1).name表示标明，这个属性是必须的。
(2).depends表示依赖的目标。
(3)if表示仅当属性设置时才执行。
(4)unless表示当属性没有设置时才执行。
(5)description表示项目的描述。
Ant的depends属性指定了target的执行顺序。Ant会依照depends属性中target出现顺序依次执行

每个target。在执行之前，首先需要执行它所依赖的target。程序中的名为run的target的

depends属性compile，而名为compile的target的depends属性是prepare，所以这几个target执

行的顺序是prepare->compile->run。
一个target只能被执行一次，即使有多个target依赖于它。如果没有if或unless属性，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,exec和java任

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

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属性的取值为identity，flatten glob merge   regexp   其中之一，它定义了要是用的


内置mapper的类型。

9.tstamp
<tstamp/>的作用就是Sets the DSTAMP, TSTAMP, and TODAY properties in the current project,
 based on the current date and time.然后，在build file的其他地方使用DSTAMP,TSTAMP,TODAY
 三个属性.当然,如果在build file的其他地方不使用DSTAMP,TSTAMP,TODAY这三个属性.那么
 <tstamp/>其实就相当于没有用了 。

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

示例：

<?xml version="1.0" ?>
<!--  
     默认任务 default 可以指定直接执行ant
     命令的时候默认的任务可以通过指定任务
    名称(target name)运行不同的任务 比如:
    ant package
-->
<project name="tax-calculator" default="package">
    <!--  
        设置property 可以在其他地方通过${xxx}
         的方式引用 也可以通过 property file设
        置具体的properties文件 这里有个优先级
        的问题 首先你可以在执行ant命令 这个优
        先级是最大的 其次的是properties 文件
        中的属性 最后的优先级是写在build.xml
        中的property(很怪)
    -->
    <property name="project.name" value="exampleant" />
    <property name="project.version" value="snapshot" />
    <property name="base.dir" value="." />
    <property name="dist.dir" value="${base.dir}/dist" />
    <property name="testlog.dir" value="${base.dir}/testlog" />
    <property name="testlog.html.dir" value="${testlog.dir}/html" />
    <property name="source.dir" value="${base.dir}/src" />
    <property name="build.dir" value="${base.dir}/build" />
     
    <property name="source.main.dir" value="${source.dir}/main" />
    <property name="source.test.dir" value="${source.dir}/test" />
    <property name="build.classes.dir" value="${build.dir}/classes" />
    <property name="build.test.classes.dir" value="${build.dir}/test-classes" />
    <property name="lib.dir" value="${base.dir}/lib" />
 
    <!-- 
        输出当前环境的信息              
    -->
    <target name="display-properties">
        <echoproperties />
    </target>
 
    <!--
        设置类路径
    -->
    <path id="compile.classpath">
        <fileset dir="${lib.dir}" includes="*.jar" />
        <pathelement path="${build.classes.dir}" />
    </path>
 
    <path id="test.compile.classpath">
        <path refid="compile.classpath" />
        <pathelement path="${build.test.classes.dir}" />
    </path>
    <!--
        target    任务
            name:任务名称
            depends:前置任务(强调该任务执行前必须执行depends指定的任务)
            description:描述
    -->
     
    <!-- 
        mkdir
            dir:目录信息
    -->
    <target name="init">
        <mkdir dir="${build.classes.dir}" />
        <mkdir dir="${build.test.classes.dir}" />
        <mkdir dir="${dist.dir}" />
        <mkdir dir="${testlog.html.dir}"/>
    </target>
 
    <!--
        javac    编译Java源文件
            srcdir:源文件目录 
            destdir:输出目录
            includes:告诉Ant编译过程中编译哪些位置的源文件(其他位置被忽视)
            excludes:告诉Ant编译过程中忽略那些位置的源文件
            debug:是否开启调试信息
            source:强调开发源代码的JDK版本
            target:强调编译后的Class文件应该支持的JDK版本
            compiler:指定编译器(不一定非得使用Sun的标准编译器进行编译)
    -->
    <target name="compile" depends="init" description="Compile Java code">
        <javac srcdir="${source.main.dir}/resources" destdir="${build.classes.dir}" source="1.6" target="1.6" debug="true" includes="com.javapowertools.taxcalculator.**" />
        <javac srcdir="${source.main.dir}/java" destdir="${build.classes.dir}" />
    </target>
 
    <target name="compile-test" depends="compile" description="Compile Unit Tests">
        <javac srcdir="${source.test.dir}/resources" classpathref="test.compile.classpath" destdir="${build.test.classes.dir}" />
        <javac srcdir="${source.test.dir}/java" classpathref="test.compile.classpath" destdir="${build.test.classes.dir}" />
    </target>
 
    <!--
        jar        打包Java文件
            destfile:指定输出文件
            basedir:类文件所在位置
    -->
    <target name="package" depends="compile,test,test-report" description="Create Jar file">
        <jar destfile="${dist.dir}/${project.name}-${project.version}.jar" basedir="${build.classes.dir}" />
    </target>
     
    <!-- 
        junit    单元测试
            printsummary:是否显示单元测试类列表,如果是否的话Ant将运行测试但不显示测试结果,除非有单元测试失败
            haltonfailure:是否测试失败就停止构建,默认为否,也就是即使测试失败也继续构建 
            fork:是否重新启用一个JVM进程进行测试(默认为false 正常情况下重新启用一个JVM进程进行测试会有意想不到的效果)
             
            assertions    指定断言机制
                enable    该属性为所有非系统类激活断言
                    package:指定某一个包下的类激活断言
                    class:指定具体某一个类激活断言
                     
                 
            test    指定单元测试的类
                name:类名
                 
            batchtest    批量测试
             
                todir:指定日志输出目录
                 
                fileset    文件信息
                    dir:所在目录
                    includes:包含的测试类
            formatter    指定详细信息输出格式
             
                type:有三种格式    brief只提供失败测试的详细信息    plain提供了通过的和失败的测试数量,并列出实际成功的测试
                     xml则用于生成报告
                usefile:是否创建文件,默认为true
    -->
    <target name="test" depends="compile-test" description="Run unit tests">
        <junit printsummary="true" haltonfailure="false" fork="false" failureproperty="test.failures">
            <assertions>
                <enable/>
            </assertions>
            <classpath refid="test.compile.classpath" />
            <formatter type="xml" usefile="true" />
            <!--
                <test name="com.javapowertools.taxcalculator.TaxRateTest" />
            -->
            <batchtest todir="${testlog.dir}">
                <fileset dir="${build.test.classes.dir}" includes="**/*Test.class" />
            </batchtest>
        </junit>
    </target>
     
    <!-- 
        关于生成测试报告的建议
            如果开发人员选择了生成测试报告 也就表示不能在测试出现问题的时候简单的停止构建(这样会影响报告的完整性)
            但是将haltonfailure属性设置为true并不是好的解决方式,另一方面,如果测试失败就停止构建是个好主意,
            事实上持续构建系统是依赖这一点的
            解决方式参考Java开发超级工具集中文版50页
    -->
     
    <!-- 
        junitreport    生成报告(通过打包在ant-junit.jar内的xsl样式表来生成 有必要的话可以自行更改)
            todir:源文件(XML)目录
             
            report    HTML生成模板信息定义
                format:指定是否使用Frame 有noframes和frames两种
                todir:指定HTML文件输出位置
                styledir:可以自己指定HTML使用的样式
    -->
    <target name="test-report" depends="test" description="Generate HTML unit test reports">
        <junitreport todir="${testlog.dir}">
            <fileset dir="${testlog.dir}">
                <include name="TEST-*.xml"/>
            </fileset>
            <report format="frames" todir="${testlog.html.dir}"/>
        </junitreport>
        <fail if="test.failures" message="There were test failures."/>
    </target>
     
    <target name="clean" description="Deletes generated dire ctories">
        <delete dir="${build.dir}" />
        <delete dir="${dist.dir}" />
        <delete dir="${testlog.dir}" />
    </target>
 
</project>