Apache-ant 工具的介绍、安装及build.xml文件的解析-CFANZ编程社区

0. ant介绍

Apache-ant是一个将软件编译、测试、部署步骤联系在一起加以自动化的一个工具，大多数用于java环境中的软件开发，由Apache软件基金会所提供。默认情况下，XML文件名为build.xml。

1. ant 安装

注：ant依赖于jdk，首先需要配置jdk JAVA_HOME

a. 下载Apache-ant

Apache-ant下载链接当前版本为apache-ant-1.10.5-bin.tar.bz2

b. 解压到自己的目录下，例如我的目录为/Users/leiyuxing/apache-ant-1.10.5

c. 修改/etc/profile添加ANT_HOME

export ANT_HOME=/Users/leiyuxing/apache-ant-1.10.5 export PATH=$ANT_HOME/bin:$PATH

d. 重新登录或者source /etc/profile

e. 测试下是否安装成功

$ ant -version Apache Ant(TM) version 1.10.5 compiled on July 10 2018

2. ant的基本标签

<project>标签

每个构建文件对应一个项目，<project>标签时构建文件的根标签。它可以有多个内在属性，就如代码中所示，其各个属性的含义分别如下：

(1) default表示默认的运行目标，这个属性是必须的。
(2) basedir表示项目的基准目录。
(3) name表示项目名。
(4) description表示项目的描述。

每个构建文件都对应于一个项目，但是大型项目经常包含大量的子项目，每一个子项目都可以有自己的构建文件。

<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总会被执行。

<mkdir>标签

该标签用于创建一个目录，它有一个属性dir用来指定所创建的目录名，其代码如下：<mkdir dir=”＄{class.root}”/>通过以上代码就创建了一个目录，这个目录已经被前面的property标签所指定。

<jar>标签

该标签用来生成一个JAR文件，其属性如下:

(1) destfile表示JAR文件名。
(2) basedir表示被归档的文件名。
(3) includes表示别归档的文件模式。
(4) exchudes表示被排除的文件模式。

<javac>标签

该标签用于编译一个或一组java文件，其属性如下:

(1).srcdir表示源程序的目录。
(2).destdir表示class文件的输出目录。
(3).include表示被编译的文件的模式。
(4).excludes表示被排除的文件的模式。
(5).classpath表示所使用的类路径。
(6).debug表示包含的调试信息。
(7).optimize表示是否使用优化。
(8).verbose 表示提供详细的输出信息。
(9).fileonerror表示当碰到错误就自动停止。

<java>标签

该标签用来执行编译生成的.class文件，其属性如下:

(1).classname 表示将执行的类名。
(2).jar表示包含该类的JAR文件名。
(3).classpath所表示用到的类路径。
(4).fork表示在一个新的虚拟机中运行该类。
(5).failonerror表示当出现错误时自动停止。
(6).output 表示输出文件。
(7).append表示追加或者覆盖默认文件。

<delete>标签

该标签用于删除一个文件或一组文件，去属性如下:

(1).file表示要删除的文件。
(2).dir表示要删除的目录。
(3).includeEmptyDirs 表示指定是否要删除空目录，默认值是删除。
(4).failonerror 表示指定当碰到错误是否停止，默认值是自动停止。
(5).verbose表示指定是否列出所删除的文件，默认值为不列出。

<copy>标签

该标签用于文件或文件集的拷贝，其属性如下:

(1).file 表示源文件。
(2).tofile 表示目标文件。
(3).todir 表示目标目录。
(4).overwrite 表示指定是否覆盖目标文件，默认值是不覆盖。
(5).includeEmptyDirs 表示制定是否拷贝空目录，默认值为拷贝。
(6).failonerror 表示指定如目标没有发现是否自动停止，默认值是停止。
(7).verbose 表示制定是否显示详细信息，默认值不显示。

3. ant的数据类型

在构建文件中为了标识文件或文件组，经常需要使用数据类型。数据类型包含在 org.apache.tool.ant.types包中。下面简单介绍构建文件中一些常用的数据类型。

argument 类型

由Ant构建文件调用的程序，可以通过<arg>元素向其传递命令行参数，如apply,exec和java任务均可接受嵌套<arg>元素，可以为各自的过程调用指定参数。以下是<arg>的所有属性。

(1).values 是一个命令参数。如果参数种有空格，但又想将它作为单独一个值，则使用此属性。
(2).file表示一个参数的文件名。在构建文件中，此文件名相对于当前的工作目录。
(3).line表示用空格分隔的多个参数列表。
(4).path表示路径。

ervironment 类型

由Ant构建文件调用的外部命令或程序，<env>元素制定了哪些环境变量要传递给正在执行的系统命令，<env>元素可以接受以下属性。

(1).file表示环境变量值得文件名。此文件名要被转换位一个绝对路径。
(2).path表示环境变量的路径。Ant会将它转换为一个本地约定。
(3).value 表示环境变量的一个直接变量。
(4).key 表示环境变量名。

注意：file path 或 value只能取一个。

filelist类型Filelist 是一个支持命名的文件列表的数据类型，包含在一个filelist类型中的文件不一定是存在的文件。以下是其所有的属性：

(1).dir是用于计算绝对文件名的目录。
(2).files 是用逗号分隔的文件名列表。
(3).refid 是对某处定义的一个<filelist>的引用。

注意： dir 和 files 都是必要的，除非指定了refid(这种情况下，dir和files都不允许使用)。

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 表示每行包括一个包含模式的文件名。

patternset 类型

Fileset 是对文件的分组，而patternset是对模式的分组，他们是紧密相关的概念。<patternset>支持4个属性：includes excludex includexfile 和 excludesfile,与fileset相同。Patternset 还允许以下嵌套元素：include,exclude,includefile 和 excludesfile。

filterset 类型

Filterset定义了一组过滤器，这些过滤器将在文件移动或复制时完成文件的文本替换。
主要属性如下：

(1).begintoken 表示嵌套过滤器所搜索的记号，这是标识其开始的字符串。
(2).endtoken表示嵌套过滤器所搜索的记号这是标识其结束的字符串。
(3).id是过滤器的唯一标志符。
(4).refid是对构建文件中某处定义一个过滤器的引用。

Path类型

Path元素用来表示一个类路径，不过它还可以用于表示其他的路径。在用作揖个属性时，路经中的各项用分号或冒号隔开。在构建的时候，此分隔符将代替当前平台中所有的路径分隔符，其拥有的属性如下。

(1).location 表示一个文件或目录。Ant在内部将此扩展为一个绝对路径。
(2).refid 是对当前构建文件中某处定义的一个path的引用。
(3).path表示一个文件或路径名列表。

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的类型。

4. 以下写了build.xml的基本模板，后面添加jmeter的测试文件可以在模板中扩展和灵活配置

<?xml version="1.0" encoding="utf-8"?>  
<project name="ant-jmeter-test" default="run" basedir=".">
  <tstamp>
    <format property="time" pattern="yyyyMMddhhmm"/>
  </tstamp>
  <!-- 配置jmeter目录 -->
  <property name="jmeter.home" value="D:\tools\apache-jmeter-2.10"/>
  <!-- jmeter生成jtl格式的结果报告的路径 -->
  <property name="jmeter.result.jtl.dir" value="D:\tools\apache-jmeter-2.10\AntReport\wk-test\"/>
  <!-- jmeter生成html格式的结果报告的路径 -->
  <property name="jmeter.result.html.dir" value="D:\tools\apache-jmeter-2.10\AntReport\wk-test\"/>
  <!-- 生成报告的前缀 -->
  <property name="ReportName" value="TestReport"/>
  <property name="jmeter.result.jtlName" value="${jmeter.result.jtl.dir}/${ReportName}${time}.jtl"/>
  <property name="jmeter.result.htmlName" value="${jmeter.result.html.dir}/${ReportName}${time}.html"/>
    
  <target name="run">
    <antcall target="init"/>  <!-- 调用其他的目标 -->
    <antcall target="testOneLogin"/>
    <antcall target="test2NumByTypeAndSample"/>
    <antcall target="logout"/>
    <antcall target="report"/>
  </target>
    
  <!-- 定义一个目标，任务名称为ini——将需要的外部文件删除将需要的外部文件删除 -->
  <target name="init">
    <!-- 每次运行前删除之前产生的报告文件 -->
    <delete >  
      <fileset dir="D:\tools\apache-jmeter-2.10\AntReport\wk-test\" includes="*.doc,*.html,*.jtl,*.xls"/>  
    </delete> 
  </target>   
    
    
  <target name="testOneLogin">
    <!-- 定义一个任务，任务名称为jmeterA -->
    <taskdef name="jmeterA" classname="org.programmerplanet.ant.taskdefs.jmeter.JMeterTask"/>
    <jmeterA jmeterhome="${jmeter.home}" resultlog="${jmeter.result.jtlName}">
      <!-- 声明要运行的脚本 -->
      <testplans dir="D:\tools\apache-jmeter-2.10\TestScript\wk-test\case\" includes="一次登录-suadmin.jmx"/>
      <property name="jmeter.save.saveservice.output_format" value="xml"/>
    </jmeterA>
  </target>   
    
    
  <target name="test2NumByTypeAndSample">
    <delete file="D:\tools\apache-jmeter-2.10\TestScript\wk-test\case\submitInfo.txt"/>
    <!-- 定义一个任务，任务名称为jmeterA -->
    <taskdef name="jmeterA" classname="org.programmerplanet.ant.taskdefs.jmeter.JMeterTask"/>
    <jmeterA jmeterhome="${jmeter.home}" resultlog="${jmeter.result.jtlName}">
      <!-- 测试脚本 -->
      <testplans dir="D:\tools\apache-jmeter-2.10\TestScript\wk-test\case01\" includes="新增占号-各占1个.jmx"/>
      <testplans dir="D:\tools\apache-jmeter-2.10\TestScript\wk-test\case04\" includes="业务受理单独提交.jmx"/>
      <testplans dir="D:\tools\apache-jmeter-2.10\TestScript\wk-test\case05\" includes="任务审核批量选择审核.jmx"/>
      <testplans dir="D:\tools\apache-jmeter-2.10\TestScript\wk-test\case06\" includes="批量按样品下达.jmx"/>
      <testplans dir="D:\tools\apache-jmeter-2.10\TestScript\wk-test\case14\" includes="发消息.jmx"/>
      <testplans dir="D:\tools\apache-jmeter-2.10\TestScript\wk-test\case14\" includes="报告归档单独归档.jmx"/>
      <testplans dir="D:\tools\apache-jmeter-2.10\TestScript\wk-test\case\" includes="退出系统.jmx"/>
      <property name="jmeter.save.saveservice.output_format" value="xml"/>
    </jmeterA>
  </target>
  
  
  
  <!-- 每个类别各占2个号，占号2个删除，业务受理2个删除 -->
  <target name="test2NumDelete">
    <delete file="D:\tools\apache-jmeter-2.10\TestScript\wk-test\case\submitInfo.txt"/>
    <!-- 定义一个任务，任务名称为jmeterA -->
    <taskdef name="jmeterA" classname="org.programmerplanet.ant.taskdefs.jmeter.JMeterTask"/>
    <jmeterA jmeterhome="${jmeter.home}" resultlog="${jmeter.result.jtlName}">
      <!-- 测试登录接口 -->
      <testplans dir="D:\tools\apache-jmeter-2.10\TestScript\wk-test\case01\" includes="新增占号-各占2个.jmx"/>
      <testplans dir="D:\tools\apache-jmeter-2.10\TestScript\wk-test\case02\" includes="删除2个占号.jmx"/>
      <testplans dir="D:\tools\apache-jmeter-2.10\TestScript\wk-test\case03\" includes="业务受理选中2个删除.jmx"/>
      <property name="jmeter.save.saveservice.output_format" value="xml"/>
    </jmeterA>
  </target>
  
  <target name="logout">
    <!-- 定义一个任务，任务名称为jmeterA -->
    <taskdef name="jmeterA" classname="org.programmerplanet.ant.taskdefs.jmeter.JMeterTask"/>
    <jmeterA jmeterhome="${jmeter.home}" resultlog="${jmeter.result.jtlName}">
      <!-- 声明要运行的脚本 -->
      <testplans dir="D:\tools\apache-jmeter-2.10\TestScript\wk-test\case\" includes="退出系统.jmx"/>
      <property name="jmeter.save.saveservice.output_format" value="xml"/>
    </jmeterA>
  </target> 
  
  
  <!-- 自定义的path路径，该路径下包含下面匹配的jar包，下面会用到 -->
  <path id="xsltA.classpath">
    <fileset dir="${jmeter.home}/lib" includes="xalan*.jar,serializer*.jar"/>
  </path> 
  <target name="report">
       <!-- 这里用到了上面定义的path路径 -->
    <xslt classpathref="xsltA.classpath" force="true" in="${jmeter.result.jtlName}" out="${jmeter.result.htmlName}" style="${jmeter.home}/extras/jmeter-results-detail-report_21.xsl">
      <param name="deateReport" expression="${time}"/> <!-- 有没有这句没有什么影响 -->
    </xslt>
    
    <!-- 复制两个图片过来，已经有的就可以不用复制了 -->
    <!--
    <copy todir="${jmeter.result.html.dir}">
      <fileset dir="${jmeter.home}/extras">
        <include name="collapse.png"/>
        <include name="expand.png"/>
      </fileset>
    </copy>
    -->
  </target>
</project>