---
title: "编写build.xml(zz)"
author: "winzenghua"
date: "2005-04-29T09:26:00Z"
tags: []
slug: "build-xml-zz"
draft: false
lastmod: "2005-04-29T09:26:00Z"
id: 988169
url: "https://java4gis.iteye.com/blog/988169"
---

Apache Ant: Apache Ant is a Java-based build tool. In theory, it is kind of

like Make, but without Make's wrinkles

上面是官方的定义, 说白了， 就是编译工具， 免费，高效。

我专门为写ejb来定义的：Build.xml  
大家都知道， ant在compare一个project的时候， 必须编写一个XML， 我们单位为了节

省费用， 没有购买Jbuilder， 开发工具有：idea,netBean和Eclipse,我对Eclipse不是

很熟悉， 对于jb和idea是用的比较多的， 然而在一般的编译器里面， 我们无法形成两

个jar文件， 如果你计划使用ejb， 并且你准备使用分布式的部署， 你将不得不为你的

ejb的client来从新生成一个不包含yourEjbNameBean的jar文件。还有在jboss上部署ejb

在你的META-INF目录里面必须包含两个xml文件：ejb-jar.xml和jboss.xml， 在

jbuilder里面你可以自由的增加jar里面的xml文件， 在idea里面不行， 而ant可以由你

任意增加。

为了实现以上两个目的，我编写build.xml文件如下：

&lt;?xml version="1.0" encoding="GB2312" ?&gt;

&lt;!--

参照ant的jakarta-ant-1.6alpha的build.xml

Copyright (c) 2002 The Neusoft Software Foundation. All rights reserved.

============================================================

--&gt;

&lt;!--

文档结构为:

&lt;project&gt;

&lt;property/&gt; 全局变量的定义

&lt;property/&gt;...

&lt;target name="1"&gt; 任务组(tasks)

&lt;javac&gt;&lt;/javac&gt; 一项javac任务

...

&lt;oneTask&gt;&lt;/ontTask&gt; 一项其它任务

&lt;/target&gt;

&lt;target name="2"&gt;

&lt;javac&gt;&lt;/javac&gt;

...

&lt;oneTask&gt;&lt;/ontTask&gt;

&lt;/target&gt;

&lt;/project&gt;

project代表一个项目，

default:运行到名称为"dist"的target(任务组)

basedir:基准路径。

--&gt;

&lt;project default="dist" basedir="."&gt;

&lt;!--

定义属性（property tasks）

最好把用到的路径呀，名称呀都在这里定义成全局变量

例：定义

&lt;property name="a" value="hello"/&gt;

以后就可以这样用它：

&lt;property name="b" value="${a}/b"/&gt;

现在:b=="hello/b"

===========================================================

--&gt;

&lt;!--主要的系统环境属性--&gt;

&lt;property environment="env"/&gt;

&lt;!--取window,unix...的环境变量--&gt;

&lt;property name="java.home" value="${env.JAVA\_HOME}"/&gt;

&lt;property name="ant.home" value="${env.ANT\_HOME}"/&gt;

&lt;property name="jboss.home" value="${env.JBOSS\_HOME}"/&gt;

&lt;property name="classpath" value="${env.classpath}"/&gt;

&lt;property name="deploydir" value="${env.JBOSS\_HOME}/server/default/deploy"/&gt;

&lt;!--主要的app环境属性--&gt;

&lt;property name="app.name" value="ejbtraining"/&gt;

&lt;property name="app.jar" value="${app.name}.jar"/&gt;

&lt;property name="appclient.jar" value="${app.name}client.jar"/&gt;

&lt;property name="app.copyright" value=" Copyright (c) 2004 The Collegesoft

Co., All rights reserved."/&gt;

&lt;!--app中src的属性--&gt;

&lt;property name="src.dir" value="src" /&gt;

&lt;property name="src.main" value="${src.dir}/main"/&gt;

&lt;property name="src.script" value="${src.dir}/script"/&gt;

&lt;property name="etc.dir" value="etc"/&gt;

&lt;!--app用到的lib--&gt;

&lt;property name="lib.dir" value="lib"/&gt;

&lt;!--app的build目录中--&gt;

&lt;property name="build.dir" value="build" /&gt;

&lt;property name="build.classes" value="${build.dir}/classes"/&gt;

&lt;property name="build.classes.metainf" value="${build.classes}/META-INF"/&gt;

&lt;property name="build.docs" value="${build.dir}/docs"/&gt;

&lt;property name="build.docs.api" value="${build.docs}/api"/&gt;

&lt;property name="build.lib" value="${build.dir}/lib"/&gt;

&lt;!--app的dist (distribution) 目录中--&gt;

&lt;property name="dist.dir" value="dist"/&gt;

&lt;property name="dist.bin" value="${dist.dir}/bin"/&gt;

&lt;property name="dist.docs" value="${dist.dir}/docs"/&gt;

&lt;property name="dist.lib" value="${dist.dir}/lib"/&gt;

&lt;property name="dist.lib.server" value="${dist.lib}/server"/&gt;

&lt;property name="dist.lib.client" value="${dist.lib}/client"/&gt;

&lt;!--app的docs目录中--&gt;

&lt;property name="docs.dir" value="docs"/&gt;

&lt;!--

定义一组路径以后可以通过id重用这组路径 ，例：

&lt;javac srcdir="src/main" destdir="build/classes"&gt;

&lt;classpath refid="classpath"/&gt;

&lt;/javac&gt;

--&gt;

&lt;path id="classpath"&gt;

&lt;pathelement location="${classpath}"/&gt;

&lt;pathelement location="${build.classes}"/&gt;

&lt;pathelement path="${java.home}/lib/tools.jar"/&gt;

&lt;pathelement path="${jboss.home}/client/\*.jar"/&gt;

&lt;pathelement path="${jboss.home}/client/lib/\*.jar"/&gt;

&lt;pathelement path="${jboss.home}/server/default/lib/jboss-j2ee.jar"/&gt;

&lt;pathelement path="${jboss.home}/server/default/lib/javax.servlet.jar"/&gt;

&lt;/path&gt;

&lt;!--

init 准备目录(File Tasks)

主要的目录结构通常是不会变的，一起生成他们

--&gt;

&lt;target name="init"&gt;

&lt;!--清除以前目录--&gt;

&lt;delete dir="${build.dir}" failonerror="false" /&gt;

&lt;delete dir="${dist.dir}" failonerror="false"/&gt;

&lt;!--准备目录--&gt;

&lt;mkdir dir="${build.dir}"/&gt;

&lt;mkdir dir="${build.classes}"/&gt;

&lt;mkdir dir="${build.classes.metainf}"/&gt;

&lt;mkdir dir="${build.docs}"/&gt;

&lt;mkdir dir="${build.docs.api}"/&gt;

&lt;mkdir dir="${build.lib}"/&gt;

&lt;mkdir dir="${dist.dir}"/&gt;

&lt;mkdir dir="${dist.bin}"/&gt;

&lt;mkdir dir="${dist.lib}"/&gt;

&lt;mkdir dir="${dist.lib.server}"/&gt;

&lt;mkdir dir="${dist.lib.client}"/&gt;

&lt;/target&gt;

&lt;!--

======================================================

Build the code (Compile Tasks,File Tasks)

======================================================

--&gt;

&lt;target name="build" depends="init"&gt;

&lt;!--编译--&gt;

&lt;javac srcdir="${src.main}" destdir="${build.classes}"&gt;

&lt;classpath refid="classpath"/&gt;

&lt;/javac&gt;

&lt;/target&gt;

&lt;!--

=============================================================

拷贝相关的部署xml文件到META-INF

--&gt;

&lt;target name="ejb-meta-inf" depends="init"&gt;

&lt;copy file="${etc.dir}/ejb-jar.xml"

tofile="${build.classes.metainf}/ejb-jar.xml" /&gt;

&lt;copy file="${etc.dir}/jboss.xml"

tofile="${build.classes.metainf}/jboss.xml" /&gt;

&lt;/target&gt;

&lt;!--

=========================================================

打包文档(Archive Tasks)

Create the project jars: xxx1.jar and xxx2.jar

============================================================

--&gt;

&lt;target name="jars" depends="build,ejb-meta-inf"&gt;

&lt;jar basedir="${build.classes}"

jarfile="${dist.lib.server}/${app.jar}"/&gt;

&lt;jar basedir="${build.classes}" jarfile="${dist.lib.client}/${appclient.jar}"

excludes="com/collegesoft/training/ejb/olympicdate/StatelessDateBean.class,

com/collegesoft/training/ejb/helloejb/HelloBean.class" /&gt;

&lt;/target&gt;

&lt;!--

=============================================================

Creates the API documentation

==============================================================

--&gt;

&lt;target name="javadocs"

depends="jars"

description="--&gt; creates the API documentation"&gt;

&lt;!--copy docs 手册... --&gt;

&lt;copy todir="${build.docs}"&gt;

&lt;fileset dir="${docs.dir}"/&gt;

&lt;/copy&gt;

&lt;javadoc packagenames="com.collegesoft.training.ejb.\*"

sourcepath="${src.main}"

defaultexcludes="yes"

destdir="${build.docs.api}"

author="true"

version="true"

use="true"

windowtitle="Docs API"&gt;

&lt;doctitle&gt;&lt;!\[CDATA\[&lt;h1&gt;hello ant Docs API&lt;/h1&gt;]]&gt;&lt;/doctitle&gt;

&lt;bottom&gt;&lt;!\[CDATA\[&lt;i&gt;${app.copyright}&lt;/i&gt;]]&gt;&lt;/bottom&gt;

&lt;tag name="todo" scope="all" description="To do:" /&gt;

&lt;/javadoc&gt;

&lt;/target&gt;

&lt;!--

======================================================

Create the distribution that can run (Archive Tasks)

主要是从各目录中把该copy的copy上

=====================================================

--&gt;

&lt;target name="dist" depends="javadocs"&gt;

&lt;!--copy bin 执行文件 --&gt;

&lt;copy todir="${dist.bin}"&gt;

&lt;fileset dir="${src.script}/"/&gt;

&lt;/copy&gt;

&lt;copy todir="${dist.docs}"&gt;

&lt;fileset dir="${build.docs}/"/&gt;

&lt;/copy&gt;

&lt;!-- copy lib 文件 --&gt;

&lt;copy todir="${dist.lib}"&gt;

&lt;fileset dir="${build.lib}/"/&gt;

&lt;/copy&gt;

&lt;copy todir="${deploydir}"&gt;

&lt;fileset dir="${dist.lib.server}/"/&gt;

&lt;/copy&gt;

&lt;/target&gt;

&lt;!--

======================================================

Cleans everything(File Tasks)

例如可以删除build中的文件，留给你发挥吧

======================================================

--&gt;

&lt;target name="clear" depends="dist"&gt;

&lt;!--copy bin 执行文件 --&gt;

&lt;copy todir="${dist.bin}"&gt;

&lt;fileset dir="${src.script}/"/&gt;

&lt;/copy&gt;

&lt;copy todir="${dist.docs}"&gt;

&lt;fileset dir="${build.docs}/"/&gt;

&lt;/copy&gt;

&lt;!-- copy lib 文件 --&gt;

&lt;copy todir="${dist.lib}"&gt;

&lt;fileset dir="${build.lib}/"/&gt;

&lt;/copy&gt;

&lt;copy todir="${deploydir}"&gt;

&lt;fileset dir="${dist.lib.server}/"/&gt;

&lt;/copy&gt;

&lt;/target&gt;

&lt;/project&gt;

很多人一开始看这个文档， 会摸不着边， 其实很简单，先来说明一下。

&lt;project default="dist" basedir="."&gt;

……

&lt;/project&gt;

关于这个标签的说明， 表示了几个意义

1） 执行的基本目录在build.xml的当前目录

2） 这个project的起始任务是”dist”

ok,我们来查找， target的name=“dist”的标签：

&lt;target name="dist" depends="javadocs"&gt;

&lt;!--copy bin 执行文件 --&gt;

&lt;copy todir="${dist.bin}"&gt;

&lt;fileset dir="${src.script}/"/&gt;

&lt;/copy&gt;

&lt;copy todir="${dist.docs}"&gt;

&lt;fileset dir="${build.docs}/"/&gt;

&lt;/copy&gt;

&lt;!-- copy lib 文件 --&gt;

&lt;copy todir="${dist.lib}"&gt;

&lt;fileset dir="${build.lib}/"/&gt;

&lt;/copy&gt;

&lt;copy todir="${deploydir}"&gt;

&lt;fileset dir="${dist.lib.server}/"/&gt;

&lt;/copy&gt;

&lt;/target&gt;

这个标签里面里面描述了另外一个信息，depends="javadocs" 这就表明， 做这个动作

之前必须先完成javadocs这个标签， 那我们又继续查找target name=”javadoc”的标

签， 依此类推， 最后发现第一个执行的是init这个target， 所以， 在编写

builder.xml时， 他最先写， 因为实际ant执行时是从他开始的