ant
上一篇 / 下一篇 2011-03-10 10:43:25 / 个人分类:JAVA
build-example.xml(ant+junit测试报告)
首先看一下ANT-build.xml文件详解
Ant的概念
可能有些读者并不连接什么是Ant以及入可使用它,但只要使用通过Linux系统得读者,应该知道
make这个命令。当编译Linux内核及一些软件的源程序时,经常要用这个命令。Make命令其实就
是一个项目管理工具,而Ant所实现功能与此类似。像make,gnumake和nmake这些编译工具都有
一定的缺陷,但是Ant却克服了这些工具的缺陷。最初Ant开发者在开发跨平台的应用时,用样也
是基于这些缺陷对Ant做了更好的设计。
Ant 与 makefile
Makefile有一些不足之处,比如很多人都会碰到的烦人的Tab问题。最初的Ant开发者多次强调”
只是我在Tab前面加了一个空格,所以我的命令就不能执行”。有一些工具在一定程度上解决了
这个问题,但还是有很多其他的问题。Ant则与一般基于命令的工具有所不同,它是Java类的扩
展。Ant运行需要的XML格式的文件不是Shell命令文件。它是由一个Project组成的,而一个
Project又可分成可多target,target再细分又分成很多task,每一个task都是通过一个实现特
定接口的java类来完成的。
Ant的优点
Ant是Apache软件基金会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>标签
就如代码中所示,其各个属性的含义分别如下。
(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类型
统命令,<env>元素可以接受以下属性。
(1).file表示环境变量值得文件名。此文件名要被转换位一个绝对路径。
(2).path表示环境变量的路径。Ant会将它转换为一个本地约定。
(3).value 表示环境变量的一个直接变量。
(4).key 表示环境变量名。
注意
3.filelist类型
Filelist是一个支持命名的文件列表的数据类型,包含在一个filelist类型中的文件不一定是
存在的文件。以下是其所有的属性。
(1).dir是用于计算绝对文件名的目录。
(2).files 是用逗号分隔的文件名列表。
(3).refid 是对某处定义的一个<filelist>的引用。
注意
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 excludexincludexfile 和 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 globmerge
内置mapper的类型。
Ant 的运行
安装好Ant并且配置好路径之后,在命令行中切换到构建文件的目录,输入Ant命令就可以运行
Ant.若没有指定任何参数,Ant会在当前目录下查询build.xml文件。如果找到了就用该文件作为
构建文件。如果使用了–find 选项,Ant就会在上级目录中找构建文件,直至到达文件系统得
跟目录。如果构建文件的名字不是build.xml,则Ant运行的时候就可以使用 –buildfile file
,这里file指定了要使用的构建文件的名称,示例如下:
Ant
如下说明了表示当前目录的构建文件为build.xml 运行 ant执行默认的目标。
Ant–buildfile
使用当前目录下的test.xml 文件运行Ant ,执行默认的目标
模板:
<?xmlversion="1.0"?>
<project name="Hello world" default="doc">
<!-- properies -->
<propertyname="src.dir" value="src" />
<propertyname="report.dir" value="report" />
<propertyname="classes.dir" value="classes" />
<propertyname="lib.dir" value="lib" />
<propertyname="dist.dir" value="dist" />
<property name="doc.dir"value="doc"/>
<!-- 定义classpath -->
<pathid="master-classpath">
<fileset file="${lib.dir}*Test.*"/>
</fileset>
</batchtest>
</junit>
<fail if="tests.failed">
***********************************************************
**** One or more tests failed! Check the output ... ****
***********************************************************
</fail>
</target>
<!-- 打包成jar -->
<targetname="pack" depends="test" description="make .jar file">
<mkdir dir="${dist.dir}" />
<jar destfile="${dist.dir}/hello.jar"basedir="${classes.dir}">
<exclude name="**Test*.*" />
</jar>
</target>
<!-- 输出api文档 -->
<targetname="doc" depends="pack" description="create api doc">
<mkdir dir="${doc.dir}" />
<javadoc destdir="${doc.dir}"
author="true"
version="true"
use="true"
windowtitle="Test API">
<packageset dir="${src.dir}" defaultexcludes="yes">
<include name="example/**" />
</packageset>
<doctitle><![CDATA[<h1>Hello,test</h1>]]></doctitle>
<bottom><![CDATA[<i>All RightsReserved.</i>]]></bottom>
<tag name="todo" scope="all" description="To do:" />
</javadoc>
</target>
</project>
build-example.xml(ant+junit测试报告):
<?xml version="1.0" encoding="GB2312" ?>
<project default="gen-report-coverage" basedir=".">
<!--设置Java类被注入字节码后存放的路径-->
<property name="bin.instrument.dir" value="${basedir}/out/instrbin"/>
<!--设置覆盖率元数据和报告的路径-->
<property name="coverage.dir" value="${basedir}/out/coverage"/>
<!--设置junit报告的路径 -->
<property name="junitReport.dir" value="${basedir}/out/junitReport"/>
<!--设置主题代码源路径-->
<property name="src.main.dir" value="${basedir}/../src/mcc">
</property>
<!--设置测试代码源路径-->
</property>
<!--设置主题代码bin路径-->
<property name="bin.main.dir" value="${basedir}/out/srcbin">
</property>
<!--设置测试代码bin路径-->
<property name="bin.test.dir" value="${basedir}/out/testbin">
</property>
<property name="lib.dir" value="${basedir}/lib">
</property>
<path id="compile.path">
<pathelement location="${bin.main.dir}"/>
<pathelement location="${basedir}\..\lib\ganymed.jar"/>
<pathelement location="${basedir}\..\lib\junit-3.8.1.jar"/>
<pathelement location="${basedir}\..\lib\svnClientAdapter1.3.jar"/>
<pathelement location="${basedir}\..\lib\svnjavahl.jar"/>
<pathelement location="${basedir}\..\lib\svnkit.jar"/>
</path>
<!--指示 emma.jar 和emma_ant.jar 的路径-->
<path id="emma.lib">
<pathelement location="${lib.dir}/emma.jar"/>
<pathelement location="${lib.dir}/emma_ant.jar"/>
</path>
<path id="compile.classes">
<pathelement path="${bin.main.dir}"/>
</path>
<!--允许emma-->
<property name="emma.enabled" value="true"/>
<taskdef resource="emma_ant.properties" classpathref="emma.lib"/>
<!-- 项目中的一个任务组,可包含很多任务(task:javac,java...) -->
<target name="init">
<delete dir="${bin.main.dir}"/>
<delete dir="${bin.test.dir}"/>
<delete dir="${bin.instrument.dir}"/>
<delete dir="${coverage.dir}"/>
<delete dir="${junitReport.dir}"/>
<mkdir dir="${bin.main.dir}"/>
<mkdir dir="${bin.test.dir}"/>
<mkdir dir="${bin.instrument.dir}"/>
<mkdir dir="${coverage.dir}"/>
<mkdir dir="${junitReport.dir}"/>
</target>
<!--编译源代码-->
<target name="compile-src.main" depends="init">
<javac destdir="${bin.main.dir}" debug="on">
<src path="${src.main.dir}"></src>
<classpath refid="compile.path"></classpath>
</javac>
<copy todir="${bin.main.dir}">
<fileset dir="${src.main.dir}">
<exclude name="**/*.java"/>
</fileset>
</copy>
</target>
<!--编译测试代码-->
<target name="compile-src.test" depends="compile-src.main">
<javac destdir="${bin.test.dir}" debug="on">
<src path="${src.test.dir}"/>
<classpath refid="compile.path"></classpath>
</javac>
<copy todir="${bin.test.dir}">
<fileset dir="${src.test.dir}">
<exclude name="**/*.java"/>
</fileset>
</copy>
</target>
<!--对编译在路径bin.main.dir中的Java类注入字节码,
并且把注入字节码的新Java类存放到路径bin.instrument.dir-->
<!--覆盖率的元数据存放在路径coverage.dir中-->
<target name="instrument" depends="compile-src.test">
<emma enabled="${emma.enabled}" verbosity="info">
<instr instrpathref="compile.classes"
destdir="${bin.instrument.dir}"
metadatafile="${coverage.dir}/metadata.emma"
merge="true">
</instr>
</emma>
<!--<copy todir="${bin.instrument.dir}">-->
<!--<fileset dir="${bin.main.dir}">-->
<!--<exclude name="**/*.java"/>-->
<!--</fileset>-->
<!--</copy>-->
</target>
<!--执行测试用例同时生成junit测试报告和emma代码覆盖率报告-->
<target name="test" depends="instrument">
<junit fork="true" forkmode="once"
printsummary="withOutAndErr"
errorproperty="test.error"
showoutput="on">
<!--指明代码覆盖率的元数据的存放位置-->
<jvmarg
value="-Demma.coverage.out.file=${coverage.dir}/metadata.emma"/>
<jvmarg value="-Demma.coverage.out.merge=true"/>
<classpath location="${bin.instrument.dir}"/>
<classpath location="${bin.test.dir}"/>
<classpath refid="emma.lib"/>
<classpath refid="compile.path"/>
<formatter type="xml"/>
<!--执行所有以TestSuite结尾的junit测试用例-->
<batchtest todir="${junitReport.dir}" haltonfailure="no">
<fileset dir="${bin.test.dir}">
<include name="**/*TestSuite.class"/>
</fileset>
</batchtest>
</junit>
</target>
<target name="gen-report-junit" depends="test">
<!--生成junit测试报告-->
<junitreport todir="${junitReport.dir}">
<fileset dir="${junitReport.dir}">
<include name="*"/>
</fileset>
<report format="frames" todir="${junitReport.dir}"/>
</junitreport>
</target>
<!--生成代码覆盖率报告-->
<target name="gen-report-coverage" depends="test">
<!--如果属性emma.enabled的值是true,就生成代码覆盖率报告 -->
<emma enabled="${emma.enabled}">
<report sourcepath="${src.main.dir}"
sort="+line,+block,+name,+method,+class"
metrics="method:100,block:90,line:90,class:100">
<fileset dir="${coverage.dir}">
<include name="metadata.emma"/>
</fileset>
<html utfile="${coverage.dir}/coverage.html"
depth="method"/>
</report>
</emma>
</target>
</project>
TAG:
标题搜索
日历
|
|||||||||
日 | 一 | 二 | 三 | 四 | 五 | 六 | |||
1 | 2 | 3 | 4 | 5 | 6 | ||||
7 | 8 | 9 | 10 | 11 | 12 | 13 | |||
14 | 15 | 16 | 17 | 18 | 19 | 20 | |||
21 | 22 | 23 | 24 | 25 | 26 | 27 | |||
28 | 29 | 30 |
我的存档
数据统计
- 访问量: 25360
- 日志数: 40
- 建立时间: 2011-01-12
- 更新时间: 2014-08-01