ANT标签详解

ANT标签详解
1、<project>标签
每个构建文件对应一个项目,project标签是构建文件的跟标签,它可以有多个内在属性,各个属性的含义分别如下所示：
default表示默认的执行目标,这个属性是必须的。
basedir表示项目的基准路径,这个属性是必须的。
name表示项目名称。
description表示项目的描述(或者是对这个标签的作用进行表述)。
每个构建文件都对应于一个项目，但是大型项目经常包含大量的子项目，每一个子项目都可以有自己的构建文件。
2、<target>标签
一个项目标签下可以有一个或多个target标签,一个target标签可以依赖其他target标签,target所有属性如下所示：
name表示这个标签的名字,这个属性是必须的。
depends表示依赖的目标。
if表示仅当属性设置时才执行。
unless表示当属性没有设置时才执行。
description表示项目的描述(或者是对这个标签的作用进行表述)。


Ant的depends属性指定了target的执行顺序,Ant会依照depends属性中target标签出现顺序依次执行每个target,在执行之前首先执行它所依赖的target标签，例如：
项目中的名为run的target的depends属性compile，而名为compile的target的depends属性是init,所以这几个target标签的执行顺序是init—》compile—》run。一个target只能被执行一次，即使有多个target依赖于它。如果没有if或unless属性，target总会被执行。
3、<mkdir>标签
该标签用户创建一个目录,它有一个属性dir用户指定所创建的目录,其代码如下：
<mkdir dir="目录名"/>
4、<jar>标签
该标签用来生成一个JAR包,其属性如下:
jarfile表示生产JAR文件名。
basedir表示被归档的目录。
includes表示别归档的文件模式。
exchudes表示被排除的文件模式。


5、<javac标签>
该标签用于编译一个或一组java文件，其属性如下：
srcdir表示java源程序的目录。
destdir表示class文件的输出目录。
includes表示别归档的文件模式。
exchudes表示被排除的文件模式。
debug表示包含的调试信息。
optimize表示是否使用优化。
classpath表示所使用的类路径。
verbose 表示提供详细的输出信息。
fileonerror表示当碰到错误就自动停止。


6、<java>标签
该标签用来执行编译生成的.class文件，其属性如下:
classname 表示将执行的类名。
jar表示包含该类的JAR文件名。
classpath所表示用到的类路径。
fork表示在一个新的虚拟机中运行该类。
failonerror表示当出现错误时自动停止。
output 表示输出文件。
append表示追加或者覆盖默认文件。


7、<delete>标签
该标签用于删除一个文件或一组文件，其属性如下:
file表示要删除的文件。
dir表示要删除的目录。
includeEmptyDirs 表示指定是否要删除空目录，默认值是删除。
failonerror 表示指定当碰到错误是否停止，默认值是自动停止。
verbose表示指定是否列出所删除的文件，默认值为不列出。


8、<copy>标签
该标签用于文件或文件集的拷贝，其属性如下:
file 表示源文件。
tofile 表示目标文件。
todir 表示目标目录。
overwrite 表示指定是否覆盖目标文件，默认值是不覆盖。
includeEmptyDirs 表示制定是否拷贝空目录，默认值为拷贝。
failonerror 表示指定如目标没有发现是否自动停止，默认值是停止。
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>的所有属性:
values 是一个命令参数,如果参数有空格,但又想将它作为单独一个值,则使用此属性。
file表示一个参数的文件名。在构建文件中，此文件名相对于当前的工作目录。
line表示用空格分隔的多个参数列表。
path表示路径。


2.ervironment 类型
由Ant构建文件调用的外部命令或程序，<env>元素制定了哪些环境变量要传递给正在执行的系统命令，<env>元素可以接受以下属性:
file表示环境变量值得文件名。此文件名要被转换位一个绝对路径。
path表示环境变量的路径。Ant会将它转换为一个本地约定。
value 表示环境变量的一个直接变量。
key 表示环境变量名。


注意  file path 或 value只能取一个。
3.filelist类型
Filelist 是一个支持命名的文件列表的数据类型，包含在一个filelist类型中的文件不一定是存在的文件。以下是其所有的属性:
dir是用于计算绝对文件名的目录。
files 是用逗号分隔的文件名列表。
refid 是对某处定义的一个<filelist>的引用。


注意  dir 和 files 都是必要的，除非指定了refid(这种情况下，dir和files都不允许使用)。
4.fileset类型
Fileset 数据类型定义了一组文件，并通常表示为<fileset>元素。不过，许多ant任务构建成了隐式的fileset,这说明他们支持所有的fileset属性和嵌套元素。以下为fileset 的属性列表。
dir表示fileset 的基目录。
casesensitive的值如果为false，那么匹配文件名时，fileset不是区分大小写的，其默认值为true.
defaultexcludes 用来确定是否使用默认的排除模式，默认为true。
excludes 是用逗号分隔的需要派出的文件模式列表。
excludesfile 表示每行包含一个排除模式的文件的文件名。
includes 是用逗号分隔的，需要包含的文件模式列表。
includesfile 表示每行包括一个包含模式的文件名。


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


6.filterset 类型
Filterset定义了一组过滤器，这些过滤器将在文件移动或复制时完成文件的文本替换。
主要属性如下：
begintoken 表示嵌套过滤器所搜索的记号，这是标识其开始的字符串。
endtoken表示嵌套过滤器所搜索的记号这是标识其结束的字符串。
id是过滤器的唯一标志符。
refid是对构建文件中某处定义一个过滤器的引用。


7.Path类型Path元素用来表示一个类路径，不过它还可以用于表示其他的路径。在用作多个属性时，路径中的各项用分号或冒号隔开。在构建的时候，此分隔符将代替当前平台中所有的路径分隔符，其拥有的属性如下：
location 表示一个文件或目录。Ant在内部将此扩展为一个绝对路径。
refid 是对当前构建文件中某处定义的一个path的引用。
path表示一个文件或路径名列表。


8.mapper类型Mapper类型定义了一组输入文件和一组输出文件间的关系，其属性如下：
classname 表示实现mapper类的类名。当内置mapper不满足要求时，用于创建定制mapper.
classpath表示查找一个定制mapper时所用的类型路径。
classpathref是对某处定义的一个类路径的引用。
from属性的含义取决于所用的mapper.
to属性的含义取决于所用的mapper.
type属性的取值为identity，flatten glob merge  regexp  其中之一，它定义了要是用的内置mapper的类型。








ANT语法


ant(another nice tool) 主要用来编译、运行、测试java代码。此外还可以收发邮件、执行sql以及打jar包和war包……
下载ant。ant有两个版本，二进制版本和原代码版本。
要编译和使用ant，你必须要有一个兼容jaxp的xml解析器。


使用不同的xml解析器应该怎么办？
二进制版本中自己带有了最新的apache xerces2 xml解析器。如果你想用不同的兼容jaxp的解析器，你可以移去ant库目录下的xercesimpl.jar和xml-apis.jar两个文件。你可以要用的解析器放到ant的库目录下，也可以把jars文件放到系统的类路径中。


1.配置
在环境变量中先配置ant_home = F:\sourceCode\apache-ant-1.8.0;
然后再path中添加%ant_home%\bin.到dos界面中输入ant命令，如果出现build fail错误提示，说明设置成功。


2.运行
直接ant命令将打开一个默认的构建文件，即build.xml
如果要调用我们自己的构建文件proj.xml，则需要键入以下命令:ant -buildfile proj.xml
还可以用一条命令显示的执行多个target目标：
ant -buildfile proj.xml clean jar
(意思为执行proj.xml文件中的clean和jar两个target) ，如果不指定target命令，则执行默认的命令,默认的命令在<project name="mytest" default="complie" basedir=".">中的default属性声明。


3.帮助
有些target包括有description属性，而另一些没有。这是因为ant会区别主目标和子目标。包含有描述信息的为主目标，没有描述信息的为子目标，两者只是表达形式上有区别，功能上是完全相同的。你可以键入 ant -projecthelp查看。


4．Ant的Core Tasks


4.1 File（Directory）类


4.1.1 Mkdir


创建一个目录，如果他的父目录不存在，也会被同时创建。


例子：


<mkdir dir="build/classes"/>
说明：如果build不存在，也会被同时创建


4.1.2 Copy


拷贝一个（组）文件、目录


例子：


1.拷贝单个的文件：


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


2.拷贝单个的文件到指定目录下


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


3.拷贝一个目录到另外一个目录下


<copy todir="../new/dir">


<fileset dir="src_dir"/>


</copy>


4.拷贝一批文件到指定目录下


<copy todir="../dest/dir">


<fileset dir="src_dir">


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


</fileset>


</copy>




<copy todir="../dest/dir">


<fileset dir="src_dir" excludes="***.bak"/>


</delete>


4.删除指定目录及其子目录，包括他自己


<delete includeEmptyDirs="true">


<fileset dir="build"/>


</delete>


4.1.4 Move


移动或重命名一个（组）文件、目录


例子：


1.移动或重命名一个文件


<move file="file.orig" tofile="file.moved"/>


2.移动或重命名一个文件到另一个文件夹下面


<move file="file.orig" todir="dir/to/move/to"/>


3.将一个目录移到另外一个目录下


<move todir="new/dir/to/move/to">


<fileset dir="src/dir"/>


</move>


4.将一组文件移动到另外的目录下


<move todir="some/new/dir">


<fileset dir="my/src/dir">


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


</fileset>


</move>


5.移动文件过程中增加。Bak后缀


<move todir="my/src/dir">


<fileset dir="my/src/dir">


<exclude name="**Test.class"


/>


将{build}/classes下面的所有文件打包到{dist}/lib/app.jar中，但是包括mypackage/test／所有文件不包括所有的Test.class


3.<jar destfile="{dist}/lib/app.jar"


basedir="{build}/classes"


includes="mypackage/testTest.class"


manifest="my.mf"


/>


manifest属性指定自己的META-INF/MANIFEST.MF文件，而不是由系统生成


4.3.2 war


对Jar的扩展，用于打包Web应用


例子：


假设我们的文件目录如下：


thirdparty/libs/jdbc1.jar


thirdparty/libs/jdbc2.jar


build/main/com/myco/myapp/Servlet.class


src/metadata/myapp.xml


src/html/myapp/index.html


src/jsp/myapp/front.jsp


src/graphics/images/gifs/small/logo.gif


src/graphics/images/gifs/large/logo.gif


下面是我们的任务的内容：


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


完成后的结果：


WEB-INF/web.xml
WEB-INF/lib/jdbc2.jar
WEB-INF/classes/com/myco/myapp/Servlet.class
META-INF/MANIFEST.MF
index.html
front.jsp
images/small/logo.gif
images/large/logo.gif


4.3.3 ear


用于打包企业应用


例子


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


4.4时间戳


在生成环境中使用当前时间和日期，以某种方式标记某个生成任务的输出，以便记录它是何时生成的，这经常是可取的。这可能涉及编辑一个文件，以便插入一个字符串来指定日期和时间，或将这个信息合并到 JAR 或 zip 文件的文件名中。


这种需要是通过简单但是非常有用的 tstamp 任务来解决的。这个任务通常在某次生成过程开始时调用，比如在一个 init 目标中。这个任务不需要属性，许多情况下只需 <tstamp/> 就足够了。


tstamp 不产生任何输出；相反，它根据当前系统时间和日期设置 Ant 属性。下面是 tstamp 设置的一些属性、对每个属性的说明，以及这些属性可被设置到的值的例子：


属性说明例子


DSTAMP 设置为当前日期，默认格式为yyyymmdd 20031217


TSTAMP 设置为当前时间，默认格式为 hhmm 1603


TODAY 设置为当前日期，带完整的月份2003 年 12 月 17 日


例如，在前一小节中，我们按如下方式创建了一个 JAR 文件：






<jar destfile="package.jar" basedir="classes"/>


在调用 tstamp 任务之后，我们能够根据日期命名该 JAR 文件，如下所示：


<jar destfile="package-{DSTAMP}.jar" basedir="classes"/>


因此，如果这个任务在 2003 年 12 月 17 日调用，该 JAR 文件将被命名为 package-20031217.jar。


还可以配置 tstamp 任务来设置不同的属性，应用一个当前时间之前或之后的时间偏移，或以不同的方式格式化该字符串。所有这些都是使用一个嵌套的 format 元素来完成的，如下所示：


<tstamp>


<format property="OFFSET_TIME"


pattern="HH:mm:ss"


offset="10" unit="minute"/>


</tstamp>


上面的清单将 OFFSET_TIME 属性设置为距离当前时间 10 分钟之后的小时数、分钟数和秒数。


用于定义格式字符串的字符与 java.text.SimpleDateFormat 类所定义的那些格式字符相同


4.5执行SQL语句


通过jdbc执行SQL语句


例子：


1.<sql


driver="org.gjt.mm.mysql.Driver"


url="jdbc:mysql://localhost:3306/mydb"


userid="root"


password="root"


src="data.sql"


/>


2.<sql
driver="org.database.jdbcDriver"
url="jdbc:database-url"
userid="sa"
password="pass"
src="data.sql"
rdbms="oracle"
version="8.1."
>


</sql>


只有在oracle、版本是8.1的时候才执行


4.6发送邮件


使用SMTP服务器发送邮件


例子：


<mail mailhost="smtp.myisp.com" mailport="1025" subject="Test build">
<from address="[e-mail]"/>
<to address="[e-mail]"/>
<message>The {buildname} nightly build has completed</message>
<fileset dir="dist">
<includes name="**/*.zip"/>
</fileset>
</mail>


mailhost： SMTP服务器地址
mailport：服务器端口
subject：主题
from：发送人地址
to：接受人地址
message：发送的消息
fileset：设置附件


五、自定义TASK


ANT已经内置了不少task，像copy、replace、javac等等，但是有时候还需要一些特定的任务来完成操作，比如在生成JAD文件时，需要一个Midlet-Jar-Size的参数，得到JAR文件的大小，但是通过内部的task无法实现，因此可以自己编写类来实现此功能，但必须保证该类是从Task类继承过来的。


例：
<taskdef
name="filesize" classname="ant.FileSizeTask" classpath="${LIB_PATH}/FileSizeTask.jar" />
<filesize file="${Base}/Demo_Build/${jarName}" property="size" />
   <replace dir="store" includes="${jadName}" encoding="UTF-8">
      <replacefilter token="@FILESIZE@" value="${size}" />
</replace>
解释：taskdef：自定义任务，name：任务名 


编写Ant 自定义任务很简单，Ant 能够使用生成文件中指定的对应属性的值来调用这个方法，这个方法的名称需要是 set 加上属性的名称，因此在下面的例子中，我们需要名为 setFile() 和 setTofile() 的两个方法。


当 Ant 遇到生成文件中的一个属性设置时，它会寻找相关任务中具有适当名称的方法（称为 setter 方法）。


生成文件中的属性是作为字符串来指定的，因此我们的 setter 方法的参数可以是一个字符串。在这样的情况下，Ant 将在展开值所引用的任何属性之后，使用该属性的字符串值来调用我们的方法。


但有时我们想把属性的值看作是一种不同的类型。这里的示例任务就是这种情况，其中的属性值引用文件系统上的文件，而不只是引用任意的字符串。可以通过将方法参数声明为 java.io.File 类型来容易地做到这点。


Ant 将接受属性的字符串值，并把它解释为一个文件，然后传递给我们的方法。Ant 能够对其他类型执行类似的转换，比如 boolean 和 int 类型。但如果提供具有相同名称但是具有不同参数的两个方法，Ant 将使用更明确的那一个方法，因此文件类型将优先于字符串类型。


例：一个排序的task任务


public class FileSorter extends Task {
private File file, tofile;
// ant在进行任务处理时会调用execute()方法
     public void execute() throws BuildException {
         System.out.println("Sorting file="+file);
         try {
             BufferedReader from =
                 new BufferedReader(new FileReader(file));
             BufferedWriter to =
                 new BufferedWriter(new FileWriter(tofile));
             List allLines = new ArrayList();
             // read in the input file
             String line = from.readLine();
             while (line != null) {
                 allLines.add(line);
                 line = from.readLine();
             }
             from.close();
             // sort the list
             Collections.sort(allLines);
             // write out the sorted list
for (ListIterator i=allLines.listIterator(); i.hasNext(); ) {
                 String s = (String)i.next();
                 to.write(s); to.newLine();
             }
             to.close();
         } catch (FileNotFoundException e) {
             throw new BuildException(e);
         } catch (IOException e) {
             throw new BuildException(e);
         }
     }
     // file参数
     public void setFile(File file) {
         this.file = file;
     }
     // tofile参数
     public void setTofile(File tofile) {
         this.tofile = tofile;
     }
}


使用这个自定义任务：


<taskdef name="filesorter"   classname=" FileSorter" classpath="filesorter"/>
    <target name="main">
         <filesorter file="input.txt" tofile="output.txt"/>
    </target>