ant教程

港控/mmm° 2022-05-19 08:26 193阅读 0赞

1.  写一个buildfile文件

> > 示例
> > 
> >   
> >

<description>
 simple example build file
 </description>
 
 <property name="src" location="src"/>
 <property name="build" location="build"/>
 <property name="dist" location="dist"/>
 <target name="init">
 
 <tstamp/>
 
 <mkdir dir="${build}"/>
 </target>
 <target name="compile" depends="init"
 description="compile the source " >
 
 <javac srcdir="${src}" destdir="${build}"/>
 </target>
 <target name="dist" depends="compile"
 description="generate the distribution" >
 
 <mkdir dir="${dist}/lib"/>
 
 <jar jarfile="${dist}/lib/MyProject-${DSTAMP}.jar" basedir="${build}"/>
 </target>
 <target name="clean"
 description="clean up" >
 
 <delete dir="${build}"/>
 <delete dir="${dist}"/>
 </target>
 </project>

*  project节点：定义项目的基本信息 主要属性 name,basedir,default

*  target 节点：定义要执行的一些操作，比如 编译（compile)，运行(run)等 , depends表示依赖的target。

### Parameters ###

<table style="font-family:Simsun"> 
 <tbody> 
 <tr> 
 <td style="background-color:rgb(204,204,204)">Attribute</td> 
 <td style="background-color:rgb(204,204,204)">Description</td> 
 <td align="center" style="background-color:rgb(204,204,204)">Required</td> 
 </tr> 
 <tr> 
 <td style="background-color:rgb(238,238,238)">name</td> 
 <td style="background-color:rgb(238,238,238)">the name of the property to set.</td> 
 <td align="center" style="background-color:rgb(238,238,238)">No</td> 
 </tr> 
 <tr> 
 <td style="background-color:rgb(238,238,238)">value</td> 
 <td style="background-color:rgb(238,238,238)">the value of the property.</td> 
 <td align="center" style="background-color:rgb(238,238,238)"> One of these or nested text, when using the name attribute</td> 
 </tr> 
 <tr> 
 <td style="background-color:rgb(238,238,238)">location</td> 
 <td style="background-color:rgb(238,238,238)">Sets the property to the absolute filename of the given file. If the value of this attribute is an absolute path, it is left unchanged (with / and \ characters converted to the current platforms conventions). Otherwise it is taken as a path relative to the project's basedir and expanded.</td> 
 </tr> 
 <tr> 
 <td style="background-color:rgb(238,238,238)">refid</td> 
 <td style="background-color:rgb(238,238,238)">Reference&nbsp;to an object defined elsewhere. Only yields reasonable results for references to&nbsp;PATH like structures&nbsp;or properties.</td> 
 </tr> 
 <tr> 
 <td style="background-color:rgb(238,238,238)">resource</td> 
 <td style="background-color:rgb(238,238,238)">the name of the classpath resource containing properties settings in properties file format.</td> 
 <td align="center" style="background-color:rgb(238,238,238)"> One of these, whennot&nbsp;using the name attribute</td> 
 </tr> 
 <tr> 
 <td style="background-color:rgb(238,238,238)">file</td> 
 <td style="background-color:rgb(238,238,238)">the location of the properties file to load.</td> 
 </tr> 
 <tr> 
 <td style="background-color:rgb(238,238,238)">url</td> 
 <td style="background-color:rgb(238,238,238)">a url containing properties-format settings.</td> 
 </tr> 
 <tr> 
 <td style="background-color:rgb(238,238,238)">environment</td> 
 <td style="background-color:rgb(238,238,238)">the prefix to use when retrieving environment variables. Thus if you specify environment="myenv" you will be able to access OS-specific environment variables via property names "myenv.PATH" or "myenv.TERM". Note that if you supply a property name with a final "." it will not be doubled; i.e. environment="myenv." will still allow access of environment variables through "myenv.PATH" and "myenv.TERM". This functionality is currently only implemented on&nbsp;select platforms. Feel free to send patches to increase the number of platforms on which this functionality is supported ;).Note also that properties are case-sensitive, even if the environment variables on your operating system are not; e.g. Windows 2000's system path variable is set to an Ant property named "env.Path" rather than "env.PATH".</td> 
 </tr> 
 <tr> 
 <td style="background-color:rgb(238,238,238)">classpath</td> 
 <td style="background-color:rgb(238,238,238)">the classpath to use when looking up a resource.</td> 
 <td align="center" style="background-color:rgb(238,238,238)">No</td> 
 </tr> 
 <tr> 
 <td style="background-color:rgb(238,238,238)">classpathref</td> 
 <td style="background-color:rgb(238,238,238)">the classpath to use when looking up a resource, given as&nbsp;reference&nbsp;to a&nbsp;<code>&lt;path&gt;</code>&nbsp;defined elsewhere..</td> 
 <td align="center" style="background-color:rgb(238,238,238)">No</td> 
 </tr> 
 <tr> 
 <td style="background-color:rgb(238,238,238)">prefix</td> 
 <td style="background-color:rgb(238,238,238)">Prefix to apply to properties loaded using&nbsp;<code>file</code>,&nbsp;<code>resource</code>, or&nbsp;<code>url</code>. A "." is appended to the prefix if not specified.</td> 
 <td align="center" style="background-color:rgb(238,238,238)">No</td> 
 </tr> 
 <tr> 
 <td style="background-color:rgb(238,238,238)">prefixValues</td> 
 <td style="background-color:rgb(238,238,238)">Whether to apply the prefix when expanding the right hand side of properties loaded using&nbsp;<code>file</code>,&nbsp;<code>resource</code>, or&nbsp;<code>url</code>.&nbsp;Since Ant 1.8.2</td> 
 <td align="center" style="background-color:rgb(238,238,238)">No (default=false)</td> 
 </tr> 
 <tr> 
 <td style="background-color:rgb(238,238,238)">relative</td> 
 <td style="background-color:rgb(238,238,238)">If set to&nbsp;true&nbsp;the relative path to&nbsp;basedir&nbsp;is set.&nbsp;Since Ant 1.8.0</td> 
 <td align="center" style="background-color:rgb(238,238,238)">No (default=false)</td> 
 </tr> 
 <tr> 
 <td style="background-color:rgb(238,238,238)">basedir</td> 
 <td style="background-color:rgb(238,238,238)">The basedir to calculate the relative path from.&nbsp;Since Ant 1.8.0</td> 
 <td align="center" style="background-color:rgb(238,238,238)">No (default=${basedir})</td> 
 </tr> 
 </tbody> 
</table>

>  *  内置属性 (built-in properties)

> > Ant provides access to all system properties as if they had been defined using a `<property>` task. For example, `${os.name}`expands to the name of the oper atingsystem.
> 
> > For a list of system properties see [the Javadoc of System.getProperties][].
> 
> > In addition, Ant has some built-in properties:
> 
> > basedir the absolute path of the project's basedir (as set
> 
> > with the basedir attribute of <project>).
> 
> > ant.file the absolute path of the buildfile.
> 
> > ant.version the version of Ant
> 
> > ant.project.name the name of the project that is currently executing;
> 
> > it is set in the name attribute of <project>.
> 
> > ant.project.default-target
> 
> > the name of the currently executing project's
> 
> > default target; it is set via the default
> 
> > attribute of <project>.
> 
> > ant.project.invoked-targets
> 
> > a comma separated list of the targets that have
> 
> > been specified on the command line (the IDE,
> 
> > an <ant> task ...) when invoking the current
> 
> > project.
> 
> > ant.java.version the JVM version Ant detected; currently it can hold
> 
> > the values "1.2", "1.3",
> 
> > "1.4", "1.5" and "1.6".
> 
> > ant.core.lib the absolute path of the ant.jar file.
> 
> > There is also another property, but this is set by the launcher script and therefore maybe not set inside IDEs:
> 
> > ant.home home directory of Ant
> 
> > The following property is only set if Ant is started via the Launcher class (which means it may not be set inside IDEs either):
> 
> > ant.library.dir the directory that has been used to load Ant's
> 
> > jars from. In most cases this is ANT_HOME/lib.

*  ant任务 (ant tasks)

<table style="font-family:Simsun"> 
 <tbody> 
 <tr> 
 <th align="left" style="background-color:rgb(204,204,204)"> &nbsp;&nbsp;&nbsp;&nbsp;Ant的常用任务 在Ant工具中每一个任务封装了具体要执行的功能，是Ant工具的基本执行单位。在本小节中，主要引导读者来看下Ant的常用任务及其使用举例。 1.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;copy任务 该任务主要用来对文件和目录的复制功能。举例如下： Eg1.复制单个文件：&lt;copy file="file.txt" tofile="copy.txt"/&gt; Eg2.对文件目录进行复制： &nbsp;&nbsp; &lt;copy todir="../newdir/dest_dir"&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;fileset dir="src_dir"/&gt; &nbsp;&lt;/copy&gt; Eg3.&nbsp;将文件复制到另外的目录： &nbsp;&lt;copy file="file.txt" todir="../other/dir"/&gt; 2.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;delete任务 对文件或目录进行删除，举例如下： Eg1.&nbsp;删除某个文件：&lt;delete file="photo/amigo.jpg"/&gt; Eg2.&nbsp;删除某个目录：&lt;delete dir="photo"/&gt; Eg3.&nbsp;删除所有的备份目录或空目录： &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;delete includeEmptyDirs="true"&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;fileset dir="." includes="**/*.bak"/&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;/delete&gt; 3.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;mkdir任务 创建目录。eg：&lt;mkdir dir="build"/&gt; 4.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;move任务 移动文件或目录，举例如下： Eg1.&nbsp;移动单个文件：&lt;move file="fromfile" tofile=”tofile”/&gt; Eg2.&nbsp;移动单个文件到另一个目录：&lt;move file="fromfile" todir=”movedir”/&gt; Eg3.&nbsp;移动某个目录到另一个目录： &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;move todir="newdir"&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;fileset dir="olddir"/&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;/move&gt; 5.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;echo任务 该任务的作用是根据日志或监控器的级别输出信息。它包括message、file、append和level四个属性，举例如下： &lt;echo message="Hello,Amigo" file="logs/system.log" append="true"&gt; </th> 
 <th align="right" style="background-color:rgb(204,204,204)">&nbsp;</th> 
 </tr> 
 </tbody> 
</table>

**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的类型。

类型举例

<fileset dir="${server.src}" casesensitive="yes">
 <patternset id="non.test.sources">
 <include name="**/*.java"/>
 <exclude name="**/*Test*"/>
 </patternset>
 </fileset>
 
 
 Groups the same files as the above example, but also establishes a PatternSet that can be referenced in other <fileset>elements, rooted at a different directory. 
 
 
 
 <fileset dir="${client.src}" >
 <patternset refid="non.test.sources"/>
 </fileset> 
 
 <fileset dir="src" includes="main/" />

[the Javadoc of System.getProperties]: http://download.oracle.com/javase/6/docs/api/java/lang/System.html#getProperties%28%29