关与 ANT 工具知识 网络知识采集笔记

ANT （Another Neat Tool） 直译为 “另一种整洁的工具”

 

对于Java 语言而言写一个稍大一点的工程时， 一个好的构建工具 (BuildTool) 可以减少很多的重复性构建工作，而 ANT 就是一个这样的工具，而在 ANT 工作中有一个文件即 build.xml 构建文件，是值得重视的。

 

今天有时间就总结一下该文件的配置，也加深一下不入门的我对 Java 相关工具的认识，能积累一点就积累一点，天天学习如果不上，也不要向下。-.-

 

 

ANT 工具工作思想是 利用自体工具完成对某 Java 工程的编译、 打包、及布署的任务 （生成JAVADOC文档工作）。

 

而使用 ANT 工具最关键的步骤就是对  build.xml 构建文件 的设置，实际上在创建一个新的 Java 项目时，首先应该编写 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） 用户自定义的任务。用户自定义的任务实用户自己开发的任务。

 

 

 

由于 XML 格式文件有着陈述式语汇,容易理解且自我描述的特点，维护起来也非常方便，许多的配置文件都采用这种格式文件，ANT 也不例外。

根据上述的工作思想及实施时的必要组织成如下配置内容的标准描述。

+----每个构建文件包含一个工程(project)。
      +---- 每个工程包含若干个目标(target)。
             +----目标可以依赖于其他的目标(depends)。
             +----目标包含任务(task)。
             +---- 易于使用Java语言增加新的任务（用户自定义扩展）。

 

 

Ant的结构如下图所示：

 

 

从上图可知：工程包含一个目标的集合。在每个目标里是任务的声明，它们是对Ant用于构建该目标的行为说明。目标生成一个依赖关系图表来声明该目标的依赖关系。当执行一个目标时，必须先执行它们依赖的目标。

 

 

通过举例说明：

 

这是一个典型的构建文件：

<?xml version="1.0" ?>
<project name="OurProject" default="deploy">
<target name="init">
<mkdir dir="build/classes" />
<mkdir dir="dist" />
</target>
<target name="compile" depends="init" >
<javac srcdir="src" destdir="build/classes"/>
</target>
<target name="doc" depends="init" >
<javadoc destdir="build/classes" sourcepath="src" packagenames="org.*" />
</target>
<target name="deploy" depends="compile,doc" >
     <jar destfile="dist/project.jar" basedir="build/classes"/>
         <ftp server="" userid="" password="">
      <fileset dir="dist"/>
</ftp>
</target>
</project>

 

 

该构建过程如下：
系统初始化、编译  、生成JAVADOC 、打包  、上传到FTP，其中后两步结合到一起叫部署。

 

执行时输出如下：
> ant -propertyfile ftp.properties
Buildfile: build.xml
init:
[mkdir] Created dir: /home/ant/Projects/OurProject/build/classes
[mkdir] Created dir: /home/ant/Projects/OurProject/dist
compile:
[javac] Compiling 1 source file to /home/ant/Projects/OurProject/build/
classes
doc:
[javadoc] Generating Javadoc
[javadoc] Javadoc execution
[javadoc] Loading source files for package org.example.antbook.lesson1...
[javadoc] Constructing Javadoc information...
[javadoc] Building tree for all the packages and classes...
[javadoc] Building index for all the packages and classes...
[javadoc] Building index for all classes...
deploy:
[jar] Building jar: /home/ant/Projects/OurProject/dist/project.jar
[ftp] sending files
[ftp] 1 files sent
BUILD SUCCESSFUL
Total time: 5 seconds.

 

 

 

 

 

build.xml 各标签配置理解。1.<project>标签每个构建文件对应一个项目。<project>标签时构建文件的根标签。它可以有多个内在属性，就如代码中所示，其各个属性的含义分别如下。(1) default表示默认的运行目标，这个属性是必须的。(2) basedir表示项目的基准目录。(3) name表示项目名。(4) description表示项目的描述。每个构建文件都对应于一个项目，但是大型项目经常包含大量的子项目，每一个子项目都可以有自己的构建文件。 2.<target>标签 一个项目标签下可以有一个或多个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.<mkdir>标签该标签用于创建一个目录，它有一个属性dir用来指定所创建的目录名，其代码如下：<mkdir dir=”＄{class.root}”/>通过以上代码就创建了一个目录，这个目录已经被前面的property标签所指定。 4<jar>标签该标签用来生成一个JAR文件，其属性如下。(1) destfile表示JAR文件名。(2) basedir表示被归档的文件名。(3) includes表示别归档的文件模式。(4) exchudes表示被排除的文件模式。 5．<javac标签>该标签用于编译一个或一组java文件，其属性如下。(1).srcdir表示源程序的目录。(2).destdir表示class文件的输出目录。(3).include表示被编译的文件的模式。(4).excludes表示被排除的文件的模式。(5).classpath表示所使用的类路径。(6).debug表示包含的调试信息。(7).optimize表示是否使用优化。(8).verbose 表示提供详细的输出信息。(9).fileonerror表示当碰到错误就自动停止。 6．<java>标签该标签用来执行编译生成的.class文件，其属性如下。(1).classname 表示将执行的类名。(2).jar表示包含该类的JAR文件名。(3).classpath所表示用到的类路径。(4).fork表示在一个新的虚拟机中运行该类。(5).failonerror表示当出现错误时自动停止。(6).output 表示输出文件。(7).append表示追加或者覆盖默认文件。 7.<delete>标签该标签用于删除一个文件或一组文件，去属性如下。(1)/file表示要删除的文件。(2).dir表示要删除的目录。(3).includeEmptyDirs 表示指定是否要删除空目录，默认值是删除。(4).failonerror 表示指定当碰到错误是否停止，默认值是自动停止。(5).verbose表示指定是否列出所删除的文件，默认值为不列出。 8.<copy>标签该标签用于文件或文件集的拷贝，其属性如下。(1).file 表示源文件。(2).tofile 表示目标文件。(3).todir 表示目标目录。(4).overwrite 表示指定是否覆盖目标文件，默认值是不覆盖。(5).includeEmptyDirs 表示制定是否拷贝空目录，默认值为拷贝。(6).failonerror 表示指定如目标没有发现是否自动停止，默认值是停止。(7).verbose 表示制定是否显示详细信息，默认值不显示。 再来认识一下Ant的数据类型在构建文件中为了标识文件或文件组，经常需要使用数据类型。数据类型包含在org.apache.tool.ant.types包中。下面镜简单介绍构建文件中一些常用的数据类型。1. argument 类型由Ant构建文件调用的程序，可以通过<arg>元素向其传递命令行参数，如apply,exec和java任务均可接受嵌套<arg>元素，可以为各自的过程调用指定参数。以下是<arg>的所有属性。(1).values 是一个命令参数。如果参数种有空格，但又想将它作为单独一个值，则使用此属性。(2).file表示一个参数的文件名。在构建文件中，此文件名相对于当前的工作目录。(3).line表示用空格分隔的多个参数列表。(4).path表示路径。 2.ervironment 类型由Ant构建文件调用的外部命令或程序，<env>元素制定了哪些环境变量要传递给正在执行的系统命令，<env>元素可以接受以下属性。(1).file表示环境变量值得文件名。此文件名要被转换位一个绝对路径。(2).path表示环境变量的路径。Ant会将它转换为一个本地约定。(3).value 表示环境变量的一个直接变量。(4).key 表示环境变量名。注意 file path 或 value只能取一个。 3.filelist类型Filelist 是一个支持命名的文件列表的数据类型，包含在一个filelist类型中的文件不一定是存在的文件。以下是其所有的属性。(1).dir是用于计算绝对文件名的目录。(2).files 是用逗号分隔的文件名列表。(3).refid 是对某处定义的一个<filelist>的引用。注意 dir 和 files 都是必要的，除非指定了refid(这种情况下，dir和files都不允许使用)。 4.fileset类型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是对模式的分组，他们是紧密相关的概念。<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_Test_Obj 文件夹，其目录及子目录如下：

 

+-----Ant_Test_Obj

       +-----build.xml （Ant 任务配置文件）

       +-----ant_exc.bat （执行 Ant 命令的批处理文件）

       +-----src

              +-----Test_SWT.java （Java 源码）

       +-----lib

              +-----swt.jar （源文件及字节码文件所引用的类库文件）

 

 

build.xml  文件源码：

 

<?xml version="1.0" encoding="UTF-8" ?> <project name="Test_SWT" default="run" basedir="."> <property name="src" value="src"/> <property name="dest" value="classes"/> <property name="Lib" value="lib"/><property name="Ant_Test_jar" value="Test.jar"/><path id="master-classpath"> <fileset dir="lib" id="project_lib"> <include name="swt.jar"/> </fileset></path> <target name="init"> <mkdir dir="${dest}"/> </target> <target name="compile" depends="init"> <javac srcdir="${src}" destdir="${dest}"> <classpath refid="master-classpath"/> </javac></target> <target name="build" depends="compile"> <jar jarfile="${Ant_Test_jar}" basedir="${dest}"> <manifest><attribute name="Main-Class" value="test_swt.Test_SWT" /><attribute name="Class-Path" value="lib/swt.jar" /> </manifest> </jar></target> <target name="run" depends="build"> <java classname="test_swt.Test_SWT" classpath="${Ant_Test_jar}"/> </target> <target name="clean"> <delete dir="${dest}" /> <delete file="${Ant_Test_jar}" /> </target> <target name="rerun" depends="clean,run"> <ant target="clean" /> <ant target="run" /> </target> </project>

 

 

ant_exc.bat 批处理文件源码：

 

ant

 

 

Test_SWT.java  文件源码：

 

package test_swt;import org.eclipse.swt.SWT;import org.eclipse.swt.widgets.Button;import org.eclipse.swt.widgets.Display;import org.eclipse.swt.widgets.Shell;public class Test_SWT {protected Shell shell;/*** Launch the application* @param args*/public static void main(String[] args) {try {Test_SWT window = new Test_SWT();window.open();} catch (Exception e) {e.printStackTrace();}}/*** Open the window*/public void open() {final Display display = Display.getDefault();createContents();shell.open();shell.layout();while (!shell.isDisposed()) {if (!display.readAndDispatch())display.sleep();}}/*** Create contents of the window*/protected void createContents() {shell = new Shell();shell.setSize(300, 100);shell.setText("SWT 设计学习示例程序");final Button button1 = new Button(shell, SWT.NONE);button1.setText("确定");button1.setBounds(15, 15, 60, 19);//}}

 

 

创建好上面目录及文件后，双击 ant_exc.bat 批处理文件启动 Ant  程序执行当前打包及运行Javar的任务，执行结果如下图所示。

 

 

 

 

build.xml 内容功能具体解析：

<?xml version="1.0" encoding="UTF-8" ?> <!-- ************* 声明属性，可以理解为声明变量 ************** --><project name="Test_SWT" default="run" basedir="."> <property name="src" value="src"/> <property name="dest" value="classes"/> <property name="Lib" value="lib"/><property name="Ant_Test_jar" value="Test.jar"/><path id="master-classpath"> <fileset dir="lib" id="project_lib"> <include name="swt.jar"/> </fileset></path><!-- *************** End 声明属性 ************************* --> <!-- ****** 创建 classes 子目录用来放置编译后的字节码 ******** --><target name="init"> <mkdir dir="${dest}"/> </target> <!-- ******************* End 创建子目录 ******************* --><!-- ******** 使用 javac 编译 Java 源文件为字节码 ******** --><!-- ****** 其中 classpath 是指向引用相关类库的位置 ****** --><target name="compile" depends="init"> <javac srcdir="${src}" destdir="${dest}"> <classpath refid="master-classpath"/> </javac></target> <!-- *************** End 编译 ************************* --><!-- ************************* 使用 Jar 打包 *************************** --><!-- ****** 其中 manifest 属性指向包中的 MANIFEST.MF 文件里的内容 ****** --><!-- ********* 其中 Main-Class 指示 主类的名称（包含路径） ************* --><!-- ********* 其中 Class-Path 指示 引用类库位置（包含路径） *********** --><target name="build" depends="compile"> <jar jarfile="${Ant_Test_jar}" basedir="${dest}"> <manifest><attribute name="Main-Class" value="test_swt.Test_SWT" /><attribute name="Class-Path" value="lib/swt.jar" /> </manifest> </jar></target> <!-- ************************* End 打包 ******************************** --><!-- **************************** 运行 Jar 包 ******************************** --><!-- ****** 其中 classname 指示 运行的主类名称 ****** --><!-- **** 其中 classpath 指示 运行的 Jar 包名称 （注意本例默认当前路径）****** --><target name="run" depends="build"> <java classname="test_swt.Test_SWT" classpath="${Ant_Test_jar}"/> </target> <!-- *************************** End 运行包 ********************************** --><target name="clean"> <delete dir="${dest}" /> <delete file="${Ant_Test_jar}" /> </target> <target name="rerun" depends="clean,run"> <ant target="clean" /> <ant target="run" /> </target> </project>