转载ant

Ant工具

Ant是一种基于Java的build工具。理论上来讲,它有些相似于(Unix)C中的make ,但没有make的缺陷。目前的最新版本为:Ant 1.9.4 [1]  。
既然咱们已经有了make, gnumake, nmake, jam以及其余的build工具为何还要要一种新的build工具呢?由于Ant的原做者在多种(硬件)平台上开发 软件时, 没法忍受这些工具的限制和不便。相似于make的工具本质上是基于shell(语言)的:他们计算依赖关系,而后执行命令(这些命令与你在命令行敲的命令 没太大区别)。这就意味着你能够很容易地经过使用OS特有的或编写新的(命令)程序扩展该工具;然而,这也意味着你将本身限制在了特定的OS,或特定的 OS类型上,如Unix。
Makefile也很可恶。任何使用过他们的人都碰到过可恶的tab问题。Ant的原做者常常这样问本身:“是否个人命令不执行只是由于在个人tab前有一个空格?!!”。相似于jam的工具很好地处理了这类问题,可是(用户)必须记住和使用一种新的格式。
Ant就不一样了。与基于shell命令的扩展模式不一样,Ant用Java的类来扩展。(用户)没必要编写shell命 令,配置文件是基于XML的,经过调用target树,就可执行各类task。每一个task由实现了一个特定Task接口的对象来运行。(若是你对Ant 一点概念都没有的话,可能看不懂这一节,没有关系,后面会对target,task作详细的介绍。你若是没有太多的时间甚至能够略过这一节,而后再回来浏 览一下这里的介绍,那时你就会看懂了。一样,若是你对make之类的工具不熟悉也不要紧,下面的介绍根本不会用到make中的概念。)
必须认可,这样作,在构造shell命令时会失去一些特有的表达能力。如`find . -name foo -exec rm {}`,但却给了你跨平台的能力-你能够在任何地方工做。若是你真的须要执行一些shell命令,Ant有一个<exec> task,这个task容许执行特定OS上的命令。

Ant的概念

当一个代码项目大了之后,每次从新编译,打包,测试等都会变得很是复杂并且重复,所以 c语言中有make 脚本来帮助这些工做的批量完成。在Java 中应用是平台无关性的,固然不会用平台相关的make 脚本来完成这些 批处理任务了,ANT自己就是这样一个流程 脚本引擎,用于自动化调用程序完成项目的编译,打包,测试等。除了基于JAVA是平台无关的外, 脚本的格式是基于XML的,比make脚原本说还要好维护一些。
每一个ant 脚本(缺省叫build.xml)中设置了一系列任务(target):好比对于一个通常的项目可能须要有如下任务。
* 任务1:usage 打印本 脚本的帮助信息(缺省)
* 任务2:clean <-- init 清空初始化环境
* 任务3:javadoc <-- build <-- init 生成JAVADOC
* 任务4:jar <-- build <-- init 生成JAR
* 任务5:all <-- jar + javadoc <-- build <-- init 完成以上全部任务:jar javadoc
而多个任务之间每每又包含了必定的依赖关系:好比把整个应用打包任务(jar)的这个依赖于编译任务(build),而编译任务又依赖于整个环境初始化任务(init)等。
注:我看到不少项目的ant 脚本中 的命名基本上都是一致的,好比:编译通常叫build或者compile;打包通常叫jar或war;生成文档通常命名为 javadoc或javadocs;执行所有任务all。在每一个任务的中,ANT会根据配置调用一些外部应用并配以相应参数执行。虽然ANT可调用的外部 应用种类很是丰富,但其实最经常使用的就2,3个:好比javac javadoc jar等。

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.<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) excludes表示被排除的文件模式。
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.environment 类型
由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的安装

解包后在系统可执行 路径中加入指向ant的bin的路径就能够了,好比能够在GNU/Linux上把如下配置加入/etc/profile中:
export ANT_HOME=/home/ant
export JAVA_HOME=/usr/java/j2sdk1.4.1
export PATH=$PATH:$JAVA_HOME/bin:$ANT_HOME/bin
Windows 下的安装:
下载后解压到某个目录我这里以D:\apache-ant-1.7.1为例子:
添加path全局 环境变量:D:\apache-ant-1.7.1\bin
这样在command line就能够运行ant命令了
测试:运行->cmd/command->ant 若是没有安装成功则回报找不到这个命令,安装成功会有相关的提示信息显示。
这样执行ant 后,若是不指定配置文件ant会缺省找build.xml这个配置文件,并根据配置文件执行任务,缺省的任务设置能够指向最经常使用的任务,好比: build,或指向打印帮助信息:usage,告诉用户有那些 脚本选项可使用。

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版本
2013年03月11日,Apache Ant 1.9 发布 [2]
 
例子:
<?xml version="1.0" encoding="UTF-8"?> <project name="ss" basedir="..">     <property name="this.ss.Projectfolder" value="${basedir}/ss" />     <property name="this.ss.bin" value="${this.ss.Projectfolder}/bin" />     <property name="this.ss.Package" value="${this.ss.Projectfolder}/Package" />     <property name="this.ss.Package.Jar" value="${this.ss.Projectfolder}/Package/Jar" />     <property name="this.ss.Package.War" value="${this.ss.Projectfolder}/Package/War" />     <property name="this.ss.Package.Zip" value="${this.ss.Projectfolder}/Package/Zip" />     <path id="this.ss.classpath">         <fileset dir="${basedir}/root/WEB-INF/lib">             <include name="**/*.jar" />         </fileset>         <fileset dir="${basedir}/lib">             <include name="**/*.jar" />         </fileset>     </path>     <target name="ss.clean" description="清除生成的目录结构">         <echo message="清除生成的目录结构" />         <delete dir="${this.ss.Projectfolder}" />     </target>     <target name="ss.prepare" description="初始化目录结构" depends="ss.clean">         <echo message="初始化目录结构" />         <mkdir dir="${this.ss.Projectfolder}" />         <mkdir dir="${this.ss.bin}" />         <mkdir dir="${this.ss.bin}/classes" />         <mkdir dir="${this.ss.bin}/test" />         <mkdir dir="${this.ss.Package}" />         <mkdir dir="${this.ss.Package.Jar}" />         <mkdir dir="${this.ss.Package.War}" />         <mkdir dir="${this.ss.Package.Zip}" />     </target>     <target name="ss.code.compile" description="在工程目录中编译产品代码" depends="ss.prepare">         <echo message="在工程目录中编译" />         <javac srcdir="${basedir}/src/com" destdir="${this.ss.bin}/classes" debug="on" includeantruntime="on" encoding="utf-8" nowarn="yes" memorymaximumsize="1024M" fork="true">             <classpath refid="this.ss.classpath" />         </javac>         <copy todir="${this.ss.bin}/classes">             <fileset dir="${basedir}/src">                 <exclude name="**/*.java" />             </fileset>         </copy>         <copy todir="${this.ss.bin}/classes">             <fileset dir="${basedir}/src/properties">                 <include name="license.lic" />                 <include name="log4j.properties" />                 <include name="log4j.xml" />                 <include name="oscache.properties" />             </fileset>         </copy>         <native2ascii src="${basedir}/src/properties" dest="${this.ss.bin}/classes" encoding="UTF-8" includes="**/*.zh" ext="_zh.properties" />         <native2ascii src="${basedir}/src/properties" dest="${this.ss.bin}/classes" encoding="UTF-8" includes="**/*.zh" ext=".properties" />     </target>     <target name ="ss.revision" depends="ss.code.compile">         <copy todir="${basedir}/root" flatten="true" preservelastmodified="true">         <fileset dir="/usr/CIWork/CIWork/jobs/ss_601/builds">         <include name="**/revision.txt"/>         </fileset>         </copy>     </target>     <target name="ss.version" >          <delete file="/usr/CIWork/CIWork/jobs/ss_601/workspace/root/version.txt"/>     <exec executable="cmd" failonerror="true">           <arg line="/c /usr/CIWork/CIWork/jobs/ss_601/workspace/root/version.bat" />    </exec>    <delete file="/usr/CIWork/CIWork/jobs/ss_601/workspace/root/version.bat"/>    <delete file="/usr/CIWork/CIWork/jobs/ss_601/workspace/root/revision.txt"/>     </target>     <target name="ss.Packagewar" description="打war包" depends="ss.revision">         <war destfile="${this.ss.Package}/War/ss.war" compress="true" >             <classes dir="${this.ss.bin}/classes">             </classes>             <fileset dir="${basedir}/root">                 <exclude name="WEB-INF/classes/**/*.*" />             </fileset>         </war>     </target>     <target name="ss.Packagezip" description="打Zip包" depends="ss.Packagewar">         <tstamp>             <format property="flag" pattern="yyyyMMddHHmm" />         </tstamp>         <zip destfile="${this.ss.Package}/Zip/ss-${flag}.zip" compress="true" update="true">             <fileset dir="${this.ss.Package}/War">                 <include name="ss.war" />             </fileset>         </zip>     </target>     <target name="ss.build" description="执行构建" depends="ss.clean,ss.Packagezip">     </target> </project>
相关文章
相关标签/搜索