Ant 的最完整build.xml(转)

Posted 2020-10-12 kdy

Ant的概念

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>标签 
一个项目标签驴梢杂幸桓龌蚨喔?/span>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 表示制定是否显示详细信息，默认值不显示。

9.<war>标签 
该标签用来生成一个WAR包,其属性如下: 
destfile表示生产JAR文件名。 
dir表示被归档的文件目录。 
includes表示别归档的文件模式。 
exchudes表示被排除的文件模式。 
10.<echo>标签 
该标签用来在控制台输出信息,其输入如下： 
message表示输入的内容。

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

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

Builder.xml例子，这个是Flex生成AsDoc的例子

 

<?xml version="1.0"?>

<!--

    ADOBE SYSTEMS INCORPORATED
    Copyright 2006-2009 Adobe Systems Incorporated
    All Rights Reserved.

    NOTICE: Adobe permits you to use, modify, and distribute this file
    in accordance with the terms of the license agreement accompanying it.

-->

<project name="ASDocs" default="main" basedir=".">
    <property file="build.properties" />
    <property name="lenient" value="true"/>
    <property name="flexlib" location="${FLEX_HOME}/frameworks"/>

    <target name="main" depends="clean,doc" description="Clean build of all ASDocs"/>

    <target name="clean" description="Cleans all ASDocs">
        <delete dir="${OUTPUT_DIR}"/>
        <echo>清除${OUTPUT_DIR}</echo>
    </target>

    <target name="doc">

        <condition property="asdoc.jvm.args" value="-Xmx512m">
            <os family="windows"/>
        </condition>

        <condition property="asdoc.jvm.args" value="-Xmx1024m">
            <os family="mac"/>
        </condition>

        <condition property="asdoc.jvm.args" value="-Xmx512m">
            <os family="unix"/>
        </condition>

        <available property="flexTasksJar" value="${FLEX_HOME}/lib/flexTasks.jar" file="${FLEX_HOME}/lib/flexTasks.jar"/>
        <available property="flexTasksJar" value="${FLEX_HOME}/ant/lib/flexTasks.jar" file="${FLEX_HOME}/ant/lib/flexTasks.jar"/>

        <!-- Load the <asdoc> task. We can‘t do this at the <project> level -->
        <!-- because targets that run before flexTasks.jar gets built would fail. -->
        <taskdef resource="flexTasks.tasks" classpath="${flexTasksJar}"/>

        <!-- Call asdoc to generate dita xml files -->
        <asdoc output="${OUTPUT_DIR}" lenient="true" failonerror="true" warnings="false" strict="false" locale="en_US" fork="false">
            <!-- asDoc Infomation -->
            <window-title>asDocAPI标题</window-title>
            <main-title >asDocAPI文档</main-title>
            <footer>asDoc API 页脚 版权所有XXXX</footer>
            
            <!-- top level class to include in asdoc -->
            
            <!-- source path for asdoc -->
            <compiler.source-path path-element="src"/>
            <doc-sources path-element="src"/>
            <!-- namespaces to include in asdoc -->
            <!--<doc-namespaces uri="library://ns.myasdoc.com/flex/myasdoc"/>
            <namespace uri="library://ns.myasdoc.com/flex/myasdoc" manifest="my-manifest.xml"/>-->
            
            <namespace uri="library://ns.adobe.com/flashx/textLayout" manifest="${flexlib}/projects/textLayout/manifest.xml"/>

            <!-- namespace declaration for asdoc -->
            
            <namespace uri="http://www.adobe.com/2006/airmxml" manifest="${flexlib}/projects/airframework/manifest.xml"/>
            <namespace uri="http://www.adobe.com/2006/airspark" manifest="${flexlib}/projects/airspark/manifest.xml"/>
            <namespace uri="http://www.adobe.com/2006/rpcmxml" manifest="${flexlib}/projects/rpc/manifest.xml"/>
            <namespace uri="http://ns.adobe.com/2009/mx-mxml" manifest="${flexlib}/projects/mx/manifest.xml"/>
            <namespace uri="http://www.adobe.com/2006/advancedgridsmxml" manifest="${flexlib}/projects/advancedgrids/manifest_advancedgrids.xml"/>
            <namespace uri="http://www.adobe.com/2006/charts" manifest="${flexlib}/projects/charts/manifest_charts.xml"/>
                        
            <namespace uri="http://www.adobe.com/2006/mxml" manifest="${flexlib}/mxml-manifest.xml"/>
            <namespace uri="library://ns.adobe.com/flex/spark" manifest="${flexlib}/projects/spark/manifest.xml"/>
            <namespace uri="library://ns.adobe.com/flex/mx" manifest="${flexlib}/mxml-manifest.xml"/>
            <namespace uri="library://ns.adobe.com/flex/spark-mobilecomponents" manifest="${flexlib}/projects/mobilecomponents/manifest.xml"/>
            <namespace uri="library://ns.adobe.com/flex/spark-dmv" manifest="${flexlib}/projects/spark_dmv/manifest_spark_dmv.xml"/>

            <library-path dir="libs" includes="*.swc" append="true"/>
            <library-path dir="${FLEX_HOME}/frameworks/libs" includes="*.swc" append="true"/>
            <library-path dir="${FLEX_HOME}/frameworks/libs/mobile" includes="*.swc" append="true"/>
            <library-path dir="${FLEX_HOME}/frameworks/libs/automation" includes="*.swc" append="true"/>
            
            <external-library-path dir="${flexlib}/libs/air">
                <include name="airglobal.swc" />
            </external-library-path>
            <external-library-path dir="${flexlib}/libs">
                <include name="framework.swc" />
            </external-library-path>
            <external-library-path dir="${flexlib}/libs/air">
                   <include name="airframework.swc" />
            </external-library-path>
            <external-library-path dir="${flexlib}/libs/air">
                   <include name="airspark.swc" />
            </external-library-path>
            <jvmarg line="${asdoc.jvm.args}"/>
            <define name="CONFIG::debug" value="false"/>
            <define name="CONFIG::release" value="true"/>
            <define name="CONFIG::FLASH_10_1" value="false"/>
            <define name="CONFIG::LOGGING" value="false"/>
            <define name="CONFIG::performanceInstrumentation" value="false"/>            
        </asdoc>
    </target>
</project>

 

project.path=E\:\\code\\rs
svn.url=https://192.168.1.1/svn/v_1.1.0.01
svn.username=zhangsan
svn.password=zhangsan

<?xml version="1.0" encoding="UTF-8"?>
<project name="hqoa" default="svn" basedir=".">
    <!-- 首先改一下自己的这四个参数 -->
    <property file="build.properties"/>

    <property name="svnantClass" value="org.tigris.subversion.svnant.SvnTask" /><!-- SVNANT 任务类 -->
    <!--定义SVNANT依赖库-->
    <path id="svnant.lib">
        <pathelement location="${project.path}\svnant\svnkit.jar" />
        <pathelement location="${project.path}\svnant\svnjavahl.jar" />
        <pathelement location="${project.path}\svnant\svnant.jar" />
        <pathelement location="${project.path}\svnant\svnClientAdapter.jar" />
        <pathelement location="${project.path}\svnant\ganymed.jar" />
        <pathelement location="${project.path}\svnant\jna.jar" />
    </path>
    
    <!-- 定义SVN task -->
    <taskdef name="svn" classname="${svnantClass}" classpathref="svnant.lib" />
    <!--svn同步任务-->
    <target name="svn">
        <delete dir="${project.path}/lib" />
        <delete dir="${project.path}/hqoa/WEB-INF/views/hqoa" />
        <delete dir="${project.path}/hqoa/fasp" />
        <delete dir="${project.path}/hqoa/static" />
        <delete dir="${project.path}/src/com/tjhq/hqoa/apis" />
        <delete dir="${project.path}/src/com/tjhq/hqoa/system" />
        <delete dir="${project.path}/src/com/tjhq/hqoa/utils" />
        <svn username="${svn.username}" password="${svn.password}" svnkit="true" javahl="false" failonerror="false">
            <export srcurl="${svn.url}/lib" destpath="${project.path}/lib" force="true" description="导出"/>
            <export srcurl="${svn.url}/hqoa/fasp" destpath="${project.path}/hqoa/fasp" force="true" description="导出"/>
            <export srcurl="${svn.url}/hqoa/static" destpath="${project.path}/hqoa/static" force="true" description="导出"/>
            <export srcurl="${svn.url}/hqoa/WEB-INF/views/hqoa" destpath="${project.path}/hqoa/WEB-INF/views/hqoa" force="true" description="导出"/>
            <export srcurl="${svn.url}/src/com/tjhq/hqoa/apis" destpath="${project.path}/src/com/tjhq/hqoa/apis" force="true" description="导出"/>
            <export srcurl="${svn.url}/src/com/tjhq/hqoa/system" destpath="${project.path}/src/com/tjhq/hqoa/system" force="true" description="导出"/>
            <export srcurl="${svn.url}/src/com/tjhq/hqoa/utils" destpath="${project.path}/src/com/tjhq/hqoa/utils" force="true" description="导出"/>
        </svn>
    </target>
</project>

<?xml version="1.0" encoding="UTF-8"?>
<project name="hqoa" default="generjar" basedir=".">
    <property name="lib" value="${basedir}/lib" />
    <property name="webRoot" value="${basedir}/hqoa" />
    <property name="classes" value="${webRoot}/WEB-INF/classes" />
    <!--定义目标Jar文件名称，此处需要根据情况进行修改-->
    <property name="jar.name" value="hqoa_busi.jar"/>
    <!--定义目标包目录名称，此处需要根据情况进行修改-->
    <property name="package" value="com/tjhq/hqoa/busi/**,com/tjhq/hqoa/fasttext/**,com/tjhq/hqoa/query/**" />
    
    <!--定义CLASSPACH-->
    <path id="classpath">
        <fileset dir="${lib}" includes="***.jar" />
    </path>
    <!--删除jar任务-->
    <target name="clean" description="删除">
        <echo message="准备删除${jar.name}" />
        <delete file="${basedir}/${jar.name}" />
        <echo message="删除${jar.name}完毕" />
    </target>

    <!--打jar包-->
    <target name="generjar" depends="clean">
        <echo message="打${jar.name}包" />
        <jar destfile="${lib}/${jar.name}" basedir="${classes}" includes="${package}" />
        <echo message="打${jar.name}包完成" />
    </target>
</project>