Ant之build.xml详解

ANT build.xml文件详解(一)

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 ,执行默认的目标

ant的build.xml文件详解(二)

以build_for_ejb_templet.xml为示例,讲解Ant中常用的元素和任务。 

约定: "…"表示这里有很多代码,未列出 

build_for_ejb_templet.xml任务的分为以下几大部分 
i. 开始 
ii. 初始化 
iii. 定义classpath 
iv. 为编译作准备 
v. 编译EJB部分 
vi. 编译WEB部分 
vii. 编译J2EE Application 
viii. 部署Application 
ix. 创建组件的API 
x. 确定build的目标 

build_for_ejb_templet.xml的讲解 

开始 
 
讲解:encoding="UTF-8"表示XML文件采用UTF-8编码格式,如果要使用GBK编码,需定义为encodeing="GBK"。

  
讲解:此部分为文件内容的简介,包括文件名称、创建日期、最后修改日期、创建文件的作者、版权。
componentName 表示 文件名称
yyyy-m-dd 表示 创建日期、最后修改日期的格式,如2002-5-1
developerName 表示 创建文件的作者
CompanyName 表示 公司名称或URL




讲解:此部分定义了一个名称为componentName的项目元素,缺省的任务为"core"任务,根目录为当前目录。componentName表示组件的名称,这里指EJB的名称。



初始化 



讲解:此部分用于初始化所有的变量


讲解:导入项目根目录下build.properties中的全局变量,开发人员也可以在此文件中重新定义全局变量。

  
  
  

  

  
  

讲解:定义和Jboss Application Server有关的变量,包括lib目录、client目录、
deploy目录和J2EE Application部署要用到的一些变量。

  
讲解:定义组件的名称

  
讲解:定义源代码目录路径

  
讲解:定义资源目录路径

  
讲解:定义库目录路径

  
讲解:定义build目录路径


讲解:定义源代码的主目录路径

  
讲解:定义存放EJB的源代码目录路径


讲解:定义存放JavaBean的源代码目录路径


讲解:定义存放Servlet的源代码目录路径

  
讲解:定义存放WEB部分文件(包括JSP程序、HTML文件、图片、CSS文件、JS脚本等)的目录路径

 
讲解:定义存放组件API的开发文件目录路径

  
讲解:定义存放EJB的编译代码目录路径

  
讲解:定义存放JavaBean的编译代码目录路径


讲解:定义WEB目录的类目录路径

  
讲解:定义WEB目录的库目录名称

  
讲解:定义压缩文档的名称

  
讲解:定义项目的组件目录路径


讲解:这段为注释,说明以下是定义当前组件的变量


讲解:定义当前组件的名称


讲解:定义当前组件的目录路径

value="${ProjectName.componentName.home}/lib/ejb"/>
讲解:定义当前组件的EJB编译目录路径
value="${ProjectName.componentName.home}/build/componentName-ejb.jar"/>
讲解:定义当前组件内的EJB包的路径

value="${ProjectName.componentName.home}/build/componentName-ejb-client.jar"/>
讲解:定义当前组件内的EJB客户端包的路径


讲解:这段为注释,说明以下是定义引入其它组件的变量

value="referencesComponentName"/>
讲解:定义指定组件的名称

value="${ProjectName.components.home}/referencesComponentName"/>
讲解:定义指定组件的目录路径

value="${ProjectName.referencesComponentName.home}/lib/ejb"/>
讲解:定义指定组件的EJB编译目录路径

value="${ProjectName.referencesComponentName.home}
/build/referencesComponentName-ejb.jar"/>
讲解:定义指定组件内的EJB包的路径

value="${ProjectName.referencesComponentName.home}
/build/referencesComponentName-ejb-client.jar"/>
讲解:定义指定组件内的EJB客户端包的路径

value="${jboss.client}/jboss-j2ee.jar:${jboss.client}
/jnp-client.jar:${jboss.client}/jnp-client.jar:${jboss.client}
/jbossmq-client.jar:${jboss.client}/jbosssx-client.jar:${jboss.client}
/concurrent.jar:${jboss.client}/jaas.jar:${jboss.lib}
/jboss-jmx.jar:${jboss.home}/server/${jboss.configuration}
/lib/jbosssx.jar:${jboss.home}/server/${jboss.configuration}
/lib/mail.jar:${servlet-lib.path}:${ejb-classes.dest}:
${web-classes.dest}:${ProjectName.componentName.classbindir}:
${ProjectName.componentName.ejbjar.client}:
${ProjectName.referencesComponentName.classbindir}:
${ProjectName.referencesComponentName.ejbjar.client}" />
讲解:定义classpath,编译bean时要用到。这是定义classpath的一种方法,下面还有另一种方法。

定义classpath 
  
  
     
     
         
         
         
         
        
         
         
       location="${jboss.home}/server/${jboss.configuration}/lib/jbosssx.jar" />  
       location="${jboss.home}/server/${jboss.configuration}/lib/mail.jar" />  
  
讲解:此段定义应用服务器中包文件,如支持ejb的jboss-j2ee.jar、支持客户端程序的jnp-client.jar、jbossmq-client.jar、jbosssx-client.jar、支持JavaMail的mail.jar等。

     
      
      
      
       location="${ProjectName.referencesComponentName.classbindir}"/>
      
  
  
讲解:此段定义项目中要用到的包文件。

  
        
        
        
  

讲解:此段定义在编译servlet时的classpath,${ servlet-lib.path }是系统指定的Servlet引擎包。

为编译作准备工作 

  
     
     
     
         
         
  

讲解:清除build、lib目录下的所有文件和目录。

     
     
     
     
         
         
         
         
         
         
         
         
         
      
         
  
  
讲解:创建build中要用到的所有目录,根据需要可以加入自定义的目录如:
      

编译EJB部分
  
     
     
     
                    destdir="${ejb-classes.dest}"  
             includes="com/**"  
             classpathref="base.path" />
  
  
讲解:此小段用来完成编译ejb和其它help classes。根据需要可以加入一个非常有用的元素:
             encoding="${javac.encoding}"

     
                    tofile="${lib.dir}/ejb/META-INF/ejb-jar.xml" />  
                    tofile="${lib.dir}/ejb/META-INF/jaws.xml" />  
                    tofile="${lib.dir}/ejb/META-INF/jboss.xml" />  
                    tofile="${lib.dir}/ejb/META-INF/jbosscmp-jdbc.xml" />  
  

讲解:此小段用来拷贝EJB部署文件,在JAS中EJB部署文件有jaws.xml、jboss.xml、jbosscmp-jdbc.xml。

     
                  basedir="${lib.dir}/ejb" />  
  
  
讲解:此小段用来把class和部署文件压缩成包文件,这个包文件就是一个EJB组件。

  
       file="${ProjectName.referencesComponentName.home}/build/
${ProjectName.referencesComponentName.name}-ejb-client.jar"  
           tofile="${build.dir}/${ProjectName.referencesComponentName.name}
           -ejb-client.jar" />  
                  basedir="${lib.dir}/ejb"
           excludes="com/ProjectName/componentName/ejb/ComponentNameEJB.class" />  
  

讲解:此小段用来把class和部署文件压缩成包文件,以支持客户端运行。

编译WEB部分
  
     
     
     
                    destdir="${lib.dir}/web/WEB-INF/classes"  
             includes="com/**"  
             classpath="${build.classpath}" />  
  
  
讲解:此小段用来完成编译servlet。

  
                    tofile="${lib.dir}/web/WEB-INF/jboss-web.xml" />  
                    tofile="${lib.dir}/web/WEB-INF/web.xml" />  
  

讲解:此小段用来拷贝WEB部署文件,在JAS中WEB部署文件有jboss-web.xml。

     
      
      
      

       file="${build.dir}/${ProjectName.referencesComponentName.name}-ejb-client.jar"  
tofile="${lib.dir}/web/WEB-INF/lib/${ProjectName.referencesComponentName.name}
-ejb-client.jar" />    
                basedir="${lib.dir}/web" />  
  

讲解:此小段用来把所有的JSP程序、Html、Css、图片和部署文件等压缩成WAR文件。

编译J2EE Application
  
     
     
     
                    tofile="${lib.dir}/j2ee/META-INF/application.xml" />  
  
  
讲解:此小段用来拷贝Application的部署文件。

     
                    tofile="${lib.dir}/j2ee/${name}-ejb.jar" />  
                    tofile="${lib.dir}/j2ee/${name}-web.war" />  
                  basedir="${lib.dir}/j2ee" />  
  
  
讲解:此小段用来把EJB组件、支持客户端运行的包和部署文件压缩成EAR文件,它就是一个J2EE Application。这里要说明,在进行build时,根据需要可以不生成EAR文件。

部署Application

  
  
     
         
           
        
  
      
  
  
  
讲解:此小段用来部署Application,在JAS3.0中${jboss.deploy}是JAS的热部署目录。

创建组件的API

  
  
  
                  destdir="${javadoc.dir}"  
             classpath="${build.classpath}"
             encoding="${javadoc.encoding}"
             author="${javadoc.author}"
version="${javadoc.version}" 
use="${javadoc.usage}"  
             windowtitle="${project.name} ${name} Component API"
             doctitle="${project.name} ${name} Component"  
             bottom="Copyright ${sign.copyright} ${project.date} 
${company.signature}. All Rights Reserved.">  

           
      

      
        
      

    

  

讲解:此小段用来创建组件的API。这里强烈要求类设计人员和编码人员按照Javadoc定义的标签对源代码进行注释。



确定build的目标

       +---------------------------------------+
       +     Building ${name} Component         +
       +---------------------------------------+
  

  
       +---------------------------------------+
       +     Finished ${name} Component         +
       +---------------------------------------+
  

  
  
  
  
  
  
  
讲解:此小段用来确定build的目标。缺省目录为core,所以在build不加参数时,系统将只生成jar文件和war文件。如果 build时加上参数,系统将根据需要来生成文件,例如:在命令行输入ant deploy,系统将生成jar文件、war文件、ear文件,同时将ear文件进行部署。

ant build.xml 详解(三)

在Eclipse中使用Ant Ant是Java平台下非常棒的批处理命令执行程序,能非常方便地自动完成编译,测试,打包,部署等等一系列任务,大大提高开发效率。如果你现在还没有开始使用Ant,那就要赶快开始学习使用,使自己的开发水平上一个新台阶。 

Eclipse中已经集成了Ant,我们可以直接在Eclipse中运行Ant。 

以前面建立的Hello工程为例,创建以下目录结构: 


新建一个build.xml,放在工程根目录下。build.xml定义了Ant要执行的批处理命令。虽然Ant也可以使用其它文件名,但是遵循标准能更使开发更规范,同时易于与别人交流。 

通常,src存放Java源文件,classes存放编译后的class文件,lib存放编译和运行用到的所有jar文件,web存放JSP等web文件,dist存放打包后的jar文件,doc存放API文档。 

然后在根目录下创建build.xml文件,输入以下内容: 

Xml代码  

 

 

 

       

       

       

       

       

 

       

       

           

           

       

       

       

       

       

       

           

           

               

           

       

       

       

           

         

                 haltonfailure="false"  

                 failureproperty="tests.failed"  

                 showoutput="true">  

               

               

               

                   

                       

                   

               

           

           

         ***********************************************************   

         ****   One or more tests failed!   Check the output ...   ****   

         ***********************************************************   

           

       

       

       

       

           

               

               

           

       

       

       

       

     

             author="true"  

             version="true"  

             use="true"  

             windowtitle="Test API">  

               

                   

               

             Hello, test]]>  

             All Rights Reserved.]]>  

               

           

       

 

 
   

以上xml依次定义了init(初始化),compile(编译),test(测试),doc(生成文档),pack(打包)任务,可以作为模板。 

选中Hello工程,然后选择“Project”,“Properties”,“Builders”,“New…”,选择“Ant Build”: 


填入Name:Ant_Builder;Buildfile:build.xml;BaseDirectory:${workspace_loc: /Hello}(按“BrowseWorkspace”选择工程根目录),由于用到了junit.jar包,搜索Eclipse目录,找到 junit.jar,把它复制到Hello/lib目录下,并添加到Ant的Classpath中: 


然后在Builder面板中钩上Ant_Build,去掉Java Builder: 


再次编译,即可在控制台看到Ant的输出: 

Buildfile: F:\eclipse-projects\Hello\build.xml 

init: 

compile: 

        [mkdir] Created dir: F:\eclipse-projects\Hello\classes 

        [javac] Compiling 2 source files to F:\eclipse-projects\Hello\classes 

test: 

        [mkdir] Created dir: F:\eclipse-projects\Hello\report 

        [junit] Running example.HelloTest 

        [junit] Tests run: 1, Failures: 0, Errors: 0, Time elapsed: 0.02 sec 

pack: 

        [mkdir] Created dir: F:\eclipse-projects\Hello\dist 

          [jar] Building jar: F:\eclipse-projects\Hello\dist\hello.jar 

doc: 

        [mkdir] Created dir: F:\eclipse-projects\Hello\doc 

      [javadoc] Generating Javadoc 

      [javadoc] Javadoc execution 

      [javadoc] Loading source files for package example... 

      [javadoc] Constructing Javadoc information... 

      [javadoc] Standard Doclet version 1.4.2_04 

      [javadoc] Building tree for all the packages and classes... 

      [javadoc] Building index for all the packages and classes... 

      [javadoc] Building index for all classes... 

      [javadoc] Generating F:\eclipse-projects\Hello\doc\stylesheet.css... 

      [javadoc] Note: Custom tags that could override future standardtags:   @todo. To avoid potential overrides, use at least one periodcharacter (.) in custom tag names. 

      [javadoc] Note: Custom tags that were not seen:   @todo 

BUILD SUCCESSFUL 

Total time: 11 seconds 

Ant依次执行初始化,编译,测试,打包,生成API文档一系列任务,极大地提高了开发效率。将来开发J2EE项目时,还可加入部署等任务。并且,即使脱离了Eclipse环境,只要正确安装了Ant,配置好环境变量ANT_HOME=

Ant 的最完整build.xml之标签:
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.标签 
一个项目标签驴梢杂幸桓龌蚨喔?/span>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教程详解--javac,java,jar,war,delete,copy,mkdir:
Ant 是一个 Apache 基金会下的跨平台的构件工具,它可以实现项目的自动构建和部署等功能。在本文中,主要让读者熟悉怎样将 Ant 应用到 Java 项目中,让它简化构建和部署操作。 
一.              安装与配置 
下载地址: http://ant.apache.org/ ,在本文中下载的是 1.7.0 版本。解压到某个目录(例如 E:"apache-ant-1.7.0 ),即可使用。 
添加系统环境变量: ANT_HOME ,该变量指向 Ant 解压后的根目录,在此为 E:"apache-ant-1.7.0 。 
安装与配置完毕后,读者可以测试一下 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 有一个初步的了解。首先在 E 盘下建立一个 build.xml 文件,内容如下: 
 
< project  name ="helloWorld"> 
< target  name ="sayHelloWorld"> 
< echo  message ="Hello,Amigo"/> 
 
 
读者可以进入 E 盘,然后运行 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 的构件文件的附目录作为基准目录。 
下面给读者一个简单的例子来展示 project 的各元素的使用。修改 E:"build.xml 文件,修改后的内容如下: 
 
< project  name ="projectStudy"  default ="sayBaseDir"  basedir ="E:" apache-ant-1.7.0" > 
< target  name ="sayBaseDir"> 
< echo  message ="The base dir is: ${basedir}"/> 
 
 
从上面的内容我们可以看出,在这里定义了 default 属性的值为 sayBaseDir ,即当运行 ant 命令时,若未指明执行的 target 时,默认执行的 target 的 sayBaseDir ,同时还定义了 basedir 属性的值为 E:"apache-ant-1.7.0 ,进入 E 盘后运行 ant 命令,可看到运行的结果,如下图所示:

因为设定了 basedir 的值,所以 basedir 属性的值变成了读者设置的值。读者可以自行将 project 元素的 basedir 属性去掉后运行 ant 看看运行结果,此时 basedir 的值变成了 E:" ,即为 Ant 构件文件的父目录。 
有的时候,读者可能有这种需求,即想得到某个 project 下所有的 target 的名称,读者可以通过在 ant 命令里加上 -proecthelp 来达到该目的。例如针对上述的例子我们运行 ant –projecthelp ,输出结果如下: 
Buildfile: build.xml 
Main targets: 
Other targets: 
sayBaseDir 
Default target: sayBaseDir 
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 功能的简短描述和说明。 
下面带领读者来看一个各属性综合使用的例子。修改 E:"build.xml 文件,修改后的内容如下: 
 
< project  name ="targetStudy"> 
< target  name ="targetA"  if ="ant.java.version"> 
< echo  message ="Java Version: ${ant.java.version}"/> 
 
< target  name ="targetB"  depends ="targetA"  unless ="amigo"> 
< description > 
a depend example!
 
< echo  message ="The base dir is: ${basedir}"/> 
 
 
进入 E 盘后运行 ant targetB ,可看到如下图所示的运行结果:

读者分析结果后可以看到,我们运行的是名为 targetB 的 target ,因该 target 依赖于 targetA ,所以 targetA 将首先被执行,同时因为系统安装了 java 环境,所以 ant.java.version 属性存在,执行了 targetA 这个 target ,输出信息: [echo] Java Version: 1.5 , targetA 执行完毕后,接着执行 targetB ,因为 amigo 不存在,而 unless 属性是在不存在时进入所在的 target 的,由此可知 targetB 得以执行,输出信息: The base dir is: E:" 。 
3.        property 元素 
该元素可看作参量或者参数的定义, project 的属性可以通过 property 元素来设定,也可在 Ant 之外设定。若要在外部引入某文件,例如 build.properties 文件,可以通过如下内容将其引入:  
property 元素可用作 task 的属性值。在 task 中是通过将属性名放在“ ${ ”和“ } ”之间,并放在 task 属性值的位置来实现的。 
Ant 提供了一些内置的属性,它能得到的系统属性的列表与 Java 文档中 System.getPropertis() 方法得到的属性一致,这些系统属性可参考 sun 网站的说明。 
同时, Ant 还提供了一些它自己的内置属性,如下: 
basedir : project 基目录的绝对路径,该属性在讲解 project 元素时有详细说明,不再赘述; 
ant.file : buildfile 的绝对路径,如上面的各例子中, ant.file 的值为 E:"build.xml ; 
ant.version : Ant 的版本,在本文中,值为 1.7.0 ; 
ant.project.name :当前指定的 project 的名字,即前文说到的 project 的 name 属性的值; 
ant.java.version : Ant 检测到的 JDK 的版本,在上例运行结果中可看到为 1.5 。 
下面让读者来看一个 property 元素使用的简单例子。修改 E:"build.xml 文件,内容如下: 
 
< project  name ="propertyStudy"  default ="example"> 
< property  name ="name"  value ="amigo"/> 
< property  name ="age"  value ="25"/> 
< target  name ="example"> 
< echo  message ="name: ${name}, age: ${age}"/> 
 
 
该例的运行结果如下图所示:

由此读者可以看出,通过如下两个语句: 
 
 
我们设置了名为 name 和 age 的两个属性,这两个属性设置后,读者在下文中可以通过 ${name} 和 ${age} 分别取得这两个属性的值。 
三.              Ant 的常用任务 
在 Ant 工具中每一个任务封装了具体要执行的功能,是 Ant 工具的基本执行单位。在本小节中,主要引导读者来看下 Ant 的常用任务及其使用举例。 
1.        copy 任务 
该任务主要用来对文件和目录的复制功能。举例如下: 
Eg1. 复制单个文件:  
Eg2. 对文件目录进行复制: 
 
 
 
Eg3. 将文件复制到另外的目录: 
 
2.        delete 任务 
对文件或目录进行删除,举例如下: 
Eg1. 删除某个文件:  
Eg2. 删除某个目录:  
Eg3. 删除所有的备份目录或空目录: 
 
 
 
3.        mkdir 任务 
创建目录。 eg :  
4.        move 任务 
移动文件或目录,举例如下: 
Eg1. 移动单个文件:  
Eg2. 移动单个文件到另一个目录:  
Eg3. 移动某个目录到另一个目录: 
 
 
 
5.        echo 任务 
该任务的作用是根据日志或监控器的级别输出信息。它包括 message 、 file 、 append 和 level 四个属性,举例如下: 
 
四.              利用 Ant 构建和部署 Java 工程 
Ant 可以代替使用 javac 、 java 和 jar 等命令来执行 java 操作,从而达到轻松的构建和部署 Java 工程的目的。下面来看几个知识点。 
1.        利用 Ant 的 javac 任务来编译 java 程序 
Ant 的 javac 任务用于实现编译 Java 程序的功能。下面来看一个简单的例子: 
首先我们建立名为 antstudy 的 Java 工程,建立 src 目录为源代码目录,在 src 目录下建立 HelloWorld.java 这个类文件。该类文件的内容如下: 
public   class  HelloWorld  {
public   static   void  main(String[] args)  {
System.out.println("Hello,Amigo");
}

同时在 antstudy 工程的根目录下建立 build.xml 文件,在该文件中编译 src 目录下的 java 文件,并将编译后的 class 文件放入 build/classes 目录中,在编译前,需清除 classes 目录,该文件的内容如下: 
 
< project  name ="javacTest" default ="compile"  basedir ="."> 
< target  name ="clean"> 
< delete  dir ="build"/> 
 

< target  name ="compile"  depends ="clean"> 
< mkdir  dir ="build/classes"/> 
< javac  srcdir ="src"  destdir ="build/classes"/> 
 
 
运行该 build.xml 文件,可在工程中看到新增了 build/classes 目录,并在该目录中生成了编译后的 HelloWorld.class 文件。 
2.        使用 Ant 的 java 任务运行 Java 程序 
Ant 中可以使用 java 任务实现运行 Java 程序的功能。下面在 1 的例子中进行如下的修改,修改后的 build.xml 文件的内容如下: 
 
< project  name ="javaTest"  default ="jar"  basedir ="."> 
< target  name ="clean"> 
< delete  dir ="build"/> 
 

< target  name ="compile"  depends ="clean"> 
< mkdir  dir ="build/classes"/> 
< javac  srcdir ="src"  destdir ="build/classes"/> 
 

< target  name ="run"  depends ="compile"> 
< java  classname ="HelloWorld"> 
< classpath > 
< pathelement  path ="build/classes"/> 
 
 
 
 
运行该 build.xml 文件,可在控制台看到 HelloWorld 的 main 方法的输出。 
3.        使用 Ant 的 jar 任务生成 jar 文件 
读者可以在上例的基础上更进一步,来生成 jar 包,可在 run 这个 target 下再加上如下 target : 
< target  name ="jar"  depends ="run"> 
< jar  destfile ="helloworld.jar"  basedir ="build/classes"> 
< manifest > 
< attribute  name ="Main-class"  value ="HelloWorld"/> 
 
 
 
此时将 ant 的 project 的 default 属性设置为 jar ,同时运行该 build.xml 文件,运行完毕后,可看到在工程目录下生成了一个 jar 包 HelloWorld.jar 。 
4.        使用 Ant 的 war 任务打包 J2EE Web 项目 
建立一个 J2EE Web 工程,其目录结构如下图所示:
其中 src 为源代码目录, WebRoot 为各 jsp 存放目录, lib 为工程的包目录。在 antwebproject 工程目录下建立了 build.xml 文件,该文件为该工程的 Ant 构件文件。读者可以 src 目录下放入在前续例子中开发的 HelloWorld.java 文件,并在 WebRoot 下建立 index.jsp 文件,其内容很简单,就是输出 Hello 信息,代码如下所示: 
<% @ page language="java" contentType="text/html; charset="UTF-8" pageEncoding="UTF-8" %> 
 
< html > 
< head > 
< meta  http-equiv ="Content-Type"  content ="text/html; charset=ISO-8859-1"> 
< title > ant 打包测试  
 
< body > 
Hello,Ant
 
 
接下来编写 build.xml 文件,其内容如下: 
 
< 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"/> 
 
< target  name ="clean"> 
< delete  dir ="build"/> 
 

 
< target  name ="compile"  depends ="clean"> 
< mkdir  dir ="${classes}"/> 

< javac  srcdir ="src"  destdir ="${classes}"/> 
 

 
< target  name ="war"  depends ="compile"> 
< war  destfile ="${build}/antwebproject.war"  webxml ="WebRoot/WEB-INF/web.xml"> 
 
< fileset  dir ="WebRoot"  includes ="**/*.jsp"/> 

 
< lib  dir ="${lib}"/> 
 
< classesdir ="${classes}"/> 
 
 
 
各 target 的作用在内容中已经进行说明,在此不再赘述。运行该 build 文件,更新目录后,可看到在 build 目录下生成了 antwebproject.war 文件,解开后可看到其目录结构如下: 
--META-INF 
--MANIFEST.MF 
--index.jsp 
--WEB-INF 
--lib 
--log4j-1.2.9.jar 
--classes 
--HelloWorld.class 
--web.xml 
读者可以将该 war 包拷贝到 Tomcat 的目录下看一下运行结果。 
五.              总结 
在本文中,笔者由浅至深详细描述了 Ant 的安装与配置、关键元素和常用任务。并通过实例讲述了 Ant 在我们 Java 项目中的应用,讲述了编译、运行 java 程序,以及打 jar 包、 war 包等知识,引领读者进入 Ant 的奇妙世界。在本文中可以看到, Ant 在自动构建和部署 Java 程序方面方便易用,而且非常灵活,不失为我们 Java 开发者的绝佳帮手

http://blog.csdn.net/user4570/archive/2009/05/27/4221101.aspx

你可能感兴趣的:(java)