Apache-ant初步了解

Ant是一个Apache基金会下的跨平台的构件工具，它可以实现项目的自动构建和部署等功能。在本文中，主要让读者熟悉怎样将Ant应用到Java项目中，让它简化构建和部署操作。 
 一. 安装与配置
下载地址：http://ant.apache.org/，在本文中下载的是1.9.9版本。解压到某个目录（例如：D:\software\apache-ant-1.9.9）
添加系统环境变量：ANT_HOME，该变量指向Ant解压后的根目录，在此为D:\software\apache-ant-1.9.9。
安装与配置完毕后，读者可以测试一下Ant是否可用，首先进入Ant的bin目录，运行命令ant –version，若安装和配置成功，则会显示Ant版本信息    
由上可以看出，读者运行Ant的命令时，需要进入到Ant的bin目录，如何才能让系统自动找到Ant呢？这时需要读者在系统环境变量path中添加Ant的bin目录。设置完成后，我们就可以在任何目录（例如C:"Documents and Settings"AmigoXie目录）输入Ant的命令，来获得命令的运行结果。
二. Ant的关键元素

Ant的构件文件是基于XML编写的，默认名称为build.xml。为了更清楚的了解Ant，在这里编写一个简单的Ant程序，用来展现Ant的功能，让读者对Ant有一个初步的了解。首先在D盘下建立一个build.xml文件，内容如下：

<?xml version="1.0"?>   
    <project name="helloWorld">     
        <target name="sayHelloWorld">             
        <echo message="Hello,Amigo"/>     
        </target>  
    </project>

读者可以进入D盘，然后运行ant sayHelloWorld

其中sayHelloWorld为需要执行的任务的名称。

如果文件名不为build.xml，而为hello.xml时，读者运行同样的命令时，命令窗口会出现如下错误：

Buildfile: build.xml does not exist!
Build failed

由上面的命令的错误提示可以看出，

ant命令默认寻找build.xml文件。

若文件名为hello.xml时，读者还需要对命令做少许改变，

改为：

ant –f hello.xml sayHelloWorld、

ant –buildfile hello.xml sayHelloWorld、

ant –file hello.xml sayHelloWorld。

Ant的关键元素project、target、property和task。
1. project元素
project元素是Ant构件文件的根元素，Ant构件文件至少应该包含一个project元素，否则会发生错误。在每个project元素下，可包含多个target元素。接下来向读者展示一下project元素的各属性。
1）name属性
用于指定project元素的名称。
2）default属性
用于指定project默认执行时所执行的target的名称。
3）basedir属性
用于指定基路径的位置。该属性没有指定时，使用Ant的构件文件的附目录作为基准目录。
2. target元素
它为Ant的基本执行单元，它可以包含一个或多个具体的任务。多个target可以存在相互依赖关系。它有如下属性：
1）name属性
指定target元素的名称，这个属性在一个project元素中是唯一的。我们可以通过指定target元素的名称来指定某个target。
2）depends属性
用于描述target之间的依赖关系，若与多个target存在依赖关系时，需要以“,”间隔。Ant会依照depends属性中target出现的顺序依次执行每个target。被依赖的target会先执行。
3）if属性
用于验证指定的属性是否存在，若不存在，所在target将不会被执行。
4）unless属性
该属性的功能与if属性的功能正好相反，它也用于验证指定的属性是否存在，若不存在，所在target将会被执行。
5）description属性
该属性是关于target功能的简短描述和说明。
3.  property元素
该元素可看作参量或者参数的定义，project的属性可以通过property元素来设定，也可在Ant之外设定。若要在外部引入某文件，例如build.properties文件，可以通过如下内容将其引入：<property file=” build.properties”/>
property元素可用作task的属性值。在task中是通过将属性名放在“${”和“}”之间，并放在task属性值的位置来实现的。
Ant提供了一些内置的属性，它能得到的系统属性的列表与Java文档中System.getPropertis()方法得到的属性一致，这些系统属性可参考sun网站的说明。
同时，Ant还提供了一些它自己的内置属性，如下：
basedir：project基目录的绝对路径，该属性在讲解project元素时有详细说明，不再赘述；
ant.file：buildfile的绝对路径，如上面的各例子中，ant.file的值为D:"build.xml；
ant.version：Ant的版本，在本文中，值为1.9.9；
ant.project.name：当前指定的project的名字，即前文说到的project的name属性的值；

ant.java.version：Ant检测到的JDK的版本，在上例运行结果中可看到为1.7。

<?xml version="1.0"?>  
     <project name="propertyStudy" default="example">   
    <property name="name" value="amigo"/>   
    <property name="age" value="25"/>   
    <target name="example">       
            <echo message="name: ${name}, age: ${age}"/>  
     </target>   
    </project>

该例的运行结果如下图所示：    

name:amigo,age:25
由此读者可以看出，通过如下两个语句：
<property name="name" value="amigo"/>
<property name="age" value="25"/>
我们设置了名为name和age的两个属性，这两个属性设置后，读者在下文中可以通过${name}和${age}分别取得这两个属性的值。
三．Ant的常用任务
在Ant工具中每一个任务封装了具体要执行的功能，是Ant工具的基本执行单位。在本小节中，主要引导读者来看下Ant的常用任务及其使用举例。
1. copy任务
该任务主要用来对文件和目录的复制功能。举例如下：
Eg1.复制单个文件：<copy file="file.txt" tofile="copy.txt"/>
Eg2.对文件目录进行复制：
   <copy todir="../newdir/dest_dir">
            <fileset dir="src_dir"/>
</copy>
Eg3. 将文件复制到另外的目录：
<copy file="file.txt" todir="../other/dir"/>
2. delete任务
对文件或目录进行删除，举例如下：
Eg1. 删除某个文件：<delete file="photo/amigo.jpg"/>
Eg2. 删除某个目录：<delete dir="photo"/>
Eg3. 删除所有的备份目录或空目录：
        <delete includeEmptyDirs="true">
               <fileset dir="." includes="**/*.bak"/>
        </delete>
3. mkdir任务
创建目录。eg：<mkdir dir="build"/>
4. move任务
移动文件或目录，举例如下：
Eg1. 移动单个文件：<move file="fromfile" tofile=”tofile”/>
Eg2. 移动单个文件到另一个目录：<move file="fromfile" todir=”movedir”/>
Eg3. 移动某个目录到另一个目录：
        <move todir="newdir">
               <fileset dir="olddir"/>
        </move>
5. echo任务
该任务的作用是根据日志或监控器的级别输出信息。它包括message、file、append和level四个属性，举例如下：
<echo message="Hello,Amigo" file="logs/system.log" append="true">
四．利用Ant构建和部署Java工程

Ant可以代替使用javac、java和jar等命令来执行java操作，从而达到轻松的构建和部署Java工程的目的。

<?xml version="1.0" encoding="UTF-8" ?>  
<project name="TestAnt" default="run" basedir="."> <!-- basedir故名思意就是工作的根目录 .代表当前目录 ,default代表默认要做的事情。-->  
    <property name="src" value="src"/><!-- 属性名 -->  
    <property name="dest" value="classes"/>  
    <property name="hello_jar" value="hello1.jar"/>  
    <target name="init"><!-- 初始化 -->  
        <mkdir dir="${dest}"/>  
    </target>  
  
  
    <target name="compile" depends="init"><!-- 编译 depends是它所依赖的target ，在执行这个target 例如这里的compile之前ant会先检查init是否曾经被执行过，如果执行过则直接直接执行compile，如果没有则会先执行它依赖的target例如这里的init，然后在执行这个target -->  
        <javac srcdir="${src}" destdir="${dest}"/>  
    </target>  
  
  
    <target name="build" depends="compile"><!-- 生成jar包 -->  
        <jar jarfile="${hello_jar}" basedir="${dest}"/>  
    </target>  
      
    <target name="run" depends="build"><!-- 运行 -->  
        <java classname="com.test.Test" classpath="${hello_jar}"/>  
    </target>  
      
    <target name="clean"><!-- 删除生成的文件  -->  
        <delete dir="${dest}" />  
        <delete file="${hello_jar}" />  
    </target>  
      
    <target name="rerun" depends="clean,run"><!-- 再次运行，这里显示了如何在一个target里边调用其他的target -->  
        <ant target="clean" />  
        <ant target="run" />  
    </target>  
      
    <property name="classes" value="build/classes"/>  
    <property name="build" value="build"/>  
    <property name="lib" value="WebRoot/WEB-INF/lib"/>  
      
    <!-- 打war包-->  
    <target name="war" depends="compile">  
        <war destfile="${build}/antwebproject.war" webxml="WebRoot/WEB-INF/web.xml">         
        <!-- 拷贝WebRoot下除了WEB-INF和META-INF的两个文件夹-->     
        <fileset dir="WebRoot" includes="**/*.jsp"/>  
        <!-- 拷贝lib目录下的jar包-->            
        <lib dir="${lib}"/>            
        <!-- 拷贝build/classes下的class文件-->            
        <classes dir="${classes}"/>      
        </war>      
    </target>   
</project> 

代码如下：

<?xml version="1.0"?>
 
	<project name="helloWorld">
		<target name = "sayHelloWorld">
			<echo message="Hello,Amigo"/>
		</target>
	</project>

<project name="propertyStudy" default="example">
	<property name="name" value="wjy"/>
	<property name="age" value="25"/>
	<target name="example">
		<echo message="name:${name},age:${age}"/>
	</target>
</project>

<!-- 学习目标：basedir -->
<!-- 其中：basedir这个路径一定要存在；否则，报错，比如：Basedir D:\ant\a does not exist -->
<project name="projectStudy" default="sayBaseDir" basedir="D:\ant\">
	<target name="sayBaseDir" description="打印提示信息">
		<echo message="The base dir is:${basedir}"/>
	</target>
</project>

<!--学习目标：创建目录 注：project中没有description属性-->
<project name="propertyStudy" default="mkdir" >
	<target name="mkdir" description="创建目录">
		<mkdir dir="mkdirTest2" />
	</target>
</project>


<!-- 学习目标：property变量 --> 
<project>
	<property name="name" value="wjy"/>
	<property name="age" value="25"/>
	<target name="example">
		<echo message="姓名:${name};年龄:${age}"/>
	</target>
</project>

<!-- 学习目标：拷贝单个文件与文件夹 -->
<project name="propertyStudy" default="copydir">
	<target name="copyfile" description="拷贝文件">
		file是源文件；tofile是生成的文件
		<copy file="antStudy.txt" tofile="copy.txt"/>
	</target>

	<target name="copydir" description="拷贝目录">
		<copy todir="mkdirTestCopy">拷贝生成的文件夹
			<fileset dir="mkdirTest"/>源文件夹
		</copy>
	</target>
</project>

<!-- 学习目标：删除单个文件与文件夹 删除备份目录及空目录 -->
<project name="propertyStudy" default="deldir"> 
	<target name="delfile" description="删除文件">
		<delete file="mkdirTestCopy/copy.txt"/>
	</target>

	<target name="deldir" description="删除目录">
		<delete dir="mkdirTestCopy"/>
	</target>

	<target name="delBakAndEmpty" description="删除空目录及备份目录">
		<delete includeEmptyDirs="true">
			<fileset dir="." includes="**/*.bak"/>
		</delete>
	</target>
</project>

<!-- 学习目标：移动文件、目录 -->
<project name="propertyStudy" default="moveDirToDir">
	<target name="moveFile" description="移动文件">
		<move file="mkdirTest/copy.txt" tofile="mkdirTestCopy/copy.txt"/>
	</target>

	<target name="moveFileToDir" description="移动文件到指定目录">
		<move file="3.xlsx" todir="mkdirTest"/>
	</target>

	<target name="moveDirToDir" description="移动目录到目录(如果dir目录与todir目录不一样，则dir目录下的内容移动todir目录下，同时dir目录删除；)，也可做为目录更名（如果dir目录存在，todir目录不存在，则会把dir目录的名字更改成todir目录的名字，就叫做：目录更名）">
		<move todir="mkdirTestCopy2">
			<fileset dir="mkdirTestCopy"/>
		</move>
	</target>
</project>

<!-- 学习目标：编译 -->
<project name="javacTest" default="compile" basedir=".">
	<target name="clean" description="删除编译后产生的目录及文件">
		<delete dir="build"/>
	</target>

	<target name="compile" depends="clean" description="编译源文件">
		<mkdir dir="build/classes"/>
		<javac srcdir="src" destdir="build/classes"/>
	</target>
</project>

<!-- 学习目标：编译并运行java程序 -->
<!-- 一般运行：ant run, 现在project设置的有default的默认：可以直接运行：ant就可以了 -->
<project name="javaTest" default="run" basedir=".">
	<target name="clean" description="清除目录">
		<delete dir="build"/>
	</target>

	<target name="compile" depends="clean" description="编译,前提是：把Demo.java文件放到src/build/classes文件夹下">
		<mkdir dir="build/classes"/>
		<javac srcdir="src" destdir="build/classes" includeantruntime="on"/>
	</target>

	<target name="run" depends="compile" description="运行">
		<java classname="Demo">
			<classpath>
				<pathelement path="build/classes"/>
			</classpath>
		</java>
	</target>
</project>

<!-- 学习目标：打JAR包 -->
<project name="javaTest" default="jar" basedir=".">
	<target name="jar" description="打JAR包">
		<jar destfile="demo.jar" basedir="src/build/classes/">
			<manifest>
				<attribute name="Main-class" value="Demo"/>
			</manifest>
		</jar>
	</target>
</project>

<!-- 默认打包操作 -->
<project name="structured" default="archive">
	<description>编译并打包一个应用程序</description>
	<!--在工程目录下创建输出目录：build/classes和 dist-->
	<target name="init" description="创建目录">
		<mkdir dir="build/classes"/>
		<mkdir dir="dist"/>
	</target>

	<!--编译输出目录：srcdir-源目录和destdir-目标目录-->
	<target name="compile" depends="init" description="编译">
		<javac srcdir="src" destdir="build/classes"/>
	</target>

	<!--打包, depends依赖哪些target-->
	<target name="archive" depends="compile" description="打包">
		<war destfile="dist/antwebproject.war" basedir="build/classes"/>
		<jar destfile="dist/project.jar" basedir="build/classes"/>
	</target>

	<!--清理删除-->
	<target name="clean" depends="init" description="清理">
		<delete dir="build"/>
		<delete dir="dist"/>
	</target>
</project>


<!-- web project 打war包 -->
<project name="antwebproject" default="war" basedir=".">
	<!-- 定义常量，任务可以引用 -->
	<property name="classes" value="build/classes"/>
	<property name="build" value="build"/>
	<property name="lib" value="WebRoot/WEB-INF/lib"/>
	<!-- 删除build路径 -->
	<target name="clean">
		<delete dir="build"/>
	</target>

	<!--建立build/classes路径，并编译class文件到build/classes路径下-->
	<target name="compile" depends="clean">
		<mkdir dir="${classes}"/>
		<javac srcdir="src" destdir="${classes}"/>
	</target>

	<!-- 打war包-->
	<target name="war" depends="compile">
		<war destfile="${build}/AntProject.war" webxml="WebRoot/WEB-INF/web.xml">
			<!--拷贝WebRoot下除了WEB-INF和META-INF的两个文件夹 , **意为:匹配0或者更多的目录-->
			<fileset dir="WebRoot" includes="**/*.jsp"/>
			<!--拷贝lib目录下的jar包-->
			<lib dir="${lib}"/>
			<!--拷贝build/classes下的class文件-->
			<classes dir="${classes}"/>
		</war>
	</target>
</project>