Ant_的最完整build.xml解释

转载自：https://www.cnblogs.com/xionghui/archive/2012/03/13/2393679.html

作者：_安静

Ant的概念
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.标签 
一个项目标签驴梢杂幸桓龌蚨喔?/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的数据类型
在构建文件中为了标识文件或文件组，经常需要使用数据类型。数据类型包含在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 ,执行默认的目标.

Xml代码

1.   
2.   
3.   
4.   
5.   
6.   
7.   
8.   
9.   
10.   
11.   
12.   
13.   
14.   
15.   
16.   
17.   
18.   
19.   
20.   
21.   
22.   
23.   
24.   
25.   
26.   
27.   
28.   
29.   
30.   
31.   
32.   
33.   
34.   
35.   
36.   
37.   
38.   
39.   
40.   
41.   
42.   
43.   
44.   
45.   
46.   
47.   
48.   
49.   
50.   
51.   
52.   
53.   
54.   
55.   
56.   
57.   
58.   
59.   
60.   
61.   
62.   
63.   
64.   
65.   
66.   
67.   
68.   
69.   
70.   
71.   
72.   
73.   
74.   
75.   
76.   
77.   
78.   
79.   
80.   
81.   
83. depends="jars"  
84. description="--> creates the API documentation">  
85.   
86.   
87.   
88.   
89.   
91. sourcepath="${src.main}"  
92. defaultexcludes="yes"  
93. destdir="${build.docs.api}"  
94. author="true"  
95. version="true"  
96. use="true"  
97. windowtitle="Docs API">  
98. hello ant Docs API]]>  
99. ${app.copyright}]]>  
100.   
101.   
102.   
103.   
104.   
105.   
106.   
107.   
108.   
109.   
110.   
111.   
112.   
113.   
114.   
115.   
116.   
117.   
118.   
119.   
120.   

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

depends="jars"

description="--> creates the API documentation">

 

sourcepath="${src.main}"

defaultexcludes="yes"

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

author="true"

version="true"

use="true"

windowtitle="Docs API">

hello ant Docs API]]>

${app.copyright}]]>

 

 

趁热打铁，接着上面的再发一个实例：

Xml代码

1.   
2.   
3.         
4.         
5.         
6.         
7.         
8.         
9.             
10.         
11.         
12.         
13.         
14.         
15.            
16.         
17.             
18.                 
19.                             
20.                             
21.                             
22.                             
23.                             
24.                             
25.                             
26.                             
27.                             
28.                             
29.                             
30.                             
31.                             
32.                             
33.                             
34.                             
35.                             
36.                     
37.                             
38.                             
39.                             
40.                             
41.                             
42.                             
43.                             
44.                             
45.                             
46.                             
47.                             
48.                             
49.                             
50.                             
51.                             
52.                             
53.                             
54.                             
55.                             
56.                             
57.                             
58.             
59.             
60.                 
61.                     
62.            
63.         
64.             
65.             
66.             
67.             
68.             
69.             
70.            Clean output dirs"/>  
71.            Compile main Java sources and copy libraries"/>  
72.            Build the web application archive"/>  
73.            Clean, build, warfile"/>  
74.             
75.            
76.         
77.             
78.             
79.             
80.             
81.             
82.         
83.         
84.             
85.             
86.           
87.                   deprecation="false" optimize="false" failοnerrοr="true">  
88.                 
89.                 
90.             
91.             
92.             
93.             
94.             
95.                 
96.                     
97.                     
98.                 
99.             
100.             
101.                 
102.                     
103.                     
104.                     
105.                     
106.                 
107.                     
108.          
109.             
110.         
111.         
112.             
113.         
114.         
115.             
116.             
117.                 
118.                 
119.                 
120.                 
121.                 
122.                 
123.                 
124.                 
125.                 
126.                 
127.                 
128.             
129.         
130.         
131.   

     

     

     

     

     

     

         

     

     

     

     

     

        

     

         

             

                         

                         

                         

                         

                         

                         

                         

                         

                         

                         

                         

                         

                         

                         

                         

                         

                         

                 

                         

                         

                         

                         

                         

                         

                         

                         

                         

                          

                         

                         

                         

                         

                         

                         

                         

                         

                         

                         

                         

         

         

              

                 

        

     

         

         

         

         

         

         

         

         

         

         

         

        

     

         

         

         

         

         

     

     

         

         

         

                  deprecation="false" optimize="false" failοnerrοr="true">

             

             

         

         

         

         

         

             

                  

                 

             

         

         

             

                 

                 

                 

                 

             

                 

      

         

     

     

         

     

     

         

         

             

             

             

             

             

             

             

             

             

             

             

         

     

     

在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代码

1.   
2.   
3.   
4.        
5.        
6.        
7.        
8.        
9.   
10.        
11.        
12.            
13.            
14.        
15.        
16.        
17.        
18.        
19.        
20.            
21.            
22.                
23.            
24.        
25.        
26.        
27.            
28.          
29.                  haltonfailure="false"  
30.                  failureproperty="tests.failed"  
31.                  showoutput="true">  
32.                
33.                
34.                
35.                    
36.                        
37.                    
38.                
39.            
40.            
41.          ***********************************************************  
42.          ****   One or more tests failed!   Check the output ...   ****  
43.          ***********************************************************  
44.            
45.        
46.        
47.        
48.         
49.            
50.                
51.                
52.            
53.        
54.        
55.        
56.         
57.       
58.              author="true"  
59.              version="true"  
60.              use="true"  
61.              windowtitle="Test API">  
62.                
63.                    
64.                
65.              Hello, test]]>  
66.              All Rights Reserved.]]>  
67.                
68.            
69.        
70.   

    

    

    

    

    

    

    

        

        

    

    

    

    

    

    

        

        

            

        

    

    

    

        

        

                 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=