【JAVA】Ant编译

ant是构建工具，其功能和C++/C中的make工具类似。Ant是Apache软件基金会JAKARTA目录中的一个子项目，它有以下的优点：

1）跨平台性。Ant是存Java语言编写的，所示具有很好的跨平台性。 
2）操作简单。Ant是由一个内置任务和可选任务组成的。Ant运行时需要一个XML文件(构建文件)。 
Ant通过调用target树，就可以执行各种task。每个task实现了特定接口对象。由于Ant构建文件 时XML格式的文件，所以和容易维护和书写，而且结构很清晰。 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的类型。 

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

 

常用命令

1.1,设置和使用classpath

设置代码如下:

<classpath id="project.class.path">
<pathelement path="${classpath}"/>
<fileset dir="lib">
   <include name="**/*.jar"/>
</fileset>
<pathelement location="classes"/>
<dirset dir="build">
   <include name="apps/**/classes"/>
   <exclude name="apps/**/*Test*"/>
</dirset>
<filelist refid="third-party_jars"/>
</classpath>

使用代码如下:

<target>
<javac>
   <classpath refid="project.class.path"/>
</javac>
</target>

1.2,输出信息

输出信息有两种写法:

1）<echo message="xxxx"/>
2）<echo>xxxx</echo>

输出一段XML

<echoxml file="subbuild.xml">
<project default="ann">
   <target name="ann">
    <echo>ann</echo>
   </target>
</project>
</echoxml>

1.3,引入一个XML文件

<import file="../common-targets.xml"/>

1.4,拷贝和删除文件,目录

拷贝一个文件:

<copy file="myfile.txt" fofile="mycopy.txt"/>

拷贝一个文件到指定目录:

<copy file="myfile.txt" todir"../some/other/dir"/>

拷贝一个目录到另一个目录:

<copy todir="../new/dir">
<fileset dir="src_dir"/>
   <exclude name="**/*.java"/>
</fileset>
</copy>

或

<copy todir="../dest/dir"
    <fileset dir="src_dir" excludes="**/*.java"/>
</copy>

拷贝一个文件集合到一个目录,同时建立备份文件:

<copy todir="../backup/dir">
    <fileset dir="src_dir"/>
    <globmapper from="*" to="*.bak"/>
</copy>

拷贝一个集合的文件到一个目录,并替换掉@TITLE@

<copy todir="../backup/dir">
<fileset dir="src_dir"/>
<filterset>
   <filter token="TITLE" value="Ann Lee"/>
</filterset>
</copy>

拷贝一个目录下的东西到另一个目录下

<copydir src="${src}/resources" dest="${dest}" includes="**/*.java" excludes="**/Test.java"/>

拷贝一个文件

<copyfile src="Test.java" dest="subdir/Test.java"/>

删除文件,目录,(拷贝中各种关于目录的操作也可以用在这里)

删除一个文件

<delete file="/lib/ant.jar"/>

删除一个目录

<delete dir="lib"/>

删除所有符合规则的文件(.bak文件)包括子目录

<delete>
    <fileset dir="." includes="**/*.bak"/>
</delete>

删除当前目录下所有的文件和目录,包括当前目录

<delete includeEmptyDirs="true">
    <fileset dir="build"/>
</delete>

删除当前目录下所有的文件和目录,不包括当前目录

<delete includeemptydirs="true">
    <fileset dir="build" includes="**/*"/>
</delete>

删除当前目录下所有的svn相关文件(因为svn文件默认是excludes,所以要设置一下)

<delete defaultexcludes="false">
    <fileset dir="src" includes="**/*.svn"/>
</delete>

删除文件目录树

<deltree dir="dist"/>

1.5,剪切文件

<move todir="some/new/dir">
<fileset dir="my/src/dir"
   <include name="**/*.jar">
   <exclude name="**/ant.jar/>
</fileset>
</move>

1.6重命名

<rename src="ann.jar" dest="ant-${version}.jar/>

1.7建立临时文件

在目录build下,建立名为temp.file,后缀为.xml的文件

<tempfile property="temp.file" destDir="build" suffix=".xml"/>

1.8,Touch的使用

如果文件不存在创建文件,如果存在,更改最后访问时间为当前系统时间

<touch file="myfile"/>

如果文件不存在创建文件,更改最后访问时间为06/28/2002 2:02 pm

<touch datetime="09/10/1974 4:30 pm">
    <fileset dir="src_dir"/>
</touch>

1.9,Condition的使用

有<ant>,<or>,<not>等tag

<condition property="isMacOsButNotMacOsX">
<and>
   <os family="mac"/>
   <not>
   <os family="unix"/>
   </not>
</ant>
</condition>

1.10,替换replace

<replace file="configure.sh" value="defaultvalue" propertyFile="source/name.properties">
<replacefilter token="@token1@"/>
<replacefilter token="@token2@" value="value2"/>
<replacefilter token="@token2@" value="property.key"/>
</replace>

1.11,调用chmod

<chmod perm="go-rwx" type="file">
<fileset dir="/web">
   <include name="**/*.cgi"/>
   <include name="**/*.old"/>
</fileset>
<dirset dir="/web">
   <include name="**/private_*"/>
</dirset>
</chmod>

1.12,checksum MD5运算

md5文件,然后把值放入ann.bar.MD5属性

<checksum file="ann.bar"/>

md5文件,然后把值放入annbarMD5属性

1 <checksum file="ann.bar" property="annbarMD5"/>

md5目录下的所有文件,然后建立一个.md5文件,把所有的md5值放入

<checksum>
<fileset dir=".">
   <include name="ann*"/>
</fileset>
</checksum>

1.13,Available的使用

如果类存在,则设置属性Myclass.present为true,如果没有就false

<available classname="org.whatever.Myclass" property="Myclass.present"/>

如果文件存在则设置属性jaxp.jar.persent为true,否则为false

<property name="jaxp.jar" value="./lib/jaxp11/jaxp.jar"/>
<available file="${jaxp.jar}" property="jaxp.jar.present"/>

如果目录存在,则设置属性为true,否则为false

<available file="/usr/local/lib" type="dir" property="local.lib.present"/>

如果classpath下寻找class,存在则设置属性为true,否则为false
在工程tag下定义path,在target中使用

<property name="jaxp.jar" value="./lib/jaxp11/jaxp.jar"/>
<path id="jaxp" location="${jaxp.jar}"/>
<available classname="javax.xml.transform.Transformer" classpathref="jaxp" property="jaxp11.present"/>

如果在classpath下发现文件则设置属性为true,否则为false

<available property="hava.extras" resource="extratasks.properties">
<classpath>
   <pathelement location="/usr/local/ant/extra.jar"/>
</classpath>
</available>

6.14,设置property

设置属性name-value

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

读取属性文件中的属性配置

<property file="ann.properties"/>

读取网络中的property-set

<property url="http://www.mysite.com/bla/props/ann.properties"/>

读取文件中的属性配置

<property resource="ann.properties"/>

读取环境变量

<property environment="env"/>

读取属性文件中的属性,并作为全局引用

<property file="/Users/antoine/.ant-golbal.properties"/>

1.15,错误处理

显示错误:

1）<fail>something wrong here.</fail>
2）<fail message="${属性}"/>

如果这个属性不存在显示错误:

<fail unless="failCondition" message="unless Condition"/>

如果这个属性存在显示错误

<fail if="failCondition" message="if Condition"/>

如果符合条件显示错误,(这里的条件是没有设置属性):

<fail message="tag condition">
<condition>
   <not>
    <isset property="failCondition"/>
   </not>
</condition>
</fail>

1.16,建立一个目录

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

1.17,打jar包

<jar destfile="${dist}/lib/app.jar" basedir="${build}/classes"/>

或者

<jar destfile="${dist}/lib/app.jar" basedir="${build}/classes" includes="mypackage/test/**" excludes="**/Test.class"/>

1.18,打Ear包

<ear destfile="build/myapp.ear" appxml="src/metadata/application.xml">
　　<fileset dir="build" includes="*.jar,*.war"/>
</ear>

1.19,执行程序

<target name="help">
<exec executable="cmd">
   <arg value="/c"/>
   <arg value="ant.bat"/>
   <arg value="-p"/>
</exec>
</target>

1.20,运行jar包

带参数执行:

<java classname="test.Main">
<arg value="-h"/>
<classpath>
   <pathelement location="dist/test.jar"/>
   <pathelement path="/Users/antoine/dev/asf/ant-core/bootstrap/lib/ant-launcher.jar"/>
</classpath>
</java>

设置一下JVM的最大内存,再运行:

<java classname="tset.Main" dir="${exec.dir}" jar="${exec.dir}/dist/test.jar" fork="true" failonerror="true" maxmemory="128">
<classpath>
   <pathelement location="dist/test.jar"/>
   <pathelement path="/Users/antoine/dev/asf/ant-core/bootstrap/lib/ant-launcher.jar"/>
</classpath>
</java>

1.21,编译程序

<javac srcdir="${src}" destdir="${build}" classpath="xyz.jar" debug="on" source="1.4"/>

1.22,制作javadoc

<javadoc ...>
<doclet name="theDoclet" path="path/to/theDoclet">
   <param name="-ann" value="annvalue"/>
   <param name="-bar" value="varvalue"/>
</doclet>
</javadoc>

1.23,定义一个新的task类库

<taskdef name="myjavadoc" classname="com.mydomain.JavadocTask"/>

1.24,运行sql

<sql driver="org.database.jdbcDriver" url="jdbc:database-url" userid="sa" password="pass">
　　insert into table some_talbe values(1,2,3);
　　truncate table some_other_table;
</sql>

1.25,Filter的使用

把所有的@year@替换成2000:

<filter token="year" value="2000"/>
    <copy todir="${dest.dir}" filtering="true">
    <fileset dir="src"/>
</copy>

替换属性文件中的内容:

<filter filtersfile="deploy_env.properties"/>

1.26,Length的使用

把字符串"ann"的长度保存到属性"length.ann"中:

<length string="ann" property="length.ann"/>

把文件"bar"的长度保存到属性"length.bar"中:

<length file="bar" property="length.bar"/>

1.27,发送邮件

<mail mailhost="smtp.myisp.com" mailport="1025" subject="Test build">
<from address="config@myisp.com"/>
<replyto address="me@myisp.com"/>
<to address="all@xyz.com"/>
<message>The ${buildname} nightly build has completed</message>
<attachments>
   <fileset dir="dist">
    <include name="**/*.zip"/>
   </fileset>
</attachments>
</mail>

1.28,压缩,解压缩

解压缩zip文件:

<unzip src="apache-ant-bin.zip" dest="${tools.home}">
<patternset>
   <include name="apache-ant/lib/ant.jar"/>
</patternset>
<mapper type="flatten"/>
</unzip>

压缩zip文件:

<zip destfile="${dist}/manual.zip" basedir="htdocs/manual" includes="api/**/*.html" excludes="**/todo.html"/>

打tar包:

<tar destfile="Users/antoine/dev/asf/ant-core/docs.tar">
<tarfileset dir="${dir.src}/docs" fullpath="/usr/doc/ant/README" preserveLeadingSlashes="true">
   <include name="readme.txt"/>
</tarfileset>
<tarfileset dir=${dir.src}/docs" prefix="usr/doc/ant" preserveLeadingSlashes="true">
   <include name="*.html"/>
</tarfileset>
</tar>

解tar包:

<untar src="tools.tar" dest="${tools.home}"/>

1.29,打war包

<war destfile="myapp.war" webxml="src/metadata/myapp.xml">
<fileset dir="src/html/myapp"/>
<fileset dir="src/jsp/myapp"/>
<lib dir="thirdparty/libs">
   <exclude name="jdbc1.jar"/>
</lib>
<classes dir="build/main"/>
<zipfileset dir="src/graphics/images/gifs" prefix="images"/>
</war>