从01开始
2022-11-27
目录

Ant笔记2：运行一个Java程序

# 构建脚本的内容

Ant是根据构建脚本来执行的，构建脚本是XML文件，里面就是一个个XML元素。我们先介绍2个常用的。

# project

project是构建脚本的根元素，所以一个构建脚本文件中必须包含且仅能包含一个project标签，<project>和</project>之间所包含的所有内容组成了一个完整的构建文件。

project元素的属性：

属性名 功能说明 缺省值 必须
name 当前构建文件的名称 N
default 当前构建文件默认的执行入口目标 target Y
basedir 当前构建文件（name）的基础路径 当前目录 N
description 项目描述信息 N

# target

Ant把构建分为了很多个目标，目标是一个或多个任务的集合。 任务就是具体的一段代码。

构建文件包含一个项目，在项目内部声明了所有目标。 要创建目标，可以使用<target>标记。

例如，一个构建文件里分了编译，打包和重启应用3个target，每个target里有很多任务：

  • target1：编译
    • 任务task1：创建目录用于存放class文件
    • 任务task2：编译Java文件
    • ………
  • target2：打包
    • task1：打成一个tar或者war包
    • task2：上传到服务器上
    • ……
  • target3：运行
  • task1：停止应用
  • task2：启动应用
  • task3：检查应用状态
    • …………

一个构建脚本里可以包含多个target（任务元素），当然你也可以像第一个Ant项目那样不包含任务元素，但那样的话什么也做不了。target拥有的属性

属性名 功能说明 缺省值 必须
name target的名称 Y
id target的ID N
depends 依赖关系列表，是一个以逗号分隔的<target>元素名称列表
N
if 用于验证指定的属性是否存在
N
unless 用于验证指定的属性是否不存在 N
description 对当前目标任务<target>功能的一个简短描述 N

# 用Ant输出HelloWorld

用Ant输出一句HelloWorld。别看是输出一句HelloWorld而已，实际上在项目编译过程中输出一些关键的信息很有用的。

我们新建一个1-HelloWorld.xml文件，

  1. 增加第一个任务元素，名为：say hello。并通过echo元素打印出：hello world!
  2. 找到根元素，并添加default属性，属性值为：say hello，使Ant默认执行say hello任务；
  3. 完整代码如下：
<?xml version="1.0" encoding="GB2312"?>
<project name="demo" default="say hello">
	  <target name="say hello" description="你好，世界！">
	  	  <echo level="info" message="hello world!"/>
	  </target>
</project>
1
2
3
4
5
6

打开cmd，进入构建脚本所在目录，运行：

D:\Projects\AntLearn> ant -file 1-HelloWorld.xml
Buildfile: D:\Projects\AntLearn\1-HelloWorld.xml

say hello:
     [echo] Hello World!

BUILD SUCCESSFUL
Total time: 0 seconds
1
2
3
4
5
6
7
8

打印出：“hello world!”。这表示我们的第一个任务执行成功。

echo就是具体的task，后续我们会介绍一些常用的task

请读者自己也动手完成这个例子，可以增加多几条打印语句。

# Ant的属性

XML文件中，一个标签可以有多个属性。

例如project标签，可以有description属性：

<project name="demo" description="Learn Ant project">
</project>
1
2

Apache Ant属性类型有两种:

  • 内置属性
  • 用户定义的属性

Apache Ant内置属性

Apache Ant提供了各种内置属性，我们可以在构建文件中访问所有这些属性。 下面的表中给出了一些内置属性。

属性 描述
basedir 用于项目基础的绝对路径
ant.file 用于构建文件的绝对路径
ant.version 用于Ant的版本
ant.project.name 它包含当前正在执行的项目的名称
ant.project.default-target 它包含当前正在执行的项目的默认目标的名称
ant.project.invoked-targets 调用当前项目时的目标列表
ant.java.version 拥有的JVM版本
ant.core.lib ant.jar 文件的绝对路径
ant.home 包含Ant的主目录
ant.library.dir 包含用于加载Ant的jar的目录。

Apache Ant用户定义的属性

除了内置属性，Apache Ant还提供了在buildfile中创建自定义属性的工具。

要创建属性，使用Ant提供的<property>标记，该标记使用name和value属性。 name属性是属性的名称，value属性包含的值。

# 用Ant输出属性

我们新建 一个文件2-Property.xml，编写代码如下

<?xml version="1.0" encoding="UTF8"?>
<project default="echoProperty">
	<property name="myName" value="Peter JXL"/>
	<target  name="echoProperty">
		<echo>${myName} is my name. </echo>
	</target>
</project>
1
2
3
4
5
6
7

运行：

PS D:\Projects\AntLearn> ant -file 2-Property.xml
Buildfile: D:\Projects\AntLearn\2-Property.xml

echoProperty:
     [echo] Peter JXL is my name. 

BUILD SUCCESSFUL
Total time: 0 seconds
1
2
3
4
5
6
7
8

属性之间可以嵌套，例如定义一个根目录，然后下面再定义几个子目录：

<property name="TEMP_DIR" value="./temp" />
<property name="TEMP_WEB_INF" value="${TEMP_DIR}/WEB-INF" />
<property name="TEMP_APP_LIB" value="${TEMP_WEB_INF}/lib" />
1
2
3

# 属性文件

当你只需要对小部分属性进行设置时，可以选择直接在构建文件中设置。然而，对于大项目，最好将设置属性的信息存储在一个独立的文件中。

存储属性信息在一个独立的文件中的好处：它可以让不同环境下重复使用相同的构建文件，但属性是不同的。例如测试环境和生产环境可能有部分配置不同，例如IP信息，文件的位置，版本等；因此可以创建多个不同的配置文件，一个文件对应一个环境，但构建文件不用修改，只用一个就行。

一般情况下，属性文件都被命名为 build.properties ， 并且与 build.xml 存放在同一目录层。 你可以基于部署环境 ——比如： build.properties.dev 和 build.properties.test 创建多个 build.properties 文件。

在下面的例子中展示了 build.xml 文件和与之相联系的 build.properties文件：

我们新建一个目录：3-properties

在里面新建一个build.properties文件

# The Site Name
sitename=www.peterjxl.com
buildversion=3.3.2
1
2
3

新建一个build.xml

<?xml version="1.0"?>
<project default = "echoProperties">
   <property file = "build.properties" />
   <target name = "echoProperties">
      <echo>Apache Ant version is ${ant.version} - You are at ${sitename} </echo>
   </target>
</project>
1
2
3
4
5
6
7

运行：

D:\Projects\AntLearn\3-properties> ant
Buildfile: D:\Projects\AntLearn\3-properties\build.xml

echoProperties:
     [echo] Apache Ant version is Apache Ant(TM) version 1.10.12 compiled on October 13 2021 - You are at www.peterjxl.com

BUILD SUCCESSFUL
Total time: 0 seconds
1
2
3
4
5
6
7
8

我们自定义了属性，并且使用了内置属性ant.version

练习：请读者自己动手做一遍，并将本文提到的所有内置属性都打印出来。

# Ant 与文件

Ant既然是用于构建的，总得和源代码打交道，这就得涉及到代码文件的路径，和代码文件集合。

在Ant中，这叫数据类型

# 文件集

代表了一个文件集合，用来包括或移除匹配某种模式的文件，可以理解为一个过滤器。举个例子：

<fileset dir="${src}" casesensitive="yes">

</fileset>
1
2
3

在上述代码中，src属性指向项目的源代码文件夹。casesensitive表明大小写敏感

有可能源代码目录中不是全都有用的，我们可以选择源代码文件夹中的Java代码，并且排除一些无用文件：

<fileset dir="${src}" casesensitive="yes">
   <include name="/.java"/>
   <exclude name="/Stub"/>
</fileset>
1
2
3
4

选择源文件夹中所有的 .java 文件，除了那些包含有 'Stub' 单词的文件，但Samplestub.java 的文件将不会被排除在文件集之外（大小写敏感）

# 模式集合

我们可以用正则表达式，更具体的说明我们想要什么文件。我们先定义一个正则表达式

<patternset id="java.files.without.stubs">
   <include name="src//.java"/>
   <exclude name="src//Stub"/>
</patternset>
1
2
3
4
  • ? 仅匹配一个字符
  • * 匹配零个或者多个字符
  • ** 递归地匹配零个或者多个目录

文件集里使用这种正则表达式，用ID指定哪个正则表达式

<fileset dir="${src}" casesensitive="yes">  
    <patternset refid="java.files.without.stubs"/>
</fileset>
1
2
3

# 文件列表

文件列表数据类型与文件集相类似，除了以下几处不同：

  • 文件列表包含明确命名的文件的列表，同时其不支持通配符。
  • 文件列表数据类型能够被应用于现有的或者还不存在的文件中。

让我们来看一个下述的关于文件列表数据类型的例子。在这个例子中，属性 webapp.src.folder 指向该项目中的 Web 应用的源文件夹。

<filelist id="config.files" dir="${webapp.src.folder}">   
    <file name="applicationConfig.xml"/>   
    <file name="faces-config.xml"/>   
    <file name="web.xml"/>   
    <file name="portlet.xml"/>
</filelist>
1
2
3
4
5
6

还有很多描述文件的数据类型，暂且不表，后面我们会教如何看官方文档

# Task

# 再谈target

我们之前说过，Ant把构建分为了一个个目标，每个目标元素都可以包含一系列你想要执行的事务的集合。

例如，我们之前创建了一个target，用来打印一句HelloWorld。我们还可以在这个target里编译代码，运行代码，一个target里可以有很多task

任务可以具有多个属性，每个任务都具有共同的结构。 常见结构由任务名称，属性等组成：

<task-name attribute1 = "value1" attribute2 = "value2" ... >  
    ...  
</task-name>
1
2
3

Apache Ant任务分为两类:

  • 内置任务
  • 用户定义的任务，用的较少

# depends属性

在实际开发过程中，我们可能有多个任务：例如一个任务用来编译，一个任务用来打包，一个用来删除中间文件……

同时，任务之间是有先后顺序的，例如要运行项目肯定得先编译，我们可以用depend属性说明哪个先执行。

举个栗子：

<target name="run" depends="compile">  
        ...  
</target>  

<target name="compile">  
        ...  
</target>
1
2
3
4
5
6
7

调用顺序: 编译(compile)-> 运行(run)，表示目标执行的顺序。

当然，也可以不指定depend，在命令行里指定执行哪个target。

> ant compile  //只执行编译
> ant run  	//会执行编译和运行，因为run依赖于compile
1
2

# Ant预定义(内置)任务

Apache Ant本身在其库中提供的任务称为内置任务。 Apache ant提供了大量内置任务， 如下列表所示:

  • 存档任务
  • 审计任务
  • 编译任务
  • 执行任务
  • 文件任务
  • 记录任务
  • 邮件任务
  • ..........................

# 存档任务

用于压缩和解压缩数据的任务称为归档任务。下面列出了一些常见的内置存档任务。

任务名称 描述
Ear Jar任务的扩展，对文件进行特殊处理
Jar 一组文件
Tar 创建tar存档
Unjar 解压缩jar文件
Untar 解压tarfile
Unwar 解压缩warfile
Unzip 解压缩zip文件
War Jar任务的扩展

# 审计任务

任务名称 描述
JDepend 它用于调用JDepend解析器

# 编译任务

用于编译源文件的任务称为编译任务，下面列出了一些常见的内置编译任务。

任务名称 描述
Depend 确定哪些类文件的资源已过期
Javac 编译源文件
JspC 运行JSP编译器
NetRexxC 编译NetRexx源文件
Rmic 运行rmic编译器

# 执行任务

用于执行运行应用程序的任务称为执行任务。下面列出了一些常见的内置执行任务。

任务名称 描述
Ant 在指定的构建文件上运行Ant
AntCall 在同一个构建文件中运行另一个目标
Apply 执行系统命令
Java 执行Java类
Parallel 可包含其他ant任务的容器任务
Sleep 按指定的时间暂停执行

# 文件任务

与句柄文件操作相关的任务称为文件任务。下面列出了一些常见的内置文件任务。

任务名称 描述
Chmod 更改文件的权限
Chown 更改文件的所有权
Concat 连接多个文件
Copy 将文件复制到新目的地
Delete 删除文件
Mkdir 创建一个目录

练习：这里给出一段代码，请读者自行运行每个target。源码目录：4-Target/build.xml

<?xml version="1.0" encoding="UTF8"?>
<project>

	<target name="testMkdir">
        <mkdir dir="test"/>
    </target>

    <!-- 运行前：先创建test目录 -->
    <target name="testDelete">
        <delete dir="test"/>
    </target>

    <!-- 运行前：没有则新建test目录，里面新建一个test.txt -->
    <target name="testZip">
        <zip destfile="test.zip">
            <fileset dir="test">
                <include name = "test.txt"/>
            </fileset>
        </zip>
    </target>

    <!-- 运行前：没有则新建test目录，然后在test目录新建一个txt文档 -->
    <target name="testCopy">
        <copy todir="testCopy" overwrite="true">
            <fileset dir="test">
                <include name="*.txt"></include>
            </fileset>
        </copy>
    </target>
</project>
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

一个target里可以有很多复制的插件，例如

<copy todir="${TEMP_APP_LIB}" overwrite="true">
	<fileset dir="${COMMON_LIB_DIR}/EMP">
		<include name="*.jar" />
	</fileset>
	<fileset dir="${COMMON_LIB_DIR}/Other">
		<include name="*.jar" />
		<exclude name="ebankpwd.jar"/>
	</fileset>
	<fileset dir="${COMMON_LIB_DIR}/idtrust">
		<include name="*.jar" />
	</fileset>
	<fileset dir="${COMMON_LIB_DIR}/PowerEnter">
		<include name="*.jar" />
	</fileset>
</copy>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# 自定义任务

Apache Ant允许用户编写自己的任务。编写自己的任务非常容易。 下面给出了一些必要的步骤。请参考以下几个步骤。

  • 首先创建一个Java类并扩展org.apache.tools.ant.Task类。
  • 为每个属性创建setter和getter方法。
  • 如果task包含其他任务作为嵌套元素，则class必须实现org.apache.tools.ant.TaskContainer接口。
  • 如果任务支持字符数据，请编写public void addText(String)方法。
  • 对于每个嵌套元素，write，add或addConfigured方法。
  • 编写一个public void execute()方法(不带参数)并抛出BuildException。

一般内置的task就够用了，这里笔者不展开使用

# 关于帮助文档

授之以鱼不如授之以渔，笔者之前是直接列出来某个task怎么用的，但笔者不可能把每个都讲一遍，因为已经有人这么做了：官方文档里都写了。

我们可以打开Ant安装目录下的这个文件：apache-ant-1.10.12\manual\index.html

左侧就是目录，可以点进Ant Tasks看具体的

例如Copy这个Task，右侧就是Cppy能用的属性，下面还有具体的用法。

# 用Ant编译Java程序

我们来做些实际上有用的事情。例如编译一个Java类。

我们新建一个目录5-AntJava，里面新建一个Hello.java文件，内容如下：

public class Hello{
    public static void main(String []args){
        System.out.println("Hello Ant");
    }
}
1
2
3
4
5

新建一个build.xml，里面先编译，再运行Java类。

<?xml version="1.0" encoding="UTF8"?>
<project>

    <property name="destEncoding" value="UTF-8" />

    <target name = "compile">
        <javac encoding="${destEncoding}"  destdir=".">
        	<src path="."/>
        </javac>   
    </target>

    <target name = "run">
        <java classname="Hello">
            <classpath>
                <pathelement location="."></pathelement>
            </classpath>
        </java>
    </target>

    <target name="clean">
        <delete file="Hello.class"/>
    </target>
   
</project>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

javac任务也可以写成：

<javac includeantruntime="false" srcdir="./src" destdir = "test"></javac>
1

运行编译：可以看到有个class文件

D:\Projects\AntLearn\5-AntJava> ant compile
Buildfile: D:\Projects\AntLearn\5-AntJava\build.xml

compile:

BUILD SUCCESSFUL
Total time: 0 seconds
1
2
3
4
5
6
7

我们来试着运行：

D:\Projects\AntLearn\5-AntJava> ant run
Buildfile: D:\Projects\AntLearn\5-AntJava\build.xml

run:
     [java] Hello Ant

BUILD SUCCESSFUL
Total time: 0 seconds
1
2
3
4
5
6
7
8

可以看到Java类被执行了

运行clean：可以看到class文件被删除了

D:\Projects\AntLearn\5-AntJava> ant clean
Buildfile: D:\Projects\AntLearn\5-AntJava\build.xml

clean:
   [delete] Deleting: D:\Projects\AntLearn\5-AntJava\Hello.class

BUILD SUCCESSFUL
Total time: 0 seconds
1
2
3
4
5
6
7
8

# 小结

本文介绍的内容：

  • 构建脚本的task
  • 用Ant输出HelloWorld
  • Ant的属性
  • Ant的文件
  • 内置的Task
  • 怎么看帮助文档
  • 用Ant运行Java程序

通过本文，作者应该能编写一些简单的程序了。大型的项目，也可以通过这些一个个简单的task来完成构建。

本文涉及的Ant配置文件：

Gitee：03.JavaEE/01.LearnAnt · 小林/LearnJava - 码云 - 开源中国 (opens new window)

GitHub：LearnJava/03.JavaEE/01.LearnAnt at master · Peter-JXL/LearnJava (opens new window)

在GitHub上编辑此页 (opens new window)
上次更新: 2023/2/16 09:01:37
Ant笔记1：Ant介绍和入门
Ant笔记3：更多Ant用法

← Ant笔记3：更多Ant用法→

Theme by Vdoing | Copyright © 2022-2023 粤ICP备2022067627号-1 粤公网安备 44011302003646号