第十七章. 从 Gradle 中使用 Ant

在构建脚本中，Gradle 提供了一个叫 ant 的属性，它是一个指向 AntBuilder 实例的引用。这个 AntBuilder 用于从构建脚本中访问 Ant 任务，类型和属性。从 Ant 的 build.xml 格式到 Groovy 之间有一个非常简单的映射，这将在下面解释。
In your build script, a property called ant is provided by Gradle. This is a reference to an AntBuilder instance. This AntBuilder is used to access Ant tasks, types and properties from your build script. There is a very simple mapping from Ant's build.xml format to Groovy, which is explained below.

通过调用 AntBuilder 实例上的一个方法，可以来执行一个 Ant 任务。你可以把任务名称作为方法名称来使用。例如，通过调用 ant.echo() 方法执行 Ant echo 任务。Ant 任务的属性将作为 Map 参数传递给这个方法。下面是执行 echo 任务的一个例子。请注意，我们也可以混合使用 Groovy 代码和 Ant 任务标记，这会很强大。
You execute an Ant task by calling a method on the AntBuilder instance. You use the task name as the method name. For example, you execute the Ant echo task by calling the ant.echo() method. The attributes of the Ant task are passed as Map parameters to the method. Below is an example which executes the echo task. Notice that we can also mix Groovy code and the Ant task markup. This can be extremely powerful.

task hello << {
    String greeting = 'hello from Ant'
    ant.echo(message: greeting)
}

> gradle hello
:hello
[ant:echo] hello from Ant

BUILD SUCCESSFUL

Total time: 1 secs

你可以把一个嵌套文本，通过作为任务方法调用的参数传给一个 Ant 任务。在此示例中，我们将把作为嵌套文本的消息传给 echo 任务：
You pass nested text to an Ant task by passing it as a parameter of the task method call. In this example, we pass the message for the echo task as nested text:

task hello << {
    ant.echo('hello from Ant')
}

> gradle hello
:hello
[ant:echo] hello from Ant

BUILD SUCCESSFUL

Total time: 1 secs

你可以在一个闭包里把嵌套的元素传给一个 Ant 任务。嵌套元素的定义方式与任务相同，通过调用与我们要定义的元素同名的方法。
You pass nested elements to an Ant task inside a closure. Nested elements are defined in the same way as tasks, by calling a method with the same name as the element we want to define.

task zip << {
    ant.zip(destfile: 'archive.zip') {
        fileset(dir: 'src') {
            include(name: '**.xml')
            exclude(name: '**.java')
        }
    }
}

你可以像访问任务一样，使用类型名作为方法名来访问 Ant 类型。方法调用将返回 Ant 数据类型，可以让你在构建脚本直接中使用。在下面的例子中，我们创建了一个 Ant path 对象，然后遍历它的内容。
You can access Ant types in the same way that you access tasks, using the name of the type as the method name. The method call returns the Ant data type, which you can then use directly in your build script. In the following example, we create an Ant path object, then iterate over the contents of it.

task list << {
    def path = ant.path {
        fileset(dir: 'libs', includes: '*.jar')
    }
    path.list().each {
        println it
    }
}

有 关AntBuilder 的详细信息，可以参阅 《Groovy in Action》的第 8.4 节， 或者是 Groovy Wiki。
More information about AntBuilder can be found in 'Groovy in Action' 8.4 or at the Groovy Wiki

task check << {
    ant.taskdef(resource: 'checkstyletask.properties') {
        classpath {
            fileset(dir: 'libs', includes: '*.jar')
        }
    }
    ant.checkstyle(config: 'checkstyle.xml') {
        fileset(dir: 'src')
    }
}

configurations {
    pmd
}

dependencies {
    pmd group: 'pmd', name: 'pmd', version: '4.2.5'
}

task check << {
    ant.taskdef(name: 'pmd', classname: 'net.sourceforge.pmd.ant.PMDTask', classpath: configurations.pmd.asPath)
    ant.pmd(shortFilenames: 'true', failonruleviolation: 'true', rulesetfiles: file('pmd-rules.xml').toURI().toString()) {
        formatter(type: 'text', toConsole: 'true')
        fileset(dir: 'src')
    }
}

你可以使用 ant.importBuild() 方法将 Ant 构建导入到你的 Gradle 项目中。导入 Ant 构建时，每个 Ant 目标都被视为是一个 Gradle 任务。这意味着你可以像 Gradle 任务一样操作和执行 Ant 目标。
You can use the ant.importBuild() method to import an Ant build into your Gradle project. When you import an Ant build, each Ant target is treated as a Gradle task. This means you can manipulate and execute the Ant targets in exactly the same way as Gradle tasks.

ant.importBuild 'build.xml'

<project>
    <target name="hello">
        <echo>Hello, from Ant</echo>
    </target>
</project>

> gradle hello
:hello
[ant:echo] Hello, from Ant

BUILD SUCCESSFUL

Total time: 1 secs

你可以添加一个依赖于 Ant 目标的任务：
You can add a task which depends on an Ant target:

ant.importBuild 'build.xml'

task intro(dependsOn: hello) << {
    println 'Hello, from Gradle'
}

> gradle intro
:hello
[ant:echo] Hello, from Ant
:intro
Hello, from Gradle

BUILD SUCCESSFUL

Total time: 1 secs

或者你也可以将行为添加到 Ant 目标中：
Or, you can add behaviour to an Ant target:

ant.importBuild 'build.xml'

hello << {
    println 'Hello, from Gradle'
}

> gradle hello
:hello
[ant:echo] Hello, from Ant
Hello, from Gradle

BUILD SUCCESSFUL

Total time: 1 secs

它也可以用于一个依赖于 Gradle 任务的 Ant 目标：
It is also possible for an Ant target to depend on a Gradle task:

ant.importBuild 'build.xml'

task intro << {
    println 'Hello, from Gradle'
}

<project>
    <target name="hello" depends="intro">
        <echo>Hello, from Ant</echo>
    </target>
</project>

> gradle hello
:intro
Hello, from Gradle
:hello
[ant:echo] Hello, from Ant

BUILD SUCCESSFUL

Total time: 1 secs

有几种方法来设置一个 Ant 属性，以便该属性可以被 Ant 任务使用。你可以直接在 AntBuilder 实例上设置属性。这些 Ant 属性也可以作为可以更改的 Map 来使用。你也可以使用 Ant property 任务。以下是一些如何做到这一点的例子。
There are several ways to set an Ant property, so that the property can be used by Ant tasks. You can set the property directly on the AntBuilder instance. The Ant properties are also available as a Map which you can change. You can also use the Ant property task. Below are some examples of how to do this.

ant.buildDir = buildDir
ant.properties.buildDir = buildDir
ant.properties['buildDir'] = buildDir
ant.property(name: 'buildDir', location: buildDir)

<echo>buildDir = ${buildDir}</echo>

许多 Ant 任务会在执行时设置属性，有几种方法可以获得这些属性的值。你可以直接从 AntBuilder 实例获取属性。这些 Ant 属性也可以作为 Map 使用。以下是一些例子。
Many Ant tasks set properties when they execute. There are several ways to get the value of these properties. You can get the property directly from the AntBuilder instance. The Ant properties are also available as a Map. Below are some examples.

<property name="antProp" value="a property defined in an Ant build"/>

println ant.antProp
println ant.properties.antProp
println ant.properties['antProp']

有几种方法可以设置 Ant 引用：
There are several ways to set an Ant reference:

ant.path(id: 'classpath', location: 'libs')
ant.references.classpath = ant.path(location: 'libs')
ant.references['classpath'] = ant.path(location: 'libs')

<path refid="classpath"/>

有几种方法可以获取 Ant 引用：
There are several ways to get an Ant reference:

<path id="antPath" location="libs"/>

println ant.references.antPath
println ant.references['antPath']

对 Ant 集成由 AntBuilder 提供。
The Ant integration is provided by AntBuilder.