博客园  :: 首页  :: 新随笔  :: 联系 :: 订阅 订阅  :: 管理

【转载】Apache Ant入门

Posted on 2011-03-19 15:37  elric_wang  阅读(1019)  评论(1编辑  收藏  举报
1.构建ant环境
要使用ant首先要构建一个ant环境,步骤很简单:
1)安装jdk,设置JAVA_HOME ,PATH ,CLASS_PATH。
2)下载ant 地址www.apache.org
3)解压ant 你得到的是一个压缩包,解压缩它,并把它放在一个尽量简单的目录,例如D:\ant-1.7。
4)设置ANT_HOME PATH中添加ANT_HOME目录下的bin目录。
5)测试一下你的设置。开始-->运行-->cmd进入命令行-->键入 ant 回车,如果看到
Buildfile: build.xml does not exist!
Build failed
配置成功。
 
2.ant命令行使用举例
1)ant
使用当前目录下的build.xml运行Ant,执行缺省的target。
2)ant -buildfile test.xml
使用当前目录下的test.xml运行Ant,执行缺省的target。
3)ant -buildfile test.xml dist
使用当前目录下的test.xml运行Ant,执行一个叫做dist的target。
4)ant -buildfile test.xml -Dbuild=build/classes dist
使用当前目录下的test.xml运行Ant,执行一个叫做dist的target,并设定build属性的值为build/classes。
 
3.编写build.xml
Ant的buildfile是用XML写的。每个buildfile含有一个project。 buildfile中每个task元素可以有一个id属性,可以用这个id值引用指定的任务。这个值必须是唯一的。(详情请参考下面的Task小节)
 
3.1Projects
project有下面的属性:
Attribute
Description
Required
name
项目名称
No
default
当没有指定target时使用的缺省target
Yes
basedir
用于计算所有其他路径的基路径。该属性可以被basedir property覆盖。当覆盖时,该属性被忽略。如果属性和basedir property都没有设定,就使用buildfile文件的父目录。
No
一个项目可以定义一个或多个target。一个target是一系列你想要执行的。执行Ant时,你可以选择执行哪个target。当没有给定target时,使用project的default属性所确定的target。
 
3.2Targets
一个target可以依赖于其他的target。例如,你可能会有一个target用于编译程序,一个target用于生成可执行文件。你在生成可执行文件之前必须先编译通过,所以生成可执行文件的target依赖于编译target。Ant会处理这种依赖关系。
然而,应当注意到,Ant的depends属性只指定了target应该被执行的顺序-如果被依赖的target无法运行,这种depends对于指定了依赖关系的target就没有影响。
Ant会依照depends属性中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 D。从它的依赖属性来看,你可能认为先执行C,然后B,最后A被执行。错了,C依赖于B,B依赖于A,所以先执行A,然后B,然后C,最后D被执行。
一个target只能被执行一次,即时有多个target依赖于它(看上面的例子)。
如果(或如果不)某些属性被设定,才执行某个target。这样,允许根据系统的状态(java version, OS, 命令行属性定义等等)来更好地控制build的过程。要想让一个target这样做,你就应该在target元素中,加入if(或unless)属性,带上target应该有所判断的属性。例如:
<target name="build-module-A" if="module-A-present"/>
<target name="build-own-fake-module-A" unless="module-A-present"/>
如果没有if或unless属性,target总会被执行。
可选的description属性可用来提供关于target的一行描述,这些描述可由-projecthelp命令行选项输出。
将你的tstamp task(见下文例子)作为一个所谓的初始化target是很好的做法,其他的target依赖这个初始化target。要确保初始化target是出现在其他target依赖表中的第一个target。在本手册中大多数的初始化target的名字是"init"。
target有下面的属性:
Attribute
Description
Required
name
target的名字
Yes
depends
用逗号分隔的target的名字列表,也就是依赖表。
No
if
执行target所需要设定的属性名。
No
unless
执行target需要清除设定的属性名。
No
description
关于target功能的简短描述。
No
 
3.3Tasks
一个task是一段可执行的代码。 一个task可以有多个属性(如果你愿意的话,可以将其称之为变量)。属性只可能包含对property的引用。这些引用会在task执行前被解析。
下面是Task的一般构造形式:
<name attribute1="value1" attribute2="value2" ... />
这里name是task的名字,attributeN是属性名,valueN是属性值。 有一套内置的(built-in)task,以及一些可选task,但你也可以编写自己的task。 所有的task都有一个task名字属性。Ant用属性值来产生日志信息。
可以给task赋一个id属性:
<taskname id="taskID" ... />
这里taskname是task的名字,而taskID是这个task的唯一标识符。通过这个标识符,你可以在脚本中引用相应的task。例如,在脚本中你可以这样:
<script ... >
task1.setFoo("bar");
</script>
设定某个task实例的foo属性。在另一个task中(用java编写),你可以利用下面的语句存取相应的实例。
project.getReference("task1").
注意1:如果task1还没有运行,就不会被生效(例如:不设定属性),如果你在随后配置它,你所作的一切都会被覆盖。
注意2:未来的Ant版本可能不会兼容这里所提的属性,因为很有可能根本没有task实例,只有proxies。
 
3.4Properties
一个project可以有很多的properties。可以在buildfile中用property task来设定,或在Ant之外设定。一个property有一个名字和一个值。property可用于task的属性值。这是通过将属性名放在"${"和"}"之间并放在属性值的位置来实现的。例如如果有一个property builddir的值是"build",这个property就可用于属性值:${builddir}/classes。这个值就可被解析为build/classes。
内置属性:
如果你使用了<property> task 定义了所有的系统属性,Ant允许你使用这些属性。例如,${os.name}对应操作系统的名字。
要想得到系统属性的列表可参考the Javadoc of System.getProperties。
除了Java的系统属性,Ant还定义了一些自己的内置属性:
basedir project基目录的绝对路径 (与<project>的basedir属性一样)。
ant.file buildfile的绝对路径。
ant.version Ant的版本。
ant.project.name 当前执行的project的名字;由<project>的name属性设定。
ant.java.version Ant检测到的JVM的版本; 目前的值有"1.1", "1.2", "1.3" and "1.4"。
 
4.ant中的HelloWorld
1)首先你要知道你要干什么,我现在想做的事情是:
-编写一些程序
-编译它们
-把它打包成jar包
-把他们放在应该放置的地方
-运行它们
这里为了简单起见,只写一个程序,就是HelloWorld.java程序代码如下:
package test.ant;
public class HelloWorld{
 public static void main(String[] args){
  System.out.println("Hello world!");
 }
}
 
2)要运行ant需要有一个build.xml。
下边就是一个完整的build.xml
<?xml version="1.0" encoding="UTF-8" ?>
<project name="HelloWorld" default="rerun" basedir=".">
 <property name="src" value="src"/>
 <property name="dest" value="classes"/>
 <property name="lib"  value="lib"/>
 <property name="hello_jar" value="hello1.jar"/>
 
 <target name="init">
  <mkdir dir="${dest}"/>
 </target>
 
 <target name="compile" depends="init">
  <javac srcdir="${src}" destdir="${dest}"/>
 </target>
 
 <target name="build" depends="compile">
  <mkdir dir="${lib}"/>
  <jar jarfile="${lib}/${hello_jar}" basedir="${dest}"/>
 </target>
 
 <target name="run" depends="build">
  <java classname="test.ant.HelloWorld" classpath="${lib}/${hello_jar}"/>
 </target>
 
 <target name="clean" depends="run">
  <delete dir="${dest}" />
 </target>
 
 <target name="rerun" >
  <ant target="run" />
 </target>
</project>
 
解释:
<project name="HelloWorld" default="run" basedir=".">
</project> 
ant的所有内容必须包含在这个里边,name是你给它取的名字,basedir是工作的根目录 .代表当前目录。default代表默认要做的事情。
<property name="src" value="src"/>
类似程序中的变量。各个target的用途依次是:编译(compile),做jar包(build),运行(run)。
为了不用拷贝,我们可以在最开始定义好目标文件夹,这样ant直接把结果就放在目标文件夹中了:新建文件夹(init)。
另外两个target:删除生成的文件(clean),再次运行,这里显示了如何在一个target里边调用其他的target(rerun)。
 
测试:
1)新建一个src的文件夹,然后把HelloWorld.java按照包目录放进去。
2)做好build.xml文件。放在与src同级的目录。
3)将当前目录转换到build.xml所在目录。在命令行下键入ant,你会发现一个个任务都完成了。
当default="run"时的结果:
 run
当default="clean"时的结果:
 clean
当default="rerun"时的结果:
rerun

技术博客已迁移至GitHub Pages,欢迎访问》》