无思

本BLOG只用于个人资料收藏,内容如非注明,均为转贴资料,无意侵犯版权,特此声明!

  博客园 :: 首页 :: 博问 :: 闪存 :: 新随笔 :: 联系 :: 订阅 订阅 :: 管理 ::
    Ant  介绍以及基本使用指南

Ant 是著名 Java 开源组织 Apache 的一个项目,是一个基于 java 的 build 工具。它可以使你通过 ant 脚本语言,自动你的项目拷贝到某个目录,发布项目,或者生成一些代码,执行 SQL 语言。总之它可以帮助你完成项目开发中除了开发代码以外的大部分辅助性工作。为什么需要手工去编写 ant 脚本呢,很多 IDE 工具会为我们生成 ant 脚本阿?有人会这么问。要知道靠 IDE 自动生成的东西,总是有这样那样的缺点,以及不足,他不能完全满足你的很多需要。如果出现了问题,你不得不手动修改 ant 脚本,这时候如果你不了解 ant 那么你将会一筹莫展。所以为了能使自己的项目变得更专业化,或者想在领导面前 show 一下的话 ( 有时候很有用 ) 。还是了解一下 ant 吧。

 
Ant 的安装使用

 
安装

Ant 安装很简单,只要你从 apache 网站上下载他的 zip 包,然后解压到任何本地磁盘上,在环境变量中添加 Path 的值加上 %ANT_HOME%/bin 就可以了,这样在 Dos 提示符中就可以使用 ant 这个命令了。其他的你需要设置一下 ANT_HOME 这个环境变量为你解压后的目录。还有就是你要检查一下你的 JDK 安装目录 JAVA_HOME 是不是加到你的环境变量里面去了。

 
使用

概述

 

使用 ant 也同样是非常简单的事。通常的做法就是在你的项目里面建立一个 XML 文件,名字通常可以取 build.xml 。当然你可以取任何你喜欢的名字。这个文件就是你需要 ant 为你项目做的一些辅助性工作的批处理文件。他的格式可能是这样的。我们先不具体说 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 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 。

Project 标签里面有一个 default="all" ,这就是说明了在默认情况下 all 这个 target 会被执行。

 

定义变量

 

在这个文件中没有看到属性定义,其实如果你想使用定义变量的话,可以在 project 标签下 定义如这样的标签

<project ……>

<property name="src" location="src"/>

  <property name="build" location="build"/>

<target ……>

这样你在引用的时候就可以使用形如 ${build}

<target name="init">

……

<mkdir dir="${build}"/>

……

  </target>

这样的变量了,省得自己去修改每一处需要用到变量的地方

 

 

添加目录操作

 

<target name="init">

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

              <mkdir dir="${dist.classes.dir}" />

              <mkdir dir="${dist.webapps.dir}" />

       </target>

 

这里的 dist.dir 等用 ${} 括起来的,是我们定义的变量。

 

编译 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 情况下会这样使用。简单的使用是这样的:

<javac srcdir="${src}"

         destdir="${build}"

         classpath="xyz.jar"

         debug="on"

  />

 

这就简单了点。

 

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

 

上面这段脚本也很容易理解,就是除了 Test.class 文件以外,把一个 source 的 resource 目录,连同编译后的 class 脚本一起打进 app.jar 包内。

 

复制文件操作

 

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

 

 

其它拷贝样式

 

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

单文件拷贝

<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 。还有很多用法,等到要使用的时候可以去查手册。

 

 

删除操作

 

<target name="clean">

              <delete dir="${dest.dir}"/>

              <delete file="${dest2.dir}"/>

       </target>

 

以上操作也是很容易理解的。

 

 

 

 

 

 

 

执行 ant 脚本

 

在有 build.xml 的目录提示符下使用 ant 就可以了。如果是其他的名字,那就使用 ant -buildfile < 文件名 >   就可以了。

 

 

 

其它的就是在具体开发过程中 real-world 式的比较经典的一些操作。比方说利用 XDoclet 自动生成 hibernate 配置文件,执行 SQL 脚本,这些会在后续介绍中详细描述用法。掌握了它们,你就是会在生产过程中大大提高工作效率,别人也会对你刮目相看的,别忘了和你的同事分享哦。

 

 

 

 

作者: Spike Spiegel ,

Blog: http://blog.csdn.net/hk2000c/

 

About copyright :欢迎转载,请注明作者。

 

 

 

参考资料

Apache Ant 主站: http://ant.apache.org/    
posted on 2006-07-12 12:17  kavenmo  阅读(3561)  评论(0编辑  收藏  举报