Ant学习笔记

大部分内容是从官网手册翻译来的，有的地方翻译不恰当，请读者多多包涵。

一、ant简介

假设我有这么一系列的操作要做：

我已经写好了一个java源代码项目。

1.我要在某个目录下新建一个文件夹。

2.把项目编译成classes文件，并且放到新建的那个文件夹里

3.最后运行这个项目。

一共三个步骤，我们可以使用ant来帮助我们，一行命令行全部实现。

ant基于使用xml文件配置、使用java classes，替代了写命令行的模式。xml文件里的树状可包含各种各样的任务。每一个任务的执行都是ant通过实现一个特别的Task接口的对象来执行的。其核心就是xml配置文件，可以理解为，ant是一个多任务集合一起处理的工具。

二、ant安装

1.安装jdk，并且设置环境变量

2.下载ant，网址：http://ant.apache.org/bindownload.cgi。我这里下载的是windows的版本(.zip拓展名的)，版本号是apache-ant-1.8.4-bin.zip。

下载好后，解压都某个目录。我解压到了我的F盘，目录结构为：F:\apache-ant-1.8.4

然后将F:\apache-ant-1.8.4\bin目录设置到环境变量里:

ANT_HOME=F:\apache-ant-1.8.4\

然后在path路径添加：%ANT_HOME%\bin;

最后dos里运行ant，如果显示结果是这样子的，那么环境就配置好了：

Buildfile: build.xml does not exist!
Build failed

三、ant文件配置

1.ant的配置文件使用xml文件编写的。每一个配置文件包含一个project以及至少一个(默认的)target。Targets包含多个task标签。每一个task标签可以有一个id属性值，此id属性值可以被其他的标签引用。id是唯一的。

可以把他们这么理解：

project-->项目

target-->任务集(多个任务集合)

task-->单个任务

2.project标签的属性;

          name:项目的名称

          default:当没有指定执行某个target时，会执行default指定的target

         每一个project定义一个或者多个target。一个targt是你想执行的一系列的task集合。当使用ant时，你可以选择你想执行的一个(或者多个)target。当你不执行任务一个task时，会执行default标记的task。

3.一个target可以依赖于其他的target。例如，你可以有一个target用来编译，一个target用来发布。当你已经编译好了，你可以只是构建一个发布，所以发布target依赖于编译target。

4.一个task是一个可以被执行的代码片段。

5.一个task可以有多个属性。这些属性的值可以包含引用到另一个属性。这些引用会在这个task执行之前被处理。

6.task有着通用的结构：

      <name attribute1="value1"attribute2="value2" ... />

7.name就是task的名称，attributeN就是属性N的名称，valueN就是属性N的值。

8.ant已经提供一系列的task，当然你也可以自定义task。

9.所有的task都有一个task标签名称。这个标签名称将被ant在生成日志信息时使用。

10.task可以标记一个id属性：

       <taskname id="taskID" ... />

taskname就是task的名称，taskID就是这个task的唯一指定编号。你可以在脚本代码中通过这个名称引用到符合的task对象。例如：在脚本里你可以这么写：

<script ... >

  task1.setFoo("bar");

</script>

在构成配置文件中，property是非常重要的方式来定制执行或者提供string重复使用的快捷方式。

一个配置文件的例子：

<project name="MyProject" default="dist" basedir=".">    <description>        一个简单的配置文件的例子    </description>  <!-- 配置这个文件的一些全局属性-->  <property name="src" location="src"/>  <property name="build" location="build"/>  <property name="dist"  location="dist"/>  <target name="init">    <!-- 创建时间戳 -->    <tstamp/>    <!-- 创建用来编译的文件目录路径 -->    <mkdir dir="${build}"/>  </target>  <target name="compile" depends="init"        description="compile the source " >    <!-- 从src里编译java代码到build里 -->    <javac srcdir="${src}" destdir="${build}"/>  </target>  <target name="dist" depends="compile"        description="generate the distribution" >    <!-- 创建发布路径 -->    <mkdir dir="${dist}/lib"/>    <!-- 把在build的所有文件导成MyProject-${DSTAMP}.jar文件 -->    <jar jarfile="${dist}/lib/MyProject-${DSTAMP}.jar" basedir="${build}"/>  </target>  <target name="clean"        description="clean up" >    <!-- 删除build和dis目录树 -->    <delete dir="${build}"/>    <delete dir="${dist}"/>  </target></project>

再举两个例子(从别处参考来的)：

一般项目中的ant结构：

<project default="init"><property name="src" value="src"/><property name="classes" value="classes"/><property name="dest" value="dest"/><path id="classpath"><pathelement path="${classes}"/></path><target name="help"><echo>help -打印帮助信息</echo><echo>compile -编译java源文件</echo><echo>run -运行程序</echo><echo>build -打成jar包</echo><echo>clean -清楚全部编译生成文件</echo></target><target name="compile"><delete dir="${classes}"/><mkdir dir="${classes}"/><javac srcdir="${src}" destdir="${classes}"/></target><target name="run" depends="compile"><java classname="org.xiazdong.Test" fork="yes"><classpath path="${classes}"/></java></target><target name="build" depends="run"><delete dir="${dest}"/><mkdir dir="${dest}"/><jar destfile="${dest}/Test.jar" basedir="${classes}"><manifest><attribute name="Main-Class" value="org.xiazdong.Test"/></manifest></jar></target><target name="clean"><delete dir="${classes}"/><delete dir="${dest}"/></target></project>

总结一下：

<?xml version = "1.0" encoding="GBK"?><project name="Test" default="" basedir="."><property name="src" value="${basedir}\src"/><property file="${basedir}\a.properties"/><!--path用法1.id属性表示编号，用于被引用--><path id="classpath"><!-- pathelement的用法1.path表示多个目录，用“;”隔开目录2.location表示一个目录--><pathelement path="lib;src"/><pathelement location="lib"/><!--dirset的用法1.dir属性指定根目录2.子元素<include name="    "/>表示包含的目录3.子元素<exclude name="    "/>表示不包含的目录--><dirset dir="lib"><include name="**/*Test*"/><exclude name="**/class"/></dirset><!--filelist的用法1.dir属性指定根路径2.files属性指定文件名的列表，用","隔开--><filelist dir="lib" files="a.xml,b.xml"/><!--fileset用法1.dir属性指出根路径2.子元素<include name="   "/>指定包含的文件名--><fileset dir="lib"><include name="**/*.jar"/></fileset></path><!--target用法1.表示任务,子元素为各种task的集合;--><target name="target1"><!--javac用法1.srcdir表示java文件的目录2.destdir表示class文件的保存目录--><javac srcdir="src" destdir="bin"><!--classpath用法1.refid引用前面的path指定的路径--><classpath refid="classpath"/></javac><!--java用法1.classname表示要运行的类2.fork="yes"一定要写上！！--><java classname="Test" fork="yes"><classpath refid="classpath"/><!--arg表示指定的参数--><arg value="a b c"/></java><!--echo表示输出--><echo>Hello world</echo><!--copy表示复制文件delete表示删除文件mkdir表示创建目录move表示移动文件--><copy file="src.txt" tofile="dest.txt"/><delete dir="src"/><mkdir dir="src"/><move file="src.txt" tofile="dest.txt"/></target></project>

这几个列子中用的task都是ant提供的task，我们也可以自定义task，步骤如下：

1.创建一个java文件，继承org.apache.tools.ant.Task。

2.对于每一个属性，添加标准的javabean的set方法。

3.复写executing方法

例子：

 public class MyVeryOwnTask extends Task {        private String msg;        // The method executing the task        public void execute() throws BuildException {            System.out.println(msg);        }        // The setter for the "message" attribute        public void setMessage(String msg) {            this.msg = msg;        }    }

4、添加一个<taskdef>到project里

 

<?xml version="1.0"?><project name="OwnTaskExample" default="main" basedir=".">  <taskdef name="mytask" classname="com.mydomain.MyVeryOwnTask"/>  <target name="main">    <mytask message="Hello World! MyVeryOwnTask works!"/>  </target></project>

四、ant使用

ant

执行当前目录下的build.xml配置的默认的target.

ant -buildfile test.xml

执行当前目录下的test.xml配置的默认的target.

ant -buildfile test.xml dist

执行当前目录下的test.xml配置的dist名字的target.

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

执行当前目录下的test.xml配置的dist名字的target，设置build属性到build/classes

ant -lib /home/ant/extras

从/home/ant/extras路径添加jar包

ant -lib one.jar;another.jar

ant -lib one.jar -lib another.jar

添加两个jar包到ants环境变量。