Java的Build工具－－Ant应用指南

对于一个简单的工程，一般包括表1的几个目录。其中bin、lib、doc和src目录需要在CVS的控制之下。当然在这样的目录结构上，也可以做一些调整，例如，可以建立一个extra目录来放置需要发布的Jar文件、Inf文件及图像文件等。同样，如果开发Web应用可以建立一个Web目录放置JSP、HTML等文件。

如果我们开发的是一个比较复杂的项目，包括多个子项目，并且各个子项目是由不同的开发人员来完成的，那么要如何来设计它的目录结构？首先有一点是需要确定的，不同的子项目应该拥有不同的Build文件，并且整个项目也应该有一个总的Build文件。可以通过Ant任务或是AntCall任务调用子项目的Build文件，如下例：

<target name="core" depends="init">
<ant dir="components" target="core"/>
<ant dir="waf/src" target="core"/>
<ant dir="apps" target="core"/>    
</target>
 

在各个子项目的耦合不是非常紧密的情况下，各个子项目应该有各自独立的目录结构，也就是说它们可以有自己的src、doc、build、dist等目录及自己的build.xml文件，但是可以共享lib和bin目录。而对于那些耦合紧密的子项目，则推荐使用同一个src目录，但是不同的子项目有不同的子目录，各个子项目的build.xml文件可以放在根目录下，也可以移到各个子项目的目录下。

编写Build文件

要用好Ant工具，关键是要编写一个build.xml文件。要编写出一个结构良好、灵活可扩展的Build文件，有两个问题要考虑，一是了解Build文件的基本结构，二是了解Ant定义的大量任务。

Ant的Build文件是一个标准的XML文件，它包含一个根节点Project，每个Project定义了至少一个或多个Target，每个Target又是一系列Task的集合。它们之间的关系如图2所示。

图2 build.xml文件的结构

每个Task是一段可被执行的代码，比如，前例中的javac、jar就是两个最常用的Task。Ant定义了大量的核心Task，我们要考虑的第二个问题正是如何去掌握这大量的Task。其实唯一的方法就是边学习边实践，这方面最好的参考就是官方的Ant使用手册。

外部文件的使用

使用外部的Property文件可以保存一些预设置的公共属性变量。这些属性可以在多个不同的Build文件中使用。

可以将一个外部的XML文件导入Build文件中，这样多个项目的开发者可以通过引用来共享一些代码，同样，这也有助于Build文件的重用，示例代码如下所示：

<!DOCTYPE project [
<!ENTITY share-variable SYSTEM "file:../share-variable.xml">
<!ENTITY build-share SYSTEM "file:../build-share.xml">
]>
<project name="main" default="complie" basedir=".">
&share-variable;
&build-share;
... ...
 

在J2EE项目中的应用

只要掌握了Ant的使用方法，在J2EE项目中的应用与在其它项目中的应用并没有太大的不同，但是仍有几点是需要注意的。

一是要清楚War和Jar文件的目录结构，主要是War的配置文件web.xml文件的位置和EJB的配置文件（ejb-jar.xml和weblogic-ejb-jar.xml等）的位置，在调用Jar任务打包文件时一定要记得把它们也包含进来。一般在编译之前就要注意把这些需打包的文件拷入相应目录下。二是在J2EE项目中可能会涉及到一些特殊的任务，比如在Weblogic中会调用ejbc预编译EJB的代码存根，或者需要在Ant中同时发布Jar到相应的服务器中等。可以用两种途径实现这些任务，一是扩展Ant任务实现这些任务，二是直接用Java任务来执行这些命令。下面是打包、发布一个EJB的build.xml配置文件片断，代码如下：

<target name="deploy_HelloEJB" depends="compile">
<delete dir="${temp}/ejb_make"/>  <!-- 首先删除临时目录 -->
<delete file="${temp}/helloEJB.jar"/>
<!-- 删除WebLogic域中老版本的EJB -->
<delete file="${weblogic.deploy.dest}/helloEJB.jar"/>
<!-- 创建META-INF目录，放置ejb-jar.xml和weblogic-ejb-jar.xml -->
<mkdir dir="${temp}/ejb_make/META-INF"/>
<!-- 拷贝ejb-jar.xml和weblogic-ejb-jar.xml 到临时目录-->
<copy todir="${temp}/ejb_make/META-INF">
<fileset dir="etc/baseinfo">
<include name="*.xml"/>
</fileset>
</copy>
<!-- 拷贝所有的helloEJB类到临时目录 -->
<copy todir="${temp}/ejb_make/">
<fileset dir="${dest.classes}/">  <!-- dest.classes是输出的类文件目录 -->
<include name="${dest.classes}/helloEJB/**"/>
</fileset>
</copy>
<!-- 将所有这些文件打包成helloEJB.jar -->
<jar jarfile="${temp}/helloEJB.jar" basedir="${temp}/ejb_make"/>
<!-- 进行weblogic.ejbc编译 -->
<java classpath="${wl_cp}" classname="weblogic.ejbc" fork="yes" >
<classpath>
<fileset dir="lib">
<include name="*.jar" />
</fileset>
</classpath>
<arg value="${temp}/helloEJB.jar" />
<arg value="${temp}/helloEJB_deploy.jar" />
</java>
<!-- 拷贝/发布到WebLogic的{DOMAIN}\applications目录 -->
<copy file="${temp}/helloEJB_deploy.jar" todir="${weblogic.deploy.dest}"/>
</target>
 

用Ant配合JUnit实现单元测试

Ant 提供了JUnit任务,可以执行单元测试代码。如何使用JUnit，以及如何编写测试用例(TestCase)，感兴趣的读者可以参阅JUnit的相关文档。在Ant中使用JUnit的方法非常简单，首先需要把junit.jar拷入ANT_HOME\lib下，确认在这个目录下有optional.jar，因为JUnit是Ant的扩展任务，需要引用这个扩展包。然后就是在Build文件中加入JUnit的任务，代码如下：

<target name="run" depends="client">
<junit printsummary="yes" fork="yes" haltonfailure="yes">
<classpath>
<pathelement location="client.jar" />
</classpath>
<formatter type="plain" />
<test name="com.sharetop.antdemo.HelloWorldTest" />
</junit>
</target>
 

高级话题

为Ant开发扩展任务

为Ant实现扩展任务其实是非常容易的，只需按照以下几个步骤即可：

1. 创建一个Java类继承org.apache.tools.ant.Task类；

2. 对每个属性实现set方法。Ant会根据需要自动完成类型转换；

3. 如果扩展的任务需要嵌套其它的Task，那么这个Java类必需实现接口org.apache.tools.ant.TaskContainer；

4. 如果扩展的任务要支持Text，需要增加一个方法void addText(String)；

5. 对每个嵌套的元素，实现create、add 或 addConfigured 方法；

6. 实现public void execute方法；

7. 在build.xml文件中使用<taskdef>来引用自定义的Task。

下面以一个简单的例子来说明如何为Ant增加一个hello任务，它可以连续打印多条信息，打印的次数由属性count指定，而打印的内容则由它内嵌的一个helloinfo任务的message属性指定，看上去这非常类似JSP中自定义标签的一些概念，实现代码如下：

file://HelloInfoTask.java
package com.sharetop.antdemo;
import org.apache.tools.ant.*;
public class HelloInfoTask {
 private String msg;
 public void execute() throws BuildException {
  System.out.println(msg);
 }
 public void setMessage(String msg) {
  this.msg = msg;
 }
}
 

下面是外部Task类的代码：

file://HelloTask.java
package com.sharetop.antdemo;
import org.apache.tools.ant.*;
public class HelloTask extends Task implements org.apache.tools.ant.TaskContainer
{
 private Task info;
 private int count;
 public void execute() throws BuildException {
  for(int i=0;i<count;i++)
  info.execute();
 }
 public void setCount(int c){
  this.count=c;
 }
 public void addTask(Task t){
  this.info=t;
 }
}
 

实现了这两个Task，在build.xml文件中定义它的task name，就可以在Target中执行它了。如果你不想使用<taskdef>标签来定义Task，也可以通过修改default.properties文件来实现引入新Task，这个文件位于org.apache.tools.ant.taskdefs 包里。下例是一个使用标签来引入新Task的Build文件部分：

<target name="hello" depends="client">
<taskdef name="hello"
classname="com.sharetop.antdemo.HelloTask" classpath="client.jar"/>
<taskdef name="helloinfo"
classname="com.sharetop.antdemo.HelloInfoTask" classpath="client.jar"/>
<hello count="3" >
<helloinfo message="hello world" />
</hello>
</target>
 
在自己的程序中调用Ant

Ant的任务其实就是一段功能代码。Ant内置的大量任务对于我们开发Java应用具有非常大的意义，为什么我们不能直接使用呢？

因为尽管在程序中调用Ant的任务并不复杂，而且我们知道Ant的任务其实都是一些Java类，调用的方法无非就是执行这些类而已，不过在执行之前需要对它做一些初始化的工作，所以我们需要引用一个Task类的子类来实现这个功能，比如如下代码：

package com.sharetop.antdemo;
import org.apache.tools.ant.*;
import org.apache.tools.ant.taskdefs.*;
import java.io.File;
public class RunAntTask {
 public RunAntTask() {
 }
 public static void main(String args[]){
  AntJAR j = new AntJAR();
  j.setBasedir(new File("./classes"));
  j.setJarfile(new File("aaa.jar"));
  j.execute();
 }
}
final class AntJAR extends Jar {
 public AntJAR() {
  project = new Project();
  project.init();
  taskType = "jar";
  taskName = "jar";
 }
}
 

注意AntJAR类的构造方法，先创建了Project并初始化它，这是直接调用Task的必需条件。

如果要在自己的程序中执行Ant，需要了解的是Ant定义的几个BuildEvent，它包括：

◆ Build started

◆ Build finished

◆ Target started

◆ Target finished

◆ Task started

◆ Task finished

◆ Message logged

我们需要做的是实现BuildListener接口来处理各种事件，而执行Ant的方法与上面给的例子非常类似，以实际开发的AntBuilder软件的部分代码为例：

public void buildTarget(String targetName,String buildFileName) {
 try {
  Project p = new Project();
  p.init();
  File f = new File(buildFileName);
  p.setUserProperty("ant.file",f.getAbsolutePath());
  ProjectHelper.configureProject(p,f);
  p.addBuildListener(this);
  if( targetName==null )
  p.executeTarget(p.getDefaultTarget());
  else
  p.executeTarget(targetName);
 }
 catch (Exception ex) {
  jTextArea1.append(ex.getMessage());
 }
}
 

创建Project并初始化，设置它的配置文件（build.xml），执行它缺省的或指定的Target，然后在实现了BuildListenser接口的监听器类中对你感兴趣的事件作处理，代码如下：

public void buildStarted(BuildEvent event){ /* nothing*/ }
  public void buildFinished(BuildEvent event) { /* nothing*/ }
  public void targetStarted(BuildEvent event) {
    this.jTextArea1.append(event.getTarget().getName()+": \n\r");
  }
  public void targetFinished(BuildEvent event) {/* nothing*/ }
  public void taskStarted(BuildEvent event) {/* nothing*/ }
  public void taskFinished(BuildEvent event) { /* nothing*/ }
  public void messageLogged(BuildEvent event) {
   int prior = event.getPriority();
   switch(prior){
    case Project.MSG_ERR :
    this.jTextArea1.append("["+event.getTask().getTaskName()+"]Err:"
   +event.getMessage());
     break;
    case Project.MSG_INFO:
  this.jTextArea1.append("["+event.getTask().getTaskName()+"]"+event.getMessage
 ());
     break;
    case Project.MSG_WARN:
    this.jTextArea1.append("["+event.getTask().getTaskName()+"]"
   +event.getMessage());
     break;
    case Project.MSG_VERBOSE:
     this.jTextArea1.append(event.getMessage());
     break;
   }
  }
 

Build.xml文件的写法每个公司都有不同，这里没有太大的参考价值，所以略去。