使用ant 是非常简单的事。通常的做法就是在你的项目里面建立一个XML文件,名字通常可以取 build.xml 。当然你可以取任何你喜欢的名字。这个文件就是你需要ant为你项目做的一些辅助性工作的批处理文件。
一、介绍
<?xml version="1.0" encoding="UTF-8"?>
<project default="all" name="pluto-project" basedir=".">
<target name="all" depends="api, Container, portal">
</target>
<target name="clean" depends="api-clean, container-clean, portal-clean">
</target>
<target name="api">
<property name="final.name" value="portlet-api-@@DATE@@"/>
<ant antfile="build.xml" dir="api" target="jar" inheritAll="false" />
</target>
<target name="api-clean">
<ant antfile="build.xml" dir="api" target="clean" inheritAll="false" />
</target>
<target name="container" depends="api">
<ant antfile="build.xml" dir="container" target="jar" inheritAll="false" />
</target>
<target name="container-clean">
<ant antfile="build.xml" dir="container" target="clean" inheritAll="false" />
</target>
<target name="portal" depends="container">
<ant antfile="build.xml" dir="portal" target="jar" inheritAll="false" />
</target>
<target name="portal-clean">
<ant antfile="build.xml" dir="portal" target="clean" inheritAll="false" />
</target>
</project>
分析:
这个build.xml 文件引自apache的一个项目。里面可以看到有 project 以及target 标签。
有些项目的build.xml可能不是以<?xml version="1.0" encoding="UTF-8"?>开头的,不过没关系,以后再说明。
每一个build.xml 只能有一个project 标签,每个project 标签里面包含了几个tartget标签。
每一个target可以独立执行或者依赖于其他target,如果是依赖其他target,则必须所依赖的target执行完毕才能该执行。
以下是一个典型的例子。
<target name="A"/>
<target name="B" depends="A"/>
<target name="C" depends="B"/>
<target name="D" depends="C,B,A"/>
当中target A 可以独立执行,但是B、C、D 则依赖于其他target才可以执行,也就是说,执行D, ant 就会按照 A- B- C 这样的顺序先执行其他target。
二、build.xml中常用的标签
project
每个构建文件都有一个project标签,有以下属性:
- default:表示默认的运行目标,这个属性是必须的。
- basedir:表示项目的基准目录。
- name:表示项目名。
- description:表示项目的描述。
<project default="all" name="pluto-project" basedir=".">
每个构建文件都需要以project标签包含起来。
1、定义变量
在例子中没有看到属性定义,其实如果你想使用定义变量的话,可以在project 标签下 定义如这样的标签
<project ……>
<property name="src" location="src"/>
<property name="build" location="build"/>
<target ……>
</target>
</project>
这样你在target中引用的时候就可以使用形如${build}这样的变量了,省得自己去修改每一处需要用到变量的地方
<target name="init">
……
<mkdir dir="${build}"/>
……
</target>
2、添加目录操作
<target name="init">
<mkdir dir="${dist.dir}" />
<mkdir dir="${dist.classes.dir}" />
<mkdir dir="${dist.webapps.dir}" />
</target>
这里的dist.dir 等用${}括起来的,是我们定义的变量。
3、编译java文件的操作
<target name="compile">
<javac srcdir="${src.dir}" destdir="${dist.classes.dir}" debug="true" encoding="GBK">
<classpath refid="classpath" />
</javac>
<jar destfile="${dist.classes.dir}/lib/app.jar" basedir="${dist.classes.dir}"/>
</target>
这里说一下 javac 这个任务标签
其中看到 有 srcdir 、destdir、debug 、encoding 等属性,还有一个 classpath 的子标签。srcdir就是目标source,需要编译的源文件,destdir就是目的地,编译出来的class的存放地。Debug参数是指明source是不是需要把debug信息编译进去,如果不加这个参数等于在命令行后面加上 -g:none 这个参数。Encoding 这个参数指明以何种编码方式编码你的source文件,对于有中文文字的代码来说这项比较重要。
classpath 指明了你需要应用的jar包,或者其它class文件的所在地,这也是非常重要的一项选项。使用方式有以下几种。
<property name="lib.dir" value="${basedir}/lib" />
……
<path id="classpath">
<fileset dir="${lib.dir}">
<include name="*.jar"/>
</fileset>
</path>
……
<classpath refid="classpath" />
作为classpath 引用预先定义的jar包位置,refid 指明了一个引用变量。一般在real-world情况下会这样使用。
如果需要引用的jar只有一个,简单的使用是这样的:
<javac srcdir="${src}"
destdir="${build}"
classpath="xyz.jar"
debug="on"
/>
这就简单了点。
4、打jar包操作
<jar destfile="${dist}/lib/app.jar" basedir="${dist.classes.dir}"/>
这个就是把编译好的文件打成jar包的ant 脚本,和上面javac一样,可以放在任意位置。很明显destfile 就是你想要打成的包,basedir就是你的目标class文件,其它的复杂参数手册上都有,可以对照参考。
<jar destfile="${dist}/lib/app.jar">
<fileset dir="${build}/classes"
excludes="**/Test.class"
/>
<fileset dir="${src}/resources"/>
</jar>
上面这段脚本也很容易理解,excludes属性是剔除某些文件,就是除了Test.class文件以外,把其他编译后的class脚本一起打进app.jar包内。
5、复制文件操作
<copy todir="${dist.webapps.dir}/WEB-INF/lib" overwrite="true" flatten="true">
<fileset dir="${lib.dir}">
<include name="*.jar" />
<exclude name="j2ee.jar" />
</fileset>
</copy>
上面脚本很容易理解。 todir 指定了需要拷贝的地点,overwrite 是否需要覆盖,flatten是否忽略目的目录结构,就是不管什么目录,直接拷贝文件到目的地,丢弃其所在结构。
<fileset dir="${lib.dir}">
<include name="*.jar" />
<exclude name="j2ee.jar" />
</fileset>
选定除了j2ee.jar包以外的所有在lib.dir变量所定义的包下面的jar包
include 属性是包含哪些文件,exclude 属性是剔除哪些文件。
其它拷贝样式
文件到目录拷贝
<copy file="myfile.txt" todir="../some/other/dir"/>
目录对拷贝
<copy todir="../new/dir">
<fileset dir="src_dir"/>
</copy>
比较有用的命令
<copy todir="../backup/dir">
<fileset dir="src_dir"/>
<filterset>
<filter token="TITLE" value="Foo Bar"/>
</filterset>
</copy>
拷贝 sr_dir 目录到 backup/dir目录,并且把所有文件中的 @TITLE@ 替换成 Foo Bar 。还有很多用法,等到要使用的时候可以去查手册。
6、删除操作
<target name="clean">
<delete dir="${dest.dir}"/>
<delete file="${dest2.dir}"/>
</target>
以上操作也是很容易理解的。
三、执行ant 脚本
在有build.xml 的目录提示符下使用 ant 就可以了。如果是其他的名字,那就使用ant -buildfile <文件名> 就可以了。
其它的就是在具体开发过程中real-world式的比较经典的一些操作。比方说利用XDoclet自动生成hibernate配置文件,执行SQL脚本,这些会在后续介绍中详细描述用法。掌握了它们,你就是会在生产过程中大大提高工作效率,别人也会对你刮目相看的,别忘了和你的同事分享哦。