Apache Ant 实例介绍，以及部分标签介绍

 实际上呢，我想各位也很清楚，ASF在Java开源领域的地位，我们常常需要用到它的一些开源项目，我们学习他，研究他，甚至于参与开发他。每每我们download项目的时候，项目通常是Ant/Maven这两个跨平台的构件工具 进行编译发布，再加上前些日子一朋友问我关于Maven如何发布项目，这就促使了我决定学习这两个构件工具。说来惭愧，到目前为止，还没有动用过这两个东西来发布项目过，全部是MyEclipse->Deployments->Run Server。罢了，今儿开始，学习一下看看。当然了，这一切的学习成果和资料来源都来自各位前辈的劳动成果。

  Ant和Maven的优劣区别在这里就不再说了，在本篇，着重先来了解一下Ant：

  1下载安装：

     下载apache-ant-1.8.2-bin.zip ；

      解压ant的包到本地目录；  
      在环境变量中设置ANT_HOME，值为你的安装目录；    
      把%ANT_HOME%/bin加到你系统的path中；

      在CMD模式下，输入ant -version，回车，如果看到如下信息：

            

     则表示你已成功安装Ant，当然了，这一切的保证就是你必须安装了JDK。没有什么大问题，OK，跑个小例子看看：

  2 HelloWorld：

     在任一磁盘里新建一个antDemo的目录， 此文中的所有的示例均在此目录下，感兴趣的朋友不妨下下来看看。

     1)建立基本的Java工程：

        1-1）在antDemo目录下，建立名为antstudy的Java工程，在此工程下建立一src目录存放源代码，在src目录下建立HelloWorld.java，HelloWorld的具体内容如下：

 

Java代码  

1. public class HelloWorld{  
2.     public static void main(String[]args){  
3.         System.out.println("Hello,ant!");  
4.     }  
5. }  

        没有IDE工具怎么编译运行此文件夹来着？！呵呵~cmd模式下javac/java！

        OK，现在我们用Ant来编译此文件，编译后将HelloWorld.java对应的class文件存放在build/classes目录下：

        在antstudy的Java工程下，建立一build.xml文件，ant默认解析此文件。在编译之前，需清除classes目录，然后再建立一个新的build/classes目录，再将HelloWorld.java编译到此目录下，build.xml的内容如下：

 

Xml代码  

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <project name="antStudyProj" default="compile" basedir=".">  
3.     <property name="classdir" value="build/classes"/>  
4.     <target name="clean">  
5.         <delete dir="${classdir}"/>         
6.     </target>  
7.       
8.     <target name="compile" depends="clean">  
9.         <mkdir dir="${classdir}" />  
10.         <javac srcdir="src" destdir="${classdir}" />  
11.     </target>  
12. </project>  

   现在来运行一下看看，指定到antstudy目录，输入ant，看看控制台的输出信息：

     

    经过一系列的clean->compile，我们看到build/classes目录下，编译成功了HelloWorld.class.

   1-2）编译成功了是没错，得输出结果吧，我们得向我们的ant say hello一下啊，所以看看Ant是如何运行此文件的：

   修改build.xml，在上面两个target后新增一个名为run的target，并将project的default属性修改为run,具体的内容参见附件代码，现贴出target代码如下：

 

Xml代码  

1. <target name="run" depends="compile">  
2.     <java classname="HelloWorld">  
3.         <classpath>  
4.             <pathelement path="${classdir}"/>  
5.         </classpath>  
6.     </java>  
7. </target>  

   再次在控制台输入ant，输出信息如下所示：

   

   OK，Hello,ant!的信息也打印出来了，总算大功一件告成!

   1-3）还有一个功能比较的重要：打jar包。这个重要的功能当然不能忘，这得需要用到Ant的jar标签，该标签对应Java的jar命令。新建一个名为jar的target，并依赖于run，修改project的default属性为jar，现贴出此target标签的代码：

 

Java代码  

1. <target name="jar" depends="run">  
2.     <jar destfile="helloworld.jar" basedir="${classdir}">  
3.         <manifest>  
4.             <attribute name="Main-class" value="HelloWorld"/>  
5.         </manifest>  
6.     </jar>  
7. </target>  

  保存完毕后，同样输入ant，我们就可以看到antStudy目录下多了一个helloworld.jar：

  

   2）编译发布JavaEE项目：

    建立一JavaEE Web项目，目录结构如下:

                                         

    其中src目录存放源代码（暂将上一节的HelloWorld.java文件拷贝至此目录下），WebRoot存放各类的html/jsp文件等，lib下自然是放各类的jar包了，build/classes是存放src下的编译文件。在WebRoot目录下新建一index.jsp文件。建立打包andWebStudy项目的build.xml,具体内容如下：

 

Xml代码  

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <project name="antwebproject"  default="war" basedir=".">  
3.     <property name="classes" value="build/classes"/>  
4.     <property name="build" value="build"/>  
5.     <property name="lib" value="WebRoot/WEB-INF/lib"/>  
6.      
7.     <target name="clean">  
8.        <delete dir="${build}"/>  
9.     </target>  
10.   
11.     <target name="compile" depends="clean">  
12.        <mkdir dir="${classes}"/>  
13.        <javac srcdir="src" destdir="${classes}"/>  
14.     </target>  
15.   
16.     <target name="war" depends="compile">  
17.     <war destfile="${build}/antwebproject.war" webxml="WebRoot/WEB-INF/web.xml">  
18.         <fileset dir="WebRoot" includes="**/*.jsp"/>  
19.             <lib dir="${lib}"/>  
20.             <classes dir="${classes}" />  
21.       </war>  
22.     </target>  
23. </project>  

   完成之后，指定到antWebStudy目录，输入ant,我们看看控制台的信息如下：

   

  打包成功后，我们可以看到build目录下，多出了一个antwebproject.war文件，将此文件扔到tomcat的webapp目录下，在浏览器里输入http://localhost:8080/antwebproject/，便可看到运行结果了。当然了，我们也可以直接指定服务器的运行目录，这样可省得再拷贝了，怎么搞呢？！被你发现了，war标签的destfile属性修改一下即可了！

下载：antDemo.rar

------------------------------------------------------------------------------------------------------------------------------------------

Apache Ant常用标签介绍

  在上一篇博文中简单介绍了一下Ant是如何编译和发布Java项目，对使用用的一些标签命令也没有做说明，现在该是做说明的时候了。

  我们都看到了，Ant的构件文件是基于XML的，默认加载执行build.xml，project元素构成了Ant文件的根元素，Ant构件文件至少应该包含一个project元素。在每个project元素下，可以包含多个target元素，target就是Ant构件所要做的事情，现在列个简单的build.xml来加深一下对文件结构的印象：

 

Xml代码  

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <project name="helloProj">  
3.     <target name="sayHello">  
4.         <echo message="Hello,Ant!"></echo><!-- 该标签用于输出指定的文本信息-->  
5.     </target>  
6. </project>  

  进入到指定目录antDemo，在控制台输入ant ,回车：

  

  相信你一定看出问题了，sayHello没有输出，事实是这样的，一个project元素下有多个target，如果你不在build.xml文件中或者在命令行指定target，那么Ant怎么知道你要去执行哪一个target，所以可通过以下方法解决，project元素有一属性default，就是指定默认执行的target名；另一个方法就是命令行输入ant （指定target）;我们采用第一种方式：

 

Xml代码  

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <project name="helloProj" default="sayHello">  
3.     <target name="sayHello">  
4.         <echo message="Hello,Ant!"></echo>  
5.     </target>  
6. </project>  

  所以，在控制台输入ant，并出现了Hello,Ant!的打印信息了。

  前面我们聊到了，Ant是默认加载执行build.xml，如果我们依个人喜好，没有指定这样的一个默认的build.xml文件，而是指定了build_helloProj.xml，在控制台输入肯定会出错，毫无疑问，那么怎么加载这样一个另指定的文件呢，命令行参数就需要做些少许改变了，可通过如下命令参数

 

Java代码  

1. ant -f build_helloProj.xml  
2. ant -file build_helloProj.xml  
3. ant -buildfile build_helloProj.xml  

  命令控制台输出如下信息：

  

  更具体的命令行参数使用方法，可在控制台输入ant -help/ant -h查看，在此就不列出了。

  Ant的关键元素和常用元素语义说明：

  1）project:

    ant构件文件的根元素，这个是必须的元素噢！它的三个属性我们都已经见到过了，分别为name、default、basedir。name属性就是指定project的名称了；default属性用于指定project默认执行的target名称；basedir属性用于指定基路径的位置，没有指定或者指定为"."，则为Ant构件文件的附目标作为基准目录。看应用build_showbasedir.xml示例：

 

Xml代码  

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <project name="antElementLearnProj" default="printBaseDir" basedir=".">  
3.     <target name="printBaseDir">  
4.         <echo message="The base dir is: ${basedir}"></echo>  
5.     </target>  
6. </project>  

 

  结果显示如下：

   

 

  2）target:

    Ant的基本执行单元，它可以包含一个或多个具体的执行任务。多个target可以存在相互依赖关系(depends属性),所以，看看它的一些属性：

   name属性指定target的名称，这是属性是project元素中唯一的；depends属性用于描述多个target之间的依赖关系，被依赖的先执行。比如，我们运行一个java程序之前必须先编译它，所以，我们在运行的target中指定depends依赖于编译的target。如果与多个target存在依赖关系，则要用","间隔。Ant会依照depends属性中的target出现的顺序依次执行每个target;if属性验证执行此target的成立条件；unless属性与if属性相反，验证指定属性为假时所在的target执行;description属性是对此target功能的简短描述和说明，看build_targetElement.xml示例：

 

Java代码  

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <project name="antTargetElementLearnProj" default="target_b" basedir=".">  
3.   <target name="target_a"  if="ant.java.version">  
4.      <echo message="Java Version: ${ant.java.version}"/>  
5.   </target>  
6.   <target name="target_b" depends="target_a"   
7.         unless="targetdemo" description="a depend example!">  
8.       <echo message="The base dir is: ${basedir}"/>  
9.   </target>  
10. </project>  

  在控制台输入ant -f build_targetElement.xml，显示信息如下图所示：

   

   我们运行的是名为target_b的target，因为它依赖于名为target_a的target,所以先执行target_a,运行Ant,java环境肯定存在，所以打印信息：Java Version:1.6。target_a执行完毕之后，接着执行名为target_b的target，targetdemo属性不存在，所以打印出当前的根目录。

  3）property :

    该元素说得直白些，就是一变量，project里的属性可通过property元素来设定，也可在外部引入一文件，例如build.properties(一定程度上可增加系统的维护性，一些开源项目常这么干)，可通过如下方式引入：<property file="build.properties"/>。

   在引用property元素时，可通过将属性名放在"${"和"}"之间，当然了，Ant本身也提供一些内置属性，另外它也能得到的系统属性列表与Java文档中的System.getProperties()方法得到的属性一致，Ant的内置属性包括basedir（）、ant.file、ant.version、ant.project.name、ant.java.version，下面我们来看一个简单的property示例build_propertyElemet.xml：

 

Xml代码  

1. <?xml version="1.0" encoding="UTF-8"?>  
2.     <project name="antPropertyElementLearnProj" default="printPro" basedir=".">  
3.     <property name="name" value="Kevin"/>  
4.     <property name="age" value="25"/>  
5.     <target name="printPro">  
6.         <echo message="The current ant version is:${ant.version}"/>  
7.             <echo message="name: ${name}, age: ${age}"/>  
8.     </target>  
9. </project>  

   在控制台上输入ant -f build_propertyElement.xml，信息输出如下图所示：

   

  从输出信息，我们可以看到通过property元素设定了名为name和age的属性，然后在后面通过${name}和平${age}引用，当然，也包括了Ant的内置属性${ant.version}。

   Ant常用的命令任务：

  我们知道，在Ant中，任务是Ant工具的最小执行单位。在antDemo目录下再新建一目录antTask，在这下面，我们来看看Ant常用的任务：

  1）copy任务 ：该标签主要用来对文件、目录的复制，看看示例build_copyTask.xml：

 

Xml代码  

1. <?xml version="1.0" encoding="GBK"?>  
2. <project name="copyTaskProj" default="" basedir=".">  
3.     <!--单个文件复制：将上一个目标的build.xml拷贝到当前，并另命名为buildDir_copy.xml -->  
4.     <copy file="../build.xml" tofile="buildDir_copy.xml"/>  
5.     <!--目录复制：将上一级目录的antStudy拷贝到antStudy_copy -->  
6.     <copy todir="antStudy_copy">  
7.        <fileset dir="../antStudy"/>  
8.     </copy>  
9.     <!--文件复制到文件夹：将buildDir_copy.xml拷贝到buildCopy文件夹内 -->  
10.     <copy file="buildDir_copy.xml" todir="buildCopy"/>  
11. </project>  

   具体这些copy任务要做的事情，我已经做了相应的注释，前面说过，任务是Ant工具最小的执行单位，所以我们不必把copy放入target也一样可以执行，当然了，也可把相应的任务放入target标签。另外需要说明的是，copy标签的源文件必须要存在，否则会报文件找不到而导致编译不通过，输入ant参数命令，执行结果如下图所示：

   

   执行完毕之后，我们再看本地磁盘，执行成功！

  2）delete任务 ：对文件或目录进行删除，看看示例代码build_delTask.xml：

 

Xml代码  

1. <?xml version="1.0" encoding="GBK"?>  
2. <project name="delTaskProj" default="" basedir=".">  
3.     <!--删除某个文件 -->  
4.     <delete file="buildDir_copy.xml"/>  
5.     <!--删除某个目录-->  
6.     <delete dir="antStudy_copy"/>  
7.     <!--删除当前所有的备份目录或空目录 -->  
8.         <delete includeEmptyDirs="true">  
9.              <fileset dir="." includes="**/*.bak"/>  
10.     </delete>  
11. </project>  

   没啥可说的，需要说明的是一些通配符的使用:

   *符号代表0个或者多个字符；？符号代表一个字符；**代表当前目录及其所有子目录。

  3）mkdir任务 ：创建目录，看示例代码build_mkdirTask.xml：

 

Xml代码  

1. <?xml version="1.0" encoding="GBK"?>  
2. <project name="mkdirTaskProj" default="" basedir=".">  
3.     <!--创建一build目录 -->  
4.     <mkdir dir="build"/>  
5. </project>  

   具体的运行方式以及控制台执行结果不再贴出了，有兴趣的朋友不妨在自己的机器上试试。

  4）move任务 ：移动文件或目录，看示例代码build_moveTask.xml：

 

Xml代码  

1. <?xml version="1.0" encoding="GBK"?>  
2. <project name="moveTaskProj" default="" basedir=".">  
3.     <!-- 移动单个文件 -->  
4.     <move file="testMove.txt" tofile="justMove.txt"/>  
5.   <!-- 移动单个文件到另一个目录-->  
6.   <move file="testMove2.txt" todir="movedir"/>  
7.   <!-- 移动某个目录到另一个目录-->  
8.   <move todir="newdir">  
9.      <fileset dir="movedir"/>  
10.   </move>  
11. </project>  

  5）echo任务 ：该任务在上面我们使用它来输出信息，它还可根据日志或监控器的级别输出信息，包括message、file、append和level属性：

 

Xml代码  

1. <?xml version="1.0" encoding="GBK"?>  
2. <project name="echoTaskProj" default="" basedir=".">  
3.     <!--追加Hello,Kevin到logs目录下的system.log文件里 -->  
4.   <echo message="Hello,Kevin" file="logs/system.log" append="true" />  
5. </project>  

 至此，我们对Ant的一些常用命令的解析就到此结束了，当然了，Ant的标签元素肯定不止这么多，那没有文档和说明，我哪里又知道有哪些元素可用呢，所以得获取build.xml文件的*.dtd文件！为此，下面一个build_getDtd.xml或许会对你有所帮助:

 

Xml代码  

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <project name="dtdProj" default="getdtd">  
3.     <target name="getdtd">  
4.         <antstructure output="build.dtd"/>  
5.     </target>  
6. </project>  

  这个也是我从网上搜索出来的，执行完毕之后，会在当前目录生成一个build.dtd的文件，希望会对你有所帮助。此外，此博客所涉及到的所有代码均在附件antDemo.rar 里。

 -------------------------------------------------------------------------------------------------------------------------------------

我在此，感谢本文的原作者和原二作者，他们的分享让我对ant有了一定得了解，知道了一些基本的部署管理小程序或者项目的方法

-----------------------------------------------------------------------------------------------------------------------