ANT使用指南

－. Ant简介

Ant是一款类似make的工具，用来编译/运行/打包Java程序。在构建、包装和发布过程中几乎每一件事都可以由Ant的任务来处理。

二．搭建ANT运行环境 

1、将ant1.6.1解压缩到任意目录，假设解压缩到C:/apache-ant-1.6.1目录中

2、然后在path路径中添加   C:/apache-ant-1.6.1/bin

3、再classpath中添加   C:/apache-ant-1.6.1/lib

三、ANT的组成（主要由三部分组成：Project、Target、Task）

1、Project(项目)。基本属性：name、default、basedir。一个build.xml只能存在一个Project工程。

name ：项目名称

default ：缺省开始执行的Target

basedir ：用于计算所有其他路径的基路径。  

例1：<project name="dev" basedir="." default="dist">   

2、Target。一个项目可以定义一个或多个Target、一个Target是一系列你想要执行的任务，如编译任务、打包任务、混淆任务。    

Target的基本属性： name：target的名字，depends：该target依赖关系，description： target的描述信息。  

例2：<target name="clean" depends="init" description="Clean dist and temp directories">   

Ant在执行时以Target为单位，Target的depends属性又决定了哪个Target先执行，因此我们可以通过Target来构造编译顺序。   

例3：<target name="copy" >
       <target name="javac" depends="copy">

       <target name="jar" depends="javac">

执行顺序是从下至上，依次执行，如果某个Target没有depends属性，那么就顺序执行。  

例4：一个完整的Target：

<target name="compile" depends="replacesrc"   description="Compiling Java source files">

     <javac   srcdir="temp/src"  

             destdir="temp/build"

             debug="on"

             deprecation="false"

             optimize="true">

     <classpath refid="classpath"/>

     </javac>
</target>

3、Task。Ant执行的一系列任务是由Target构成的，而Target又是由数个小的Task构成的，task任务是最小的运行单位，我们可以把copy、delete、mkdir等操作认为是一个小任务。

(1)copy任务。

A．拷贝单个文件:

<copy file="Demo/manifest.mf" todir="temp/build/META-INF" />
解释：把一个文件拷贝到拷贝相关文件夹中。

B．拷贝文件夹：

<copy todir="temp/build">
     <fileset dir="temp/classes"/>
   </copy>
     解释：把temp/build目录下的所有文件，拷贝到temp/classes目录中去

C.替换拷贝
<copy todir="temp/build">
   <fileset dir="temp/classes" includes="*.class" />
   <filterset>
        <filter token="@Time@" value="${app.time}"/>
   </filterset>
</copy>
   解释：   <filterset>过滤集，可以将temp/classes文件夹下的存在@Time@标记的文件，替换为变量${app.time}值。这样在完成拷贝的同时也完成了替换任务。

(2)mkdir任务和delete任务

A．单独的delete和mkdir任务
      <delete dir="temp/src"/>
      <delete file="temp/build/Thumbs.db" />
      <mkdir dir="temp/src"/>
   
    B. 带有条件的删除任务
       <delete>
         <fileset dir="store" includes="*.*"/>
         <fileset dir="source" excludes="*.java"/>                                  </delete>       
       解释：include表示要删除哪些文件；而excludes表示排除的文件；

（3）replace替换任务

A．替换某一文件中的字符串

<replace file ="base/testing.txt">
token="@temp@"
value="${newstring}"
</replace>

解释：token是需要替换的标记；value是新值，将testing.txt文件中的@temp@替换为新值。

B．替换某个文件夹中存在特定标记的文件

<replace dir="temp" token="@CHARSET@" value="${webapp.charset}"/>  

解释：temp目录中文件，如果有存在@CHARSET@标记的，将被替换为${webapp.charset}变量值。

C.批量替换

<replace dir="dist" includes="${app.project}.jad" encoding="UTF-8">

<replacefilter token="@NAME@" value="${app.name}"/>
     <replacefilter token="@VENDOR@" value="${app.vendor}"/>
     <replacefilter token="@MIDLET@" value="${app.midlet}"/>
     <replacefilter token="@JAR@" value="${app.project}"/>
     <replacefilter token="@FILESIZE@" value="${size}"/>
     <replacefilter token="@DESCRIPTION@" value="${app.description}"/>             <replacefilter token="@PRICE@" value="${app.price}"/>

</replace>

(4) javac任务 ,编译源程序

<target name="Compile" description="Compile Java source files">

<javac srcdir="src" destdir="temp/classes" bootclasspath="${compile.classpath}"  target="1.1" debug="on" deprecation="on" includes="*.java" optimize="true" encoding="UTF-8"/>  

</target>

解释：bootclasspath参数（启动类库）：它已经包含了jre/lib目录下的rt.jar，以及我们自定义的类库。如果使用classpath参数，仅指我们定义的类库；

(5) java任务 。为运行Java应用程序，需要使用java任务

A．运行一个类

<target name="run" description="Run the program">

     <java classname="${main}" classpath="${classpath}"/>

</target>

解释：classname表示要运行的主类。 

B．运行某一特定类，并加上运行参数。

<java fork="true" classname="proguard.ProGuard" classpath="${proguard.classpath}">

             <arg line="-libraryjars ${proguard.classpath}"/>

             <arg line="-injars temp/${app.project}_tmp.jar"/>

             <arg line="-outjar temp/${app.project}_obf.jar"/>

             <arg line="-defaultpackage ''"/>

             <arg line="-dontusemixedcaseclassnames"/>

             <arg line="-keep public class ${app.midlet}"/>

</java> 

解释：fork参数：为true时，在新的JVM实例中运行，不影响当前JVM工作

如何减少文件的size?

使用3.3.2版本的proguard.jar,然后在混淆参数中添加两行代码:

<arg line = "-overloadaggressively"/>                   
<arg line="-keepclasseswithmembers public class ${app.midlet} {public void startApp();public void destroyApp(boolean);}"/>

这样可以保证startApp和destroyApp不被打上Final修饰符,同时还能更大的压缩代码,不过要求Midlet类中startApp和destroyApp方法保持上面的形式。

（6）JAR任务

将编译好的CLASS文件打成JAR包，这是JAR任务的工作：

<target name="jar" depends="Compile" description="Build jar file">

<jar jarfile="dist/${name}.jar" basedir="${tmp/class}" manifest="tmp/res/manifest.mf" manifestencoding="UTF-8">

   <fileset dir="res" includes="*.*"/> <!-- 将res目录中的文件也打进JAR包 -->

</jar>

</target>         

（7）exec任务，用以调用外部程序

<exec executable="${LIB_PATH}/preverify.exe">

    <arg line="-classpath ${compile.classpath} -d temp/build temp/obfuscate"/>

</exec> 

四、ANT的参数部分：   

-quiet（不显示大多数build信息）

-verbose（显示构建过程的每个操作的详细信息）

-buildfile filename.xml 构建特定的xml文件

-Dproperty=value 设定特别的外部参数，外部参数可以传递给内部变量

-find filename.xml 它会让ANT自动查找当前的目录、父目录中的xml文件，直到失败   

例：

ant -buildfile test.xml   

使用当前目录下的test.xml运行Ant   

ant -buildfile test.xml dist   

使用当前目录下的test.xml运行Ant，执行一个叫做dist的target。  

ant -buildfile test.xml -Dbuild=build/classes dist   

使用当前目录下的test.xml运行Ant，执行一个叫做dist的target，并设定build变量的值为build/classes。 

五、自定义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>  

解释：file和tofile分别是程序入口、出口。