BlogJava-菠萝三国-文章分类-Ant

结合Axis和Ant开发Web服务

菠萝 — Sun, 12 Aug 2007 09:04:00 GMT

本文结合一个简单示例讲解了怎样把Axis和Ant结合起来进行Web服务的开发。帮助读者从简单的java源代码或者从一个服务描述文件（wsdl）开始，用Ant工具进行构建，设置，并把服务部署到Axis。

首先假定您熟悉 AXIS 处理系统和Ant工具。文中示例所需要的软件如下：

l Apache Axis 1.1

l Apache Ant 1.5.3

l Jarkat Tomcat 4.1.24

在开始前，假定上述软件已经安装和配置好了。

Axis和Ant简介

Axis 框架是来自 Apache Group 的、基于 java 的、最新的 SOAP 规范（SOAP 1.2）和 SOAP with Attachments 规范（来自 Apache Group ）的开放源代码实现。其本质上是一个SOAP引擎－－一个构建诸如客户端、服务器、网关等SOAP处理器的框架。是Apache SOAP的后继项目。但是，Axis使用SAX（基于事件）解析器获得了比Apache SOAP早期版本(使用DOM解析)非常明显的速度优势。另外，它还具有很强的灵活性和稳定性，支持Web服务描述语言1.1版。

Apache Ant是Apache软件基金会jakarta项目中的一个子项目，是一个基于Java的构建工具，类似于make，但它没有make那么复杂繁琐。Ant由一些内置任务（task）和可选择的任务组成，还可以配置第三方提供的任务。它的构建配置文件基于XML的，所以容易书写和维护，而且结构清晰。Ant还可以集成到一些开发环境中（例如visual age,jbuilder,Elipse)。

Axis对Ant的支持

Axis为支持Ant构建，提供了一个axis-ant.jar文件。该文件包含三个可选任务(task)的定义和实现：axis-wsdl2java，axis-java2wsdl和axis-admin。任务axis-wsdl2java与Axis提供的工具WSDL2Java具有同样的功能，根据web服务描述文件生成对应的Java源程序，它的属性设置与WSDL2Java的命令参数设置类似。而任务axis-java2wsdl则相反，它与Java2WSDL工具一样，是根据已有的类文件来生成Web服务描述文件。最后一个任务axis-admin是用于web服务的部署和取消部署的，对应于Axis的AminClient工具。

为了使Ant能够正确使用上述三个任务（task），还需要做一些配置。注意：Apache Ant的版本必须是1.5.1或更高版本。

1．设置系统的环境变量CLASSPATH包含Axis提供的axis-ant.jar文件，或者在Ant的配置文件（通常是build.xml）中设置路径包含它。例如，

2．然后使用声明导入axis-ant.jar文件中的属性文件所定义的任务（task）列表。

classpathref="axis.classpath" />

3．设置在构建过程中可能要需要的java包，例如， Axis所有的jar包，wsdl4j.jar，junit.jar等等。

实例开发

下面就用一个实例来讲解怎样把Ant和Axis结合来开发Web服务。为了注重本文的目的，我们开发一个比较简单的Web服务，它接受客户端传入的字符串数组，如果传入的参数为null，则抛出一个自定义的异常，否则把每个字符串连接起来返回给客户端。

首先定义一个Web服务接口Hello，如下所示：

package com.bidlink.hello;

public interface Hello{

public String echo(String[] content ) throws

java.rmi.RemoteException,com.bidlink.hello.MyException;

}

自定义异常MyException包含一个时间值，以记录异常出现的时间，如下：

package com.bidlink.hello;

public class MyException extends org.apache.axis.AxisFault implements java.io.Serializable{

private java.util.Calendar occurTime;

public MyException() {

}

public MyException(

java.util.Calendar occurTime) {

super();

this.occurTime = occurTime;

}

public java.util.Calendar getOccurTime() {

return occurTime;

}

public void setOccurTime(java.util.Calendar occurTime) {

this.occurTime = occurTime;

}

1．axis-java2wsdl：从类文件生成服务描述文件

编译上面定义的两个文件Hell.java和MyException.java。接着编写Ant的配置文件build.xml（文件详细信息请查看示例源代码），使用axis-java2wsdl任务根据类Hello来生成Web服务描述文件hello.wsdl。任务具体配置如下：

location="http://localhost:8080/axis/services/Hello"

namespace="http://hello.bidlink.com"

output="hello.wsdl"

style="RPC"

extraclasses="com.bidlink.hello.MyException">

其中，指出Hello.class和MyException.class文件的位置。

运行命令ant java2wsdl，构建出Web服务描述文件hello.wsdl。

2．axis-wsdkl2java：从服务描述文件生成服务源程序

下面讲解怎样根据刚刚得到的hello.wsdl文件生成服务所需要的java源程序。在这里需要用到任务axis-wsdl2java。任务属性设置如下：

url="hello.wsdl"

deployscope="Request"

output="${gensrc}"

serverside="true"

skeletondeploy="false"

testcase="true"

noimports="false"

typemappingversion="1.2">

运行ant wsdl2java，根据axis-wsdl2java任务的属性配置生成相应的java源程序，本例所生成的文件包括：服务端服务接口文件Hello.java及其实现HelloSoapBindingImpl.java，以及客户端的HelloService.java，HelloServiceLocator.java，HelloServiceLocator.java和客户端存根文件HelloSoapBindingStub.java。又因为属性testcase="true"，所以还生成了测试文件HelloServiceTestCase.java。当然，自定义异常MyException也是重新生成的。

3．axis-admin：向Axis部署Hello服务

服务源程序生成后，需要根据服务的功能修改HelloSoapBindingImpl.java文件，以真正实现该Web服务。修改如下：

/**

* HelloSoapBindingImpl.java

* This file was auto-generated from WSDL

* by the Apache Axis WSDL2Java emitter.

package com.bidlink.hello;

public class HelloSoapBindingImpl implements com.bidlink.hello.Hello{

public java.lang.String echo(java.lang.String[] in0) throws java.rmi.RemoteException, com.bidlink.hello.MyException {

if(in0 == null)

throw new MyException(java.util.Calendar.getInstance());

String retStr = "";

for(int i=0; i< in0.length; i++)

retStr += in0[i];

return retStr;

}

编译所有的生成的源程序，最后使用axis-admin任务向Axis部署Hello Web服务。

port="${target.port}"

hostname="${target.server}"

failonerror="true"

servletpath="${target.appname}/services/AdminService"

debug="true"

xmlfile="deploy.wsdd"/>

运行ant deploy，部署Hello服务。

测试

现在可以测试所部署的Web服务hello。可以通过浏览器，也可以利用刚才生成的测试文件HelloServiceTestCase.java来进行该项工作。如果利用测试文件HelloServiceTestCase.java，那么还需要对它进行稍作修改。具体来说，就是添加一个main函数，然后修改所生成的测试方法。

菠萝 2007-08-12 17:04 发表评论

axis with ant

菠萝 — Sun, 12 Aug 2007 09:03:00 GMT

在用eclipes开发web service的时候，经常会用到java2wsdl,wsdl2java等命令，axis在发布的时候提供了相应的ant task，并放到了axis-ant.jar中。
按照axis的ant相关文档配置的时候，需要引入相应的ant task，我在做这个配置的时候遇到了些障碍，开始的build.xml如下所示：

      classname="axis.service.SimpleObjectCreator"
  location="http://localhost:8080/axis/services/SimpleObjectCreator"
      namespace="service.axis"
      output="simpleObject.wsdl"
      style="RPC"
      extraclasses="axis.bean.SimpleObject"
    >


            url="simpleObject.wsdl"
        deployscope="Request"
        output="${axis.home}/src"
        serverside="true"
        skeletondeploy="false"
        testcase="true"
        noimports="false"
        typemappingversion="1.2"
    />

   port="8080"
  hostname="localhost"
  failonerror="true"
  servletpath="axis/services/AdminService"
  debug="true"
  xmlfile="${axis.home}\src\axis\service\deploy.wsdd"
/>

在执行ant的时候，总是报
    java.util.zip.ZipException: error in opening zip file
的错误，百思不得其解，后来找到了错误的原因，原来出在
    ...
的定义上，因为这里包含



部分，解析时会把我指定的class文件当作一个压缩文件进行解压，产生异常，改成如下定义即可：



第二个fileset改成pathelement，当解析时会把指定的location当作一个路径，不会报错。
对于开源的ant真是又爱又恨啊，可恨的是文档太少了，如,的说明等，惜墨如金啊。

菠萝 2007-08-12 17:03 发表评论

Axis开发之工业化－ant使用

菠萝 — Sun, 12 Aug 2007 08:24:00 GMT

Axis为支持Ant构建，提供了一个axis-ant.jar文件。该文件包含三个可选任务(task)的定义和实现：axis-wsdl2java，axis-java2wsdl和axis-admin。

1）任务axis-wsdl2java与Axis提供的工具WSDL2Java具有同样的功能，根据web服务描述文件生成对应的Java源程序，它的属性设置与WSDL2Java的命令参数设置类似。

2）任务axis-java2wsdl则相反，它与Java2WSDL工具一样，是根据已有的类文件来生成Web服务描述文件。

3） axis-admin是用于web服务的部署和取消部署的，对应于Axis的AminClient工具。

为了使用ant来建构，首先需要将axis-ant.jar包拷贝到ant的lib目录下。

一、下面是详细的步骤，列了一个1，2，3，4，5，看起来清楚一些

1．用声明导入axis-ant.jar文件中的属性文件所定义的任务（task）列表。

2．把axis的包都导进来

这里导入的是axis的所有包-->

这里导入的是javamail的包，如果web服务有附件的时候要用到，如果没有包含进来会有一个警告

-->

其他的包-->

3．生成web描述文件和根据描述文件生成java源程序

classname="net.wide.axis.service.SimpleObjectCreator" location="http://localhost:8080/axis/services/SimpleObjectCreator"

namespace="service.axis.wide.net"

output="simpleObject.wsdl"

style="RPC"

extraclasses="net.wide.axis.bean.SimpleObject"

url="simpleObject.wsdl"

deployscope="Request"

output="${basedir}/src"

serverside="true"

skeletondeploy="false"

testcase="true"

noimports="false"

typemappingversion="1.2"/>

3行：我们要发布的web服务接口，需要先定义这个接口，如果是一个具体的类，下面用axis-wsdl2java来生成java文件的时候，会生成该接口和他的实现文件。

4行：web服务发布的位置

5行：namespace，这一行用红字标出来，是要注意的，“service.axis.wide.net”，跟我的包结构刚好倒过来，当用axis-wsdl2java来生成java文件的时候，包结构就是“net.wide.axis.service”。

6行：生成的webservice描述文件，axis-wsdl2java正是用他来生成java文件的

4．将生成的java文件编译，解下就是部署

port="8080"

hostname="localhost"

failonerror="true"

servletpath="axis/services/AdminService"

debug="true"

xmlfile="${basedir}\src\net\wide\axis\service\deploy.wsdd"/>

6行：servletpath要跟web.xml中的保持一致

8行：上一步生成的部署文件

5．测试

二、实例，通过一个实例来看看使用ant的开发步骤。包括下面的内容：

1）服务端创建一个JavaBean，并且返回给客户端

2）客户端将一个JavaBean做为参数传递给服务器端

3）服务器端返回一个JavaBean数组

1．定义JavaBean

package net.wide.axis.bean;

public class SimpleObject implements Serializable {

private String name;

public getName() {

return name;

}

public void setName(String name) {

this.name = name;

}

注意JavaBean需要实现Serializable接口

2．定义web服务接口

package net.wide.axis.service;

import net.wide.axis.bean.SimpleObject;

public interface SimpleObjectCreator{

public SimpleObject createSimpleObject(String name);

public void storeSimpleObject(SimpleObject simpleObject);

public SimpleObject[] createSimpleObjects();

}

3．运行Ant axis，生成了下面的文件

4．实现SimpleObjectCreatorSoapBindingImpl.java，这个java文件就是SimpleObjectCreator的实现文件，简单实现如下：

public class SimpleObjectCreatorSoapBindingImpl

implements net.wide.axis.service.SimpleObjectCreator{

public SimpleObject createSimpleObject(java.lang.String name)

throws java.rmi.RemoteException {

System.out.println("创建SimpleObject...");

SimpleObject simpleObject = new SimpleObject();

simpleObject.setName(name);

return simpleObject;

}

public void storeSimpleObject(SimpleObject simpleObject)

throws java.rmi.RemoteException {

System.out.println("Store");

System.out.println(simpleObject.getName());

}

public SimpleObject[] createSimpleObjects()

throws java.rmi.RemoteException {

SimpleObject[] simpleObjects = new SimpleObject[2];

simpleObjects[0] = new SimpleObject();

simpleObjects[1] = new SimpleObject();

simpleObjects[0].setName("First Object");

simpleObjects[1].setName("Second Object");

return simpleObjects;

}

5．部署ant deploy

6．测试

public static void main(String[] args)

throws ServiceException, RemoteException {

String endPoint =

"http://localhost:8080/axis/services/SimpleObjectCreator?wsdl";

Service service = new Service();

Call call = (Call) service.createCall();

call.setTargetEndpointAddress(endPoint);

QName qname =

new QName("http://bean.axis.wide.net","SimpleObject");

//测试createSimpleObject方法，它创建一个SimpleObject并且返回该对象

call.registerTypeMapping(SimpleObject.class,

qname,

new BeanSerializerFactory(SimpleObject.class, qname),

new BeanDeserializerFactory(SimpleObject.class, qname));

call.setOperationName("createSimpleObject");

SimpleObject simpleObject =

(SimpleObject) call.invoke(new Object[]{"Hello"});

System.out.println(simpleObject.getName());

//测试storeSimpleObject，客户端传递一个SimpleObject

call.setOperationName("storeSimpleObject");

call.invoke(new Object[]{simpleObject});

//测试服务端返回一个SimpleObject数组，打印出数组的长度

qname =

new QName("service.axis.wide.net","ArrayOf_tns1_SimpleObject");

call.registerTypeMapping(SimpleObject.class,

qname,

new BeanSerializerFactory(SimpleObject.class, qname),

new BeanDeserializerFactory(SimpleObject.class, qname));

call.setOperationName("createSimpleObjects");

SimpleObject[] simpleObjects =

(SimpleObject[]) call.invoke(new Object[]{});

System.out.println(simpleObjects.length);

}

7．结合/WEB-INF/server-config.wsdd来分析，部署的时候会生成这个部署描述文件

<operation name="createSimpleObject"

qname="ns2:createSimpleObject"

returnQName="createSimpleObjectReturn"

soapAction=""

xmlns:ns1=http://bean.axis.wide.net/

returnType="ns1:SimpleObject"

xmlns:ns2="service.axis.wide.net">

<parameter

name="in0"

type="xsd:string"

xmlns:xsd="http://www.w3.org/2001/XMLSchema" />

operation>

<operation name="storeSimpleObject"

qname="ns3:storeSimpleObject"

soapAction=""

xmlns:ns3="service.axis.wide.net">

<parameter name="in0" type="ns4:SimpleObject"

xmlns:ns4="http://bean.axis.wide.net" />

operation>

<operation name="createSimpleObjects"

qname="ns5:createSimpleObjects"

returnQName="createSimpleObjectsReturn"

returnType="ns5:ArrayOf_tns1_SimpleObject"

soapAction=""

xmlns:ns5="service.axis.wide.net" />

<parameter name="allowedMethods"

value="storeSimpleObject createSimpleObject createSimpleObjects" />

<parameter name="wsdlServiceElement"

value="SimpleObjectCreatorService" />

<parameter name="wsdlTargetNamespace"

value="service.axis.wide.net" />

<parameter name="schemaUnqualified"

value="service.axis.wide.net,http://bean.axis.wide.net" />

<typeMapping

deserializer="org.apache.axis.encoding.ser.BeanDeserializerFactory"

encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"

qname="ns6:SimpleObject"

serializer="org.apache.axis.encoding.ser.BeanSerializerFactory"

type="java:net.wide.axis.bean.SimpleObject"

xmlns:ns6="http://bean.axis.wide.net" />

<arrayMapping innerType="ns8:SimpleObject"

languageSpecificType="java:net.wide.axis.bean.SimpleObject[]"

qname="ns7:ArrayOf_tns1_SimpleObject"

xmlns:ns7="service.axis.wide.net"

xmlns:ns8="http://bean.axis.wide.net" />

service>

这一段是SimpleObjectCreator的描述。结合createSimpleObject方法的描述与测试代码中的：

QName qname = new QName("http://bean.axis.wide.net","SimpleObject");

在createSimpleObject方法的描述中有下面的一段

xmlns:ns1=http://bean.axis.wide.net/

returnType="ns1:SimpleObject"

对比就知道了，我们使用的命名空间是：http://bean.axis.wide.net/

其他几个也是这样。

菠萝 2007-08-12 16:24 发表评论

Ant简介

菠萝 — Sun, 12 Aug 2007 04:43:00 GMT

Ant的概念
可能有些读者并不连接什么是Ant以及入可使用它，但只要使用通过Linux系统得读者，应该知道make这个命令。当编译Linux内核及一些软件的源程序时，经常要用这个命令。Make命令其实就是一个项目管理工具，而Ant所实现功能与此类似。像make，gnumake和nmake这些编译工具都有一定的缺陷，但是Ant却克服了这些工具的缺陷。最初Ant开发者在开发跨平台的应用时，用样也是基于这些缺陷对Ant做了更好的设计。

Ant 与 makefile
Makefile有一些不足之处，比如很多人都会碰到的烦人的Tab问题。最初的Ant开发者多次强调”只是我在Tab前面加了一个空格，所以我的命令就不能执行”。有一些工具在一定程度上解决了这个问题，但还是有很多其他的问题。Ant则与一般基于命令的工具有所不同，它是Java类的扩展。Ant运行需要的XML格式的文件不是Shell命令文件。它是由一个Project组成的，而一个Project又可分成可多target，target再细分又分成很多task，每一个task都是通过一个实现特定接口的java类来完成的。

Ant的优点

Ant是Apache软件基金会JAKARTA目录中的一个子项目，它有以下的优点。
跨平台性。Ant是存Java语言编写的，所示具有很好的跨平台性。
操作简单。Ant是由一个内置任务和可选任务组成的。Ant运行时需要一个XML文件(构建文件)。Ant通过调用target树，就可以执行各种task。每个task实现了特定接口对象。由于Ant构建文件时XML格式的文件，所以和容易维护和书写，而且结构很清晰。
Ant可以集成到开发环境中。由于Ant的跨平台性和操作简单的特点，它很容易集成到一些开发环境中去。

Ant 开发

Ant的构建文件
当开始一个新的项目时，首先应该编写Ant构建文件。构建文件定义了构建过程，并被团队开发中每个人使用。Ant构建文件默认命名为build.xml，也可以取其他的名字。只不过在运行的时候把这个命名当作参数传给Ant。构建文件可以放在任何的位置。一般做法是放在项目顶层目录中，这样可以保持项目的简洁和清晰。下面是一个典型的项目层次结构。
(1) src存放文件。
(2) class存放编译后的文件。
(3) lib存放第三方JAR包。
(4) dist存放打包，发布以后的代码。
Ant构建文件是XML文件。每个构建文件定义一个唯一的项目(Project元素)。每个项目下可以定义很多目标(target元素)，这些目标之间可以有依赖关系。当执行这类目标时，需要执行他们所依赖的目标。每个目标中可以定义多个任务，目标中还定义了所要执行的任务序列。Ant在构建目标时必须调用所定义的任务。任务定义了Ant实际执行的命令。Ant中的任务可以为3类。
（1）核心任务。核心任务是Ant自带的任务。
（2）可选任务。可选任务实来自第三方的任务，因此需要一个附加的JAR文件。
（3）用户自定义的任务。用户自定义的任务实用户自己开发的任务。
1.标签
每个构建文件对应一个项目。标签时构建文件的根标签。它可以有多个内在属性，

就如代码中所示，其各个属性的含义分别如下。
(1) default表示默认的运行目标，这个属性是必须的。
(2) basedir表示项目的基准目录。
(3) name表示项目名。
(4) description表示项目的描述。
每个构建文件都对应于一个项目，但是大型项目经常包含大量的子项目，每一个子项目都可以有自己的构建文件。

2.标签
一个项目标签下可以有一个或多个target标签。一个target标签可以依赖其他的target标签。例如，有一个target用于编译程序，另一个target用于声称可执行文件。在生成可执行文件之前必须先编译该文件，因策可执行文件的target依赖于编译程序的target。Target的所有属性如下。
(1).name表示标明，这个属性是必须的。
(2).depends表示依赖的目标。
(3)if表示仅当属性设置时才执行。
(4)unless表示当属性没有设置时才执行。
(5)description表示项目的描述。
Ant的depends属性指定了target的执行顺序。Ant会依照depends属性中target出现顺序依次执行每个target。在执行之前，首先需要执行它所依赖的target。程序中的名为run的target的

depends属性compile，而名为compile的target的depends属性是prepare，所以这几个target执

行的顺序是prepare->compile->run。
一个target只能被执行一次，即使有多个target依赖于它。如果没有if或unless属性，target总

会被执行。

3.标签
该标签用于创建一个目录，它有一个属性dir用来指定所创建的目录名，其代码如下：

通过以上代码就创建了一个目录，这个目录已经被前面的property标签所指定。

4标签
该标签用来生成一个JAR文件，其属性如下。
(1) destfile表示JAR文件名。
(2) basedir表示被归档的文件名。
(3) includes表示别归档的文件模式。
(4) exchudes表示被排除的文件模式。

5．
该标签用于编译一个或一组java文件，其属性如下。
(1).srcdir表示源程序的目录。
(2).destdir表示class文件的输出目录。
(3).include表示被编译的文件的模式。
(4).excludes表示被排除的文件的模式。
(5).classpath表示所使用的类路径。
(6).debug表示包含的调试信息。
(7).optimize表示是否使用优化。
(8).verbose 表示提供详细的输出信息。
(9).fileonerror表示当碰到错误就自动停止。

6．标签
该标签用来执行编译生成的.class文件，其属性如下。
(1).classname 表示将执行的类名。
(2).jar表示包含该类的JAR文件名。
(3).classpath所表示用到的类路径。
(4).fork表示在一个新的虚拟机中运行该类。
(5).failonerror表示当出现错误时自动停止。
(6).output 表示输出文件。
(7).append表示追加或者覆盖默认文件。

7.标签
该标签用于删除一个文件或一组文件，去属性如下。
(1)/file表示要删除的文件。
(2).dir表示要删除的目录。
(3).includeEmptyDirs 表示指定是否要删除空目录，默认值是删除。
(4).failonerror 表示指定当碰到错误是否停止，默认值是自动停止。
(5).verbose表示指定是否列出所删除的文件，默认值为不列出。

8.标签
该标签用于文件或文件集的拷贝，其属性如下。
(1).file 表示源文件。
(2).tofile 表示目标文件。
(3).todir 表示目标目录。
(4).overwrite 表示指定是否覆盖目标文件，默认值是不覆盖。
(5).includeEmptyDirs 表示制定是否拷贝空目录，默认值为拷贝。
(6).failonerror 表示指定如目标没有发现是否自动停止，默认值是停止。
(7).verbose 表示制定是否显示详细信息，默认值不显示。

Ant的数据类型
在构建文件中为了标识文件或文件组，经常需要使用数据类型。数据类型包含在

org.apache.tool.ant.types包中。下面镜简单介绍构建文件中一些常用的数据类型。

1. argument 类型
由Ant构建文件调用的程序，可以通过元素向其传递命令行参数，如apply,exec和java任务均可接受嵌套元素，可以为各自的过程调用指定参数。以下是的所有属性。
(1).values 是一个命令参数。如果参数种有空格，但又想将它作为单独一个值，则使用此属性。
(2).file表示一个参数的文件名。在构建文件中，此文件名相对于当前的工作目录。
(3).line表示用空格分隔的多个参数列表。
(4).path表示路径。

2.ervironment 类型
由Ant构建文件调用的外部命令或程序，元素制定了哪些环境变量要传递给正在执行的系统命令，元素可以接受以下属性。
(1).file表示环境变量值得文件名。此文件名要被转换位一个绝对路径。
(2).path表示环境变量的路径。Ant会将它转换为一个本地约定。
(3).value 表示环境变量的一个直接变量。
(4).key 表示环境变量名。
注意 file path 或 value只能取一个。

3.filelist类型
Filelist 是一个支持命名的文件列表的数据类型，包含在一个filelist类型中的文件不一定是

存在的文件。以下是其所有的属性。
(1).dir是用于计算绝对文件名的目录。
(2).files 是用逗号分隔的文件名列表。
(3).refid 是对某处定义的一个的引用。
注意 dir 和 files 都是必要的，除非指定了refid(这种情况下，dir和files都不允许使用)。

4.fileset类型
Fileset 数据类型定义了一组文件，并通常表示为元素。不过，许多ant任务构建成了隐式的fileset,这说明他们支持所有的fileset属性和嵌套元素。以下为fileset 的属性列表。 (1).dir表示fileset 的基目录。
(2).casesensitive的值如果为false，那么匹配文件名时，fileset不是区分大小写的，其默认

值为true.
(3).defaultexcludes 用来确定是否使用默认的排除模式，默认为true。
(4).excludes 是用逗号分隔的需要派出的文件模式列表。
(5).excludesfile 表示每行包含一个排除模式的文件的文件名。
(6).includes 是用逗号分隔的，需要包含的文件模式列表。
(7).includesfile 表示每行包括一个包含模式的文件名。

5.patternset 类型
Fileset 是对文件的分组，而patternset是对模式的分组，他们是紧密相关的概念。支持4个属性：includes excludex includexfile 和 excludesfile,与fileset相同。Patternset 还允许以下嵌套元素：include,exclude,includefile 和 excludesfile.

6.filterset 类型
Filterset定义了一组过滤器，这些过滤器将在文件移动或复制时完成文件的文本替换。
主要属性如下：
(1).begintoken 表示嵌套过滤器所搜索的记号，这是标识其开始的字符串。
(2).endtoken表示嵌套过滤器所搜索的记号这是标识其结束的字符串。
(3).id是过滤器的唯一标志符。
(4).refid是对构建文件中某处定义一个过滤器的引用。

7.Path类型
Path元素用来表示一个类路径，不过它还可以用于表示其他的路径。在用作揖个属性时，路经中的各项用分号或冒号隔开。在构建的时候，此分隔符将代替当前平台中所有的路径分隔符，其拥有的属性如下。
(1).location 表示一个文件或目录。Ant在内部将此扩展为一个绝对路径。
(2).refid 是对当前构建文件中某处定义的一个path的引用。
(3).path表示一个文件或路径名列表。

8.mapper类型
Mapper类型定义了一组输入文件和一组输出文件间的关系，其属性如下。
(1).classname 表示实现mapper类的类名。当内置mapper不满足要求时，用于创建定制mapper.
(2).classpath表示查找一个定制mapper时所用的类型路径。
(3).classpathref是对某处定义的一个类路径的引用。
(4).from属性的含义取决于所用的mapper.
(5).to属性的含义取决于所用的mapper.
(6).type属性的取值为identity，flatten glob merge regexp 其中之一，它定义了要是用的内置mapper的类型。

Ant 的运行
安装好Ant并且配置好路径之后，在命令行中切换到构建文件的目录，输入Ant命令就可以运行Ant.若没有指定任何参数，Ant会在当前目录下查询build.xml文件。如果找到了就用该文件作为构建文件。如果使用了 –find 选项，Ant 就会在上级目录中找构建文件，直至到达文件系统得跟目录。如果构建文件的名字不是build.xml ，则Ant运行的时候就可以使用 –buildfile file ,这里file 指定了要使用的构建文件的名称，示例如下：
Ant
如下说明了表示当前目录的构建文件为build.xml 运行 ant 执行默认的目标。

Ant –buildfile test.xml
使用当前目录下的test.xml 文件运行Ant ,执行默认的目标。

菠萝 2007-08-12 12:43 发表评论

ant中文教程

菠萝 — Tue, 07 Aug 2007 13:29:00 GMT

还不是很全，只有基本的内容：
1 Ant是什么？
Apache Ant 是一个基于 Java的生成工具。
生成工具在软件开发中用来将源代码和其他输入文件转换为可执行文件的形式（也有可能转换为可安装的产品映像形式）。随着应用程序的生成过程变得更加复杂，确保在每次生成期间都使用精确相同的生成步骤，同时实现尽可能多的自动化，以便及时产生一致的生成版本
2 下载、安装Ant
安装Ant
下载.zip文件，解压缩到c:\ant1.3(后面引用为%ANT_HOME%)

2.1 在你运行Ant之前需要做一些配置工作。
? 将bin目录加入PATH环境变量。
? 设定ANT_HOME环境变量，指向你安装Ant的目录。在一些OS上，Ant的脚本可以猜测ANT_HOME（Unix和Windos NT/2000）－但最好不要依赖这一特性。
? 可选地，设定JAVA_HOME环境变量（参考下面的高级小节），该变量应该指向你安装JDK的目录。
注意：不要将Ant的ant.jar文件放到JDK/JRE的lib/ext目录下。Ant是个应用程序，而lib/ext目录是为JDK扩展使用的（如JCE，JSSE扩展）。而且通过扩展装入的类会有安全方面的限制。
2.2 运行Ant

运行Ant非常简单，当你正确地安装Ant后，只要输入ant就可以了。

? 没有指定任何参数时，Ant会在当前目录下查询build.xml文件。如果找到了就用该文件作为buildfile。如果你用 -find 选项。Ant就会在上级目录中寻找buildfile，直至到达文件系统的根。要想让Ant使用其他的buildfile，可以用参数 -buildfile file，这里file指定了你想使用的buildfile。

? 可以指定执行一个或多个target。当省略target时，Ant使用标签的default属性所指定的target。

命令行选项总结：
ant [options] [target [target2 [target3] ...]]
Options:
-help print this message
-projecthelp print project help information
-version print the version information and exit
-quiet be extra quiet
-verbose be extra verbose
-debug print debugging information
-emacs produce logging information without adornments
-logfile file use given file for log output
-logger classname the class that is to perform logging
-listener classname add an instance of class as a project listener
-buildfile file use specified buildfile
-find file search for buildfile towards the root of the filesystem and use the first one found
-Dproperty=value set property to value
例子
ant
使用当前目录下的build.xml运行Ant，执行缺省的target。
ant -buildfile test.xml
使用当前目录下的test.xml运行Ant，执行缺省的target。
ant -buildfile test.xml dist
使用当前目录下的test.xml运行Ant，执行一个叫做dist的target。
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.1 Projects

project有下面的属性：
Attribute Description Required
name 项目名称. No
default 当没有指定target时使用的缺省target Yes
basedir 用于计算所有其他路径的基路径。该属性可以被basedir property覆盖。当覆盖时，该属性被忽略。如果属性和basedir property都没有设定，就使用buildfile文件的父目录。 No
项目的描述以一个顶级的元素的形式出现（参看description小节）。

一个项目可以定义一个或多个target。一个target是一系列你想要执行的。执行Ant时，你可以选择执行那个target。当没有给定target时，使用project的default属性所确定的target。

3.2 Targets

一个target可以依赖于其他的target。例如，你可能会有一个target用于编译程序，一个target用于生成可执行文件。你在生成可执行文件之前必须先编译通过，所以生成可执行文件的target依赖于编译target。Ant会处理这种依赖关系。

然而，应当注意到，Ant的depends属性只指定了target应该被执行的顺序－如果被依赖的target无法运行，这种depends对于指定了依赖关系的target就没有影响。

Ant会依照depends属性中target出现的顺序（从左到右）依次执行每个target。然而，要记住的是只要某个target依赖于一个target，后者就会被先执行。

假定我们要执行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因该有所判断的属性。例如：

如果没有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.3 Tasks

一个task是一段可执行的代码。

一个task可以有多个属性（如果你愿意的话，可以将其称之为变量）。属性只可能包含对property的引用。这些引用会在task执行前被解析。

下面是Task的一般构造形式：

这里name是task的名字，attributeN是属性名，valueN是属性值。

有一套内置的（built-in）task，以及一些可选task，但你也可以编写自己的task。

所有的task都有一个task名字属性。Ant用属性值来产生日志信息。

可以给task赋一个id属性：

这里taskname是task的名字，而taskID是这个task的唯一标识符。通过这个标识符，你可以在脚本中引用相应的task。例如，在脚本中你可以这样：

设定某个task实例的foo属性。在另一个task中（用java编写），你可以利用下面的语句存取相应的实例。
project.getReference("task1").
注意1：如果task1还没有运行，就不会被生效（例如：不设定属性），如果你在随后配置它，你所作的一切都会被覆盖。

注意2：未来的Ant版本可能不会兼容这里所提的属性，因为很有可能根本没有task实例，只有proxies。

3.4 Properties

一个project可以有很多的properties。可以在buildfile中用property task来设定，或在Ant之外设定。一个property有一个名字和一个值。property可用于task的属性值。这是通过将属性名放在"${"和"}"之间并放在属性值的位置来实现的。例如如果有一个property builddir的值是"build"，这个property就可用于属性值：${builddir}/classes。这个值就可被解析为build/classes。

内置属性

如果你使用了 task 定义了所有的系统属性，Ant允许你使用这些属性。例如，${os.name}对应操作系统的名字。

要想得到系统属性的列表可参考the Javadoc of System.getProperties。

除了Java的系统属性，Ant还定义了一些自己的内置属性：
basedir project基目录的绝对路径 (与的basedir属性一样)。
ant.file buildfile的绝对路径。
ant.version Ant的版本。
ant.project.name 当前执行的project的名字；由的name属性设定.
ant.java.version Ant检测到的JVM的版本；目前的值有"1.1", "1.2", "1.3" and "1.4".

例子

3.5 Path-like Structures
你可以用":"和";"作为分隔符，指定类似PATH和CLASSPATH的引用。Ant会把分隔符转换为当前系统所用的分隔符。

当需要指定类似路径的值时，可以使用嵌套元素。一般的形式是

location属性指定了相对于project基目录的一个文件和目录，而path属性接受逗号或分号分隔的一个位置列表。path属性一般用作预定义的路径－－其他情况下，应该用多个location属性。

为简洁起见，classpath标签支持自己的path和location属性。所以：

可以被简写作：

也可通过元素指定路径。构成一个fileset的多个文件加入path-like structure的顺序是未定的。

上面的例子构造了一个路径值包括：${classpath}的路径，跟着lib目录下的所有jar文件，接着是classes目录。

如果你想在多个task中使用相同的path-like structure，你可以用元素定义他们（与target同级），然后通过id属性引用－－参考Referencs例子。

path-like structure可能包括对另一个path-like structurede的引用（通过嵌套元素）：

前面所提的关于的简洁写法对于也是有效的，如：

可写成：

命令行变量

有些task可接受参数，并将其传递给另一个进程。为了能在变量中包含空格字符，可使用嵌套的arg元素。
Attribute Description Required
value 一个命令行变量；可包含空格字符。只能用一个
line 空格分隔的命令行变量列表。
file 作为命令行变量的文件名；会被文件的绝对名替代。
path 一个作为单个命令行变量的path-like的字符串；或作为分隔符，Ant会将其转变为特定平台的分隔符。

例子

是一个含有空格的单个的命令行变量。

是两个空格分隔的命令行变量。

是一个命令行变量，其值在DOS系统上为\dir;\dir2;\dir3；在Unix系统上为/dir:/dir2:/dir3 。

References

buildfile元素的id属性可用来引用这些元素。如果你需要一遍遍的复制相同的XML代码块，这一属性就很有用－－如多次使用结构。

下面的例子：

可以写成如下形式：

所有使用PatternSets, FileSets 或 path-like structures嵌套元素的task也接受这种类型的引用。

4.1 File（Directory）类
4.1.1 Mkdir
? 创建一个目录，如果他的父目录不存在，也会被同时创建。
? 例子：

? 说明：如果build不存在，也会被同时创建
4.1.2 Copy
? 拷贝一个（组）文件、目录
? 例子：
1. 拷贝单个的文件：

2. 拷贝单个的文件到指定目录下

3. 拷贝一个目录到另外一个目录下

4. 拷贝一批文件到指定目录下

5. 拷贝一批文件到指定目录下，将文件名后增加。Bak后缀

6. 拷贝一组文件到指定目录下，替换其中的@标签@内容

4.1.3 Delete
? 删除一个（组）文件或者目录
? 例子
1. 删除一个文件

2. 删除指定目录及其子目录

3. 删除指定的一组文件

4. 删除指定目录及其子目录，包括他自己

4.1.4 Move
? 移动或重命名一个（组）文件、目录
? 例子：
1. 移动或重命名一个文件

2. 移动或重命名一个文件到另一个文件夹下面

3. 将一个目录移到另外一个目录下

4. 将一组文件移动到另外的目录下

5. 移动文件过程中增加。Bak后缀

4.2 Java相关
4.2.1 Javac
? 编译java原代码
? 例子
1. destdir="${build}"
classpath="xyz.jar"
debug="on"
/>
编译${src}目录及其子目录下的所有。Java文件，。Class文件将放在$｛build｝指定的目录下，classpath表示需要用到的类文件或者目录，debug设置为on表示输出debug信息
2. destdir="${build}"
includes="mypackage/p1/**,mypackage/p2/**"
excludes="mypackage/p1/testpackage/**"
classpath="xyz.jar"
debug="on"
/>
编译${src}和${src2}目录及其子目录下的所有。Java文件，但是package/p1/**,mypackage/p2/**将被编译，而mypackage/p1/testpackage/**将不会被编译。Class文件将放在$｛build｝指定的目录下，classpath表示需要用到的类文件或者目录，debug设置为on表示输出debug信息
3.

destdir="${src}"
classpath="${classpath}"
debug="on"
/>
路径是在property中定义的
4.2.2 java
? 执行指定的java类

? 例子：
1.

classname中指定要执行的类，classpath设定要使用的环境变量
2.

4.3 打包相关
4.3.1 jar
? 将一组文件打包
? 例子：
1.
将${build}/classes下面的所有文件打包到${dist}/lib/app.jar中
2. basedir="${build}/classes"
includes="mypackage/test/**"
excludes="**/Test.class"
/>
将${build}/classes下面的所有文件打包到${dist}/lib/app.jar中，但是包括mypackage/test／所有文件不包括所有的Test.class
3. basedir="${build}/classes"
includes="mypackage/test/**"
excludes="**/Test.class"
manifest=”my.mf”
/>
manifest属性指定自己的META-INF/MANIFEST.MF文件，而不是由系统生成
4.3.2 war
? 对Jar的扩展，用于打包Web应用
? 例子：
? 假设我们的文件目录如下：
thirdparty/libs/jdbc1.jar
thirdparty/libs/jdbc2.jar
build/main/com/myco/myapp/Servlet.class
src/metadata/myapp.xml
src/html/myapp/index.html
src/jsp/myapp/front.jsp
src/graphics/images/gifs/small/logo.gif
src/graphics/images/gifs/large/logo.gif
? 下面是我们的任务的内容：

prefix="images"/>

? 完成后的结果：
WEB-INF/web.xml
WEB-INF/lib/jdbc2.jar
WEB-INF/classes/com/myco/myapp/Servlet.class
META-INF/MANIFEST.MF
index.html
front.jsp
images/small/logo.gif
images/large/logo.gif
4.3.3 ear
? 用于打包企业应用
? 例子

4.4 时间戳
在生成环境中使用当前时间和日期，以某种方式标记某个生成任务的输出，以便记录它是何时生成的，这经常是可取的。这可能涉及编辑一个文件，以便插入一个字符串来指定日期和时间，或将这个信息合并到 JAR 或 zip 文件的文件名中。
这种需要是通过简单但是非常有用的 tstamp 任务来解决的。这个任务通常在某次生成过程开始时调用，比如在一个 init 目标中。这个任务不需要属性，许多情况下只需就足够了。
tstamp 不产生任何输出；相反，它根据当前系统时间和日期设置 Ant 属性。下面是 tstamp 设置的一些属性、对每个属性的说明，以及这些属性可被设置到的值的例子：
属性说明例子
DSTAMP 设置为当前日期，默认格式为yyyymmdd 20031217
TSTAMP 设置为当前时间，默认格式为 hhmm 1603
TODAY 设置为当前日期，带完整的月份 2003 年 12 月 17 日
例如，在前一小节中，我们按如下方式创建了一个 JAR 文件：

在调用 tstamp 任务之后，我们能够根据日期命名该 JAR 文件，如下所示：

因此，如果这个任务在 2003 年 12 月 17 日调用，该 JAR 文件将被命名为 package-20031217.jar。
还可以配置 tstamp 任务来设置不同的属性，应用一个当前时间之前或之后的时间偏移，或以不同的方式格式化该字符串。所有这些都是使用一个嵌套的 format 元素来完成的，如下所示：

pattern="HH:mm:ss"
offset="10" unit="minute"/>

上面的清单将 OFFSET_TIME 属性设置为距离当前时间 10 分钟之后的小时数、分钟数和秒数。
用于定义格式字符串的字符与 java.text.SimpleDateFormat 类所定义的那些格式字符相同

4.5 执行SQL语句
? 通过jdbc执行SQL语句
? 例子：
1. driver="org.gjt.mm.mysql.Driver"
url="jdbc:mysql://localhost:3306/mydb"
userid="root"
password="root"
src="data.sql"
/>
2. driver="org.database.jdbcDriver"
url="jdbc:database-url"
userid="sa"
password="pass"
src="data.sql"
rdbms="oracle"
version="8.1."
>

只有在oracle、版本是8.1的时候才执行

4.6 发送邮件
? 使用SMTP服务器发送邮件
? 例子：

The ${buildname} nightly build has completed

? mailhost： SMTP服务器地址
? mailport：服务器端口
? subject：主题
? from：发送人地址
? to：接受人地址
? message：发送的消息
? fileset：设置附件

菠萝 2007-08-07 21:29 发表评论

Ant十五大最佳实践

菠萝 — Mon, 06 Aug 2007 15:53:00 GMT

作者：Eric M. Burke 来自：onjava

　　在 Ant 出现之前，构建和部署Java应用需要使用包括特定平台的脚本、Make文件、各种版本的IDE甚至手工操作的“大杂烩”。现在，几乎所有的开源Java项目都在使用Ant，大多数公司的内部项目也在使用Ant。Ant在这些项目中的广泛使用自然导致了读者对一整套Ant最佳实践的迫切需求。

　　本文总结了我喜爱的Ant技巧或最佳实践，多数是从我亲身经历的项目错误或我听说的其他人经历的 “恐怖”故事中得到灵感的。比如，有人告诉我有个项目把XDoclet 生成的代码放入带有锁定文件功能的版本控制工具中。当开发者修改源代码时，他必须记住手工检出（Check out）并锁定所有将要重新生成的文件。然后，手工运行代码生成器，只到这时他才能够让Ant编译代码，这一方法还存在如下一些问题：

　　□ 生成的代码无法存储在版本控制系统中。
　　□ Ant（本案例中是Xdoclet）应该自动确定下一次构建涉及的源文件，而不应由程序员手工确定。
　　□ Ant的构建文件应该定义好正确的任务依赖关系，这样程序员就不必为了完成构建而不得不按照特定顺序调用任务。

　　当我开始一个新项目时，我首先编写Ant构建文件。Ant文件明确地定义构建的过程，并被团队中的每个程序员使用。本文所列的技巧基于这样的假定：Ant构建文件是一个必须仔细编写的重要文件，它应在版本控制系统中得到维护，并被定期进行重构。下面是我的十五大Ant最佳实践。

　　1. 采用一致的编码规范

　　Ant用户有的喜欢有的痛恨其构建文件的XML语法。与其跳进这一令人迷惑的争论中，不如让我们先看一些能保持XML构建文件简洁的方法。

　　首先也是最重要的，花费时间格式化你的XML让它看上去很清晰。不论XML是否美观，Ant都可以工作。但是丑陋的XML很难令人读懂。倘若你在任务之间留出空行，有规则的缩进，每行文字不超过90列左右，那么XML令人惊讶地易读。再加上使用能够高亮XML语法的优秀编辑器或IDE工具，你就不会有阅读的麻烦。

　　同样，精选含意明确、容易读懂的词汇来命名任务和属性。比如，dir.reports就比rpts好。特定的编码规范并不重要，只要拿出一套规范并坚持使用就行。

　　2. 将build.xml放在项目根目录中

　　Ant构建文件build.xml可以放在任何位置，但是放在项目顶级目录中可以保持项目简洁。这是最常用的规范，开发者能够在顶级目录中找到预期的build.xml。把构建文件放在根目录中，也能够使人容易了解项目目录树中不同目录之间的逻辑关系。以下是一个典型的项目目录层次：

[root dir]
| build.xml
+--src
+--lib (包含第三方 JAR包)
+--build (由 build任务生成)
+--dist (由 build任务生成)

　　当build.xml在顶级目录时，假设你处于项目某个子目录中，只要输入：ant -find compile 命令，不需要改变工作目录就能够以命令行方式编译代码。参数-find告诉Ant寻找存在于上级目录中的build.xml并执行。

　　3. 使用单一的构建文件

　　有人喜欢将一个大项目分解成几个小的构建文件，每个构建文件分担整个构建过程的一小部分工作。这确实是看法不同的问题，但是应该认识到，将构建文件分割会增加对整体构建过程的理解难度。要注意在单一构建文件能够清楚表现构建层次的情况下不要过工程化(over-engineer)。

　　即使你把项目划分为多个构建文件，也应使程序员能够在项目根目录下找到核心build.xml。尽管该文件只是将实际构建工作委派给下级构建文件，也应保证该文件可用。

　　4. 提供良好的帮助说明

　　应尽量使构建文件自文档化。增加任务描述是最简单的方法。当你输入ant -projecthelp时，你就可以看到带有描述的任务清单。比如，你可以这样定义任务：

description="Compiles code, output goes to the build dir.">

　　最简单的规则是把所有你想让程序员通过命令行就可以调用的任务都加上描述。对于一般用来执行中间处理过程的内部任务，比如生成代码或建立输出目录等，就无法使用描述属性。

　　这时，可以通过在构建文件中加入XML注释来处理。或者专门定义一个help任务，当程序员输入ant help时来显示详细的使用说明。

Detailed help...

　　5. 提供清除任务

　　每个构建文件都应包含一个清除任务，用来删除所有生成的文件和目录，使系统回到构建文件执行前的初始状态。执行清空任务后还存在的文件都应处在版本控制系统的管理之下。比如：

description="Destroys all generated files and dirs.">

　　除非是在产生整个系统版本的特殊任务中，否则不要自动调用clean任务。当程序员仅仅执行编译任务或其他任务时，他们不需要构建文件事先执行既令人讨厌又没有必要的清空任务。要相信程序员能够确定何时需要清空所有文件。

　　6. 使用ANT管理任务从属关系

　　假设你的应用由Swing GUI组件、Web界面、EJB层和公共应用代码组成。在大型系统中，你需要清晰地定义每个Java包属于系统的哪一层。否则任何一点修改都要被迫重新编译成百上千个文件。糟糕的任务从属关系管理会导致过度复杂而脆弱的系统。改变GUI面板的设计不应造成Servlet和EJB的重编译。

　　当系统变得庞大后，稍不注意就可能将依赖于客户端的代码引入到服务端。这是因为典型的IDE项目文件编译任何文件都使用单一的classpath。而Ant能让你更有效地控制构建活动。

　　设计你的Ant构建文件编译大型项目的步骤：首先，编译公共应用代码，将编译结果打成JAR包文件。然后，编译上一层的项目代码，编译时依靠第一步产生的JAR文件。不断重复这一过程，直到最高层的代码编译完成。

　　分步构建强化了任务从属关系管理。如果你工作在底层Java框架上，偶然引用到高层的GUI模板组件，这时代码不需要编译。这是由于构建文件在编译底层框架时在源路径中没有包含高层GUI面板组件的代码。

　　7. 定义并重用文件路径

　　如果文件路径在一个地方一次性集中定义，并在整个构建文件中得到重用，那么构建文件更易于理解。以下是这样做的一个例子：

    ...etc

　　当项目不断增长构建日益复杂时，这一技术越发体现出其价值。你可能需要为编译不同层次的应用定义各自的文件路径，比如运行单元测试的、运行应用程序的、运行Xdoclet的、生成JavaDocs的等等不同路径。这种组件化路径定义的方法比为每个任务单独定义路径要优越得多。否则，很容易丢失任务从属关系的轨迹。

　　8. 定义恰当的任务从属关系

　　假设dist任务从属于jar任务，那么哪个任务从属于compile任务哪个任务从属于prepare任务呢？Ant构建文件最终定义了任务的从属关系图，它必须被仔细地定义和维护。

　　应该定期检查任务的从属关系以保证构建工作得到正确执行。大的构建文件随着时间推移趋向于增加更多的任务，所以到最后可能由于不必要的从属关系导致构建工作非常困难。比如，你可能发现在程序员只需编译一些没有使用EJB的GUI代码时又重新生成了EJB代码。

　　以“优化”的名义忽略任务的从属关系是另一种常见的错误。这种错误迫使程序员为了得到恰当的结果必须记住并按照特定的顺序调用一串任务。更好的做法是：提供描述清晰的公共任务，这些任务包含正确的任务从属关系；另外提供一套“专家”任务让你能够手工执行个别的构建步骤，这些任务不提供完整的构建过程，但是让那些专家用户在快速而恼人的编码期间能够跳过某些步骤。

　　9.使用属性

　　任何需要配置或可能发生变化的信息都应作为Ant属性定义下来。对于在构建文件中多次出现的值也同样处理。属性既可以在构建文件头部定义，也可以为了更好的灵活性而在单独的属性文件中定义。以下是在构建文件中定义属性的样式：

value="${jdom.home}/build/${jdom.jar}"/>
etc...

　　或者你可以使用属性文件：

etc...

　　在属性文件 sample.properties中:

dir.build=build
dir.src=src
jdom.home=../java-tools/jdom-b8
jdom.jar=jdom.jarjdom.jar.withpath=${jdom.home}/build/${jdom.jar}

　　用一个独立的文件定义属性是有好处的，它可以清晰地定义构建中的可配置部分。另外，在开发者工作在不同操作系统的情况下，你可以在不同的平台上提供该文件的不同版本。

　　10. 保持构建过程独立

　　为了最大限度的扩展性，不要应用外部路径和库文件。最重要的是不要依赖于程序员的CLASSPATH设置。取而代之的是，在构建文件中使用相对路径并定义自己的路径。如果你引用了绝对路径如C:\java\tools，其他开发者未必使用与你相同的目录结构，所以就无法使用你的构建文件。

　　如果你部署开放源码项目，应该提供包含编译代码所需的所有JAR文件的发行版本。当然，这是在遵守许可协议的基础上。对于内部项目，相关的JAR文件都应在版本控制系统的管理中，并捡出（check out）到大家都知道的位置。

　　当你必须引用外部路径时，应将路径定义为属性。使程序员能够用适合他们自己的机器环境的参数重载这些属性。你也可以使用以下语法引用环境变量：

　　11. 使用版本控制系统

　　构建文件是一个重要的制品，应该像代码一样进行版本控制。当你标记你的代码时，也应用同样的标签标记构建文件。这样当你需要回溯到旧版本并进行构建时，能够使用相应版本的构建文件。

　　除构建文件之外，你还应在版本控制中维护第三方JAR文件。同样，这使你能够重新构建旧版本的软件。这也能够更容易保证所有开发者拥有一致的JAR文件，因为他们都是同构建文件一起从版本控制系统中捡出的。

　　通常应避免在版本控制系统中存放构建成果。倘若你的源代码很好地得到了版本控制，那么通过构建过程你能够重新生成任何版本的产品。

　　12. 把Ant作为“最小公分母”

　　假设你的开发团队使用IDE工具，当程序员通过点击图标就能够构建整个应用时为什么还要为Ant而烦恼呢？

　　IDE的问题是一个关于团队一致性和重现性的问题。几乎所有的IDE设计初衷都是为了提高程序员的个人生产率，而不是开发团队的持续构建。典型的IDE要求每个程序员定义自己的项目文件。程序员可能拥有不同的目录结构，可能使用不同版本的库文件，还可能工作在不同的平台上。这将导致出现这种情况：在Bob那里运行良好的代码，到Sally那里就无法运行。

　　不管你的开发团队使用何种IDE，一定要建立所有程序员都能够使用的Ant构建文件。要建立一个程序员在将新代码提交版本控制系统前必须执行Ant构建文件的规则。这将确保代码是经过同一个Ant构建文件构建的。当出现问题时，要使用项目标准的Ant构建文件，而不是通过某个IDE来执行一个干净的构建。

　　程序员可以自由选择任何他们习惯使用的IDE工具或编辑器。但是Ant应作为公共基线以保证代码永远是可构建的。

　　13. 使用zipfileset属性

　　人们经常使用Ant产生WAR、JAR、ZIP和 EAR文件。这些文件通常都要求有一个特定的内部目录结构，但其往往与你的源代码和编译环境的目录结构不匹配。

　　一个最常用的方法是写一个Ant任务，按照期望的目录结构把一大堆文件拷贝到临时目录中，然后生成压缩文件。这不是最有效的方法。使用zipfileset属性是更好的解决方案。它让你从任何位置选择文件，然后把它们按照不同目录结构放进压缩文件中。以下是一个例子：

    appxml="${dir.resources}/application.xml">

　　在这个例子中，所有JAR文件都放在EAR文件包的lib目录中。hr.jar和billing.jar是从构建目录拷贝过来的。因此我们使用zipfileset属性把它们移动到EAR文件包内部的lib目录。prefix属性指定了其在EAR文件中的目标路径。

　　14. 测试Clean任务

　　假设你的构建文件中有clean和compile的任务，执行以下的测试。第一步，执行ant clean；第二步，执行ant compile；第三步，再执行ant compile。第三步应该不作任何事情。如果文件再次被编译，说明你的构建文件有问题。

　　构建文件应该只在与输出文件相关联的输入文件发生变化时执行任务。一个构建文件在不必执行诸如编译、拷贝或其他工作任务的时候执行这些任务是低效的。当项目规模增长时，即使是小的低效工作也会成为大的问题。

　　15. 避免特定平台的Ant封装

　　不管什么原因，有人喜欢用简单的、名称叫做compile之类的批文件或脚本装载他们的产品。当你去看脚本的内容你会发现以下内容：

　　ant compile

　　其实开发人员都很熟悉Ant，并且完全能够自己键入ant compile。请不要仅仅为了调用Ant而使用特定平台的脚本。这只会使其他人在首次使用你的脚本时增加学习和理解的烦扰。除此之外，你不可能提供适用于每个操作系统的脚本，这是真正烦扰其他用户的地方。

　　总结

　　太多的公司依靠手工方法和特别程序来编译代码和生成软件发布版本。那些不使用Ant或类似工具定义构建过程的开发团队，花费了太多的时间来捕捉代码编译过程中出现的问题：在某些开发者那里编译成功的代码，到另一些开发者那里却失败了。

　　生成并维护构建脚本不是一项富有魅力的工作，但却是一项必需的工作。一个好的Ant构建文件将使你能够集中到更喜欢的工作——写代码中去！

　　参考

　　☆ http://ant.apache.org/ Ant
　　☆ http://www.ericburke.com/ AntGraph: Ant依赖性的可视化工具
　　☆ http://www.oreilly.com/catalog/anttdg/index.html?CMP=IL7015 Ant: The Definitive Guide, O'Reilly
　　☆ http://www.oreilly.com/catalog/jextprockbk/index.html?CMP=IL7015 Java Extreme Programming Cookbook, O'Reilly

　　原文：http://www.onjava.com/pub/a/onjava/2003/12/17/ant_bestpractices.html
　　翻译：徐彤 MSN:xt121@hotmail.com

菠萝 2007-08-06 23:53 发表评论