您的位置：首页 > 产品设计 > UI/UE

Ant之build.xml详解

2015-10-03 12:11 357 查看

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>标签

每个构建文件对应一个项目。<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 excludes 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的类型。

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

build.xml样例文件：
样例一：
<?xml version="1.0" encoding="UTF-8"?>



<project name="antTest" default="myAntTest">



<target name="init">
<mkdir dir="build/classes"/>
<mkdir dir="dist"/>
<mkdir dir="copy"/>
</target>

<target name="compile" depends="init">
<javac srcdir="src" destdir="build/classes" />
</target>

<target name="archive" depends="compile">
<jar destfile="dist/test.jar" basedir="build/classes"/>
</target>

<target name="copy" depends="archive">
<copy todir="copy" overwrite="true" includeemptydirs="false">
<fileset dir="dist">
<include name="*.jar"/>
</fileset>
</copy>
</target>

<target name="clean" depends="init">
<delete dir="build"/>
<delete dir="dist"/>
</target>

</project>

样例二：
<?xml version="1.0" encoding="UTF-8"?>

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





<property name="appName" value="test" />

<property name="src.dir" value="../${appName}/src" />

<property name="lib.dir" value="../${appName}/WebApplication/WEB-INF/lib" />

<property name="dist.dir" value="../${appName}/dist" />

<property name="classes.dir" value="../${appName}/WebApplication/WEB-INF/classes" />



<property name="server.home" value="D:/Tomcat7" />

<property name="webapps.dir" value="${server.home}/webapps/test" />

<property name="webapplication.dir" value="../${appName}/WebApplication" />



<path id="compile.classpath">

<pathelement location="${classes.dir}" />

<fileset dir="${lib.dir}" includes="***.xml" />

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

</fileset>

</copy>

<mkdir dir="${webapps.dir}/WEB-INF/lib" />

<copy todir="${webapps.dir}/WEB-INF/lib">

<fileset dir="${lib.dir}" includes="*.jar" />

</copy>

<echo>deploy is complete!</echo>

</target>



<target name="dist" depends="clean, deploy" description="Create binary destribution">

<jar jarfile="${dist.dir}/${appName}.war" basedir="${webapps.dir}" />

<echo>dist is complete!</echo>

</target>





<target name="javadoc" depends="compile" description="Create Javadoc API documentation">

<mkdir dir="${dist.dir}/docs/api" />

<javadoc sourcepath="${src.dir}" charset="utf-8" encoding="utf-8" source="1.6" destdir="${dist.dir}/docs/api">

<classpath refid="compile.classpath" />

</javadoc>

<echo>javadoc is complete!</echo>

</target>



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

<mkdir dir="${dist.dir}/junitReport" />

<junit printsummary="on" fork="true" showoutput="true">

<classpath refid="compile.classpath" />

<formatter type="xml" />

<batchtest todir="${dist.dir}/junitReport">

<fileset dir="${classes.dir}">

<include name="**/*Test.class" />

</fileset>

</batchtest>

</junit>

<echo>auto test successfully</echo>

<junitreport todir="${dist.dir}/junitReport">

<fileset dir="${dist.dir}/junitReport">

<include name="TEST-*.xml" />

</fileset>

<report format="frames" todir="${dist.dir}/junitReport" />

</junitreport>

<echo>junit report with HTML Documents successfully!</echo>

</target>

</project>

样例三：
<?xml version="1.0"?>

<project name="ssh" basedir="." default="usage">

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

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

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

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

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

<property name="webcontent.dir" value="WebContent"/>

<property name="prjlib.dir" value="lib"/>

<property name="webcontentlib.dir" value="${webcontent.dir}/WEB-INF/lib"/>

<property name="weblib.dir" value="${war.dir}/WEB-INF/lib"/>

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

<property environment="env"/>

<property name="tomcat.home" value="${env.CATALINA_HOME}"/>

<property name="webapp.dist" value="${dist.dir}/webapps"/>

<path id="master-classpath">

<fileset dir="${webcontentlib.dir}">

<include name="hibernate3.jar"/>

<include name="spring.jar"/>

<include name="struts.jar"/>

<include name="struts-el.jar"/>

<include name="struts-menu-2.4.2.jar"/>

<include name="acegi-security-1.0.2.jar"/>

<include name="activation.jar"/>

<include name="antlr.jar"/>

<include name="antlr-2.7.6.jar"/>

<include name="asm.jar"/>

<include name="aspectjweaver-1.5.2.jar"/>

<include name="cglib-2.1.3.jar"/>

<include name="commons-beanutils.jar"/>

<include name="commons-codec-1.3.jar"/>

<include name="commons-collections.jar"/>

<include name="commons-dbcp.jar"/>

<include name="commons-digester.jar"/>

<include name="commons-fileupload.jar"/>

<include name="commons-io.jar"/>

<include name="commons-lang.jar"/>

<include name="commons-logging-1.1.jar"/>

<include name="commons-pool.jar"/>

<include name="commons-validator.jar"/>

<include name="displaytag-1.1.jar"/>

<include name="dom4j-1.6.1.jar"/>

<include name="dwr.jar"/>

<include name="ehcache-1.2.3.jar"/>

<include name="itext-1.4.jar"/>

<include name="jakarta-oro.jar"/>

<include name="jstl.jar"/>

<include name="jta.jar"/>

<include name="log4j-1.2.11.jar"/>

<include name="mail.jar"/>

<include name="oscache-2.3.2.jar"/>

<include name="mysql-connector-java-5.0.3-bin.jar"/>

<include name="sitemesh-2.2.1.jar"/>

<include name="standard.jar"/>

<include name="urlrewrite-3.0-beta.jar"/>

<include name="velocity-1.4.jar"/>

<include name="velocity-tools-view-1.1.jar"/>

</fileset>

<fileset dir="${prjlib.dir}/servletapi-2.3">

<include name="servletapi-2.3.jar"/>

</fileset>

</path>

<target name="usage">

<echo message=""/>

<echo message="Spring JPetStore build file"/>

<echo message="------------------------------------------------------"/>

<echo message=""/>

<echo message="Available targets are:"/>

<echo message=""/>

<echo message="clean --> Clean output dirs"/>

<echo message="build --> Compile main Java sources and copy libraries"/>

<echo message="warfile --> Build the web application archive"/>

<echo message="all --> Clean, build, warfile"/>

<echo message=""/>

</target>

<target name="clean" description="Clean output dirs (build, weblib, dist)">

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

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

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

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

<delete file="client/${name}.jar"/>

</target>

<target name="build" description="Compile main source tree java files into class files, generate jar files">

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

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

<javac destdir="${build.dir}" source="1.3" target="1.3" debug="true"

deprecation="false" optimize="false" failonerror="true">

<src path="${src.dir}"/>

<classpath refid="master-classpath"/>

</javac>

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

<mkdir dir="${war.dir}/WEB-INF/classes"/>

<jar jarfile="${weblib.dir}/${name}.jar" compress="true" basedir="${build.dir}"/>

<copy todir="${war.dir}" preservelastmodified="true">

<fileset dir="${webcontent.dir}">

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

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

</fileset>

</copy>

<copy todir="${war.dir}/WEB-INF/classes" preservelastmodified="true">

<fileset dir="${src.dir}">

<include name="*.xml"/>

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

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

<exclude name="**/.*"/>

</fileset>

</copy>

<copy file="${weblib.dir}/${name}.jar" tofile="${client.dir}/${name}.jar"/>

</target>

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



</target>

<target name="warfile" depends="build" description="Build the web application archive">

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

<war warfile="${dist.dir}/${name}.war" basedir="${war.dir}" webxml="${webcontent.dir}/WEB-INF/web.xml">

<include name="*"/>

<include name="images/**"/>

<include name="common/**"/>

<include name="decorators/**"/>

<include name="scripts/**"/>

<include name="styles/**"/>

<include name="WEB-INF/*.*"/>

<include name="WEB-INF/lib/**"/>

<include name="WEB-INF/pages/**"/>

<include name="WEB-INF/classes/**"/>

<exclude name="WEB-INF/web.xml"/>

</war>

</target>

<target name="all" depends="clean,build,warfile" description="Clean,build,warfile"/>

</project>

样例四：
<?xml version="1.0" encoding="utf-8"?>

<project name="test" default="test" basedir=".">



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

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

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

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

<property name="classpath" location="${build}"/>





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

<property name="report.xml" value="${report}/junit/xml"/>

<property name="report.html" value="${report}/junit/html"/>



<path id="classpath.run">

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

<fileset dir="${lib}">

<include name="*.jar"/>

</fileset>

</path>



<path id="classpath.test">

<path refid="classpath.run"/>

<path location="${dist}/lib/test-${DSTAMP}.jar"/>

</path>





<target name="init" >

<tstamp/>

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

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

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

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

</target>





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

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

<classpath refid="classpath.run" />

</javac>

</target>





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

<mkdir dir="${dist}/lib"/>

<jar jarfile="${dist}/lib/test-${DSTAMP}.jar" basedir="${build}"/>

</target>





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

<java classname="com.test.TestCalculator">

<classpath>

<path refid="classpath.run"/>

</classpath>

</java>

</target>





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

<mkdir dir="${report.xml}"/>

<mkdir dir="${report.html}"/>

<junit printsummary="yes" haltonfailure="no">

<classpath refid="classpath.run"/>

<formatter type="xml"/>

<batchtest fork="yes" todir="${report.xml}">

<fileset dir="${src}" includes="**/Test*.java"/>

</batchtest>

</junit>

<junitreport todir="${report.html}">

<fileset dir="${report.xml}">

<include name="*.xml"/>

</fileset>

<report format="frames" todir="${report.html}"/>

</junitreport>

</target>

</project>

内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理

标签：

相关文章推荐

新的分享

章节导航