第17章 GradleからAntを使う

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.

ビルドスクリプトではGradleによってプロパティantが提供されます。 これはAntBuilderインスタンスへの参照です。 このAntBuilderはビルドスクリプトからAntタスクやタイプ、プロパティへのアクセスに利用します。 Antのbuild.xmlフォーマットからGroovyへのマッピングは非常に簡単です。 以下で説明します。

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 of the echo task. Notice that we can also mix Groovy code and the Ant task markup. This can be extremely powerful.

Antタスクを実行するには、AntBuilderインスタンスのメソッドを呼び出します。 Antタスク名がメソッド名になります。 例えば、Antのechoタスクを実行する場合は、ant.echo()メソッドを呼び出します。 Antタスクの属性は、メソッドにMap型のパラメータとして渡します。 以下はechoタスクを実行するサンプルです。 GroovyコードとAntタスクのマークアップを混在できることに注意してください。 これは非常に強力です。

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

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:

Antタスクのメソッド呼び出しのパラメータとして渡してやることで、ネストされたテキストをAntタスクに渡すことができます。 この例では、echoタスクに対するメッセージをネストされたテキストとして渡しています。

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

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

BUILD SUCCESSFUL

Total time: 1 secs

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.

Antタスクにネストされた要素を渡す場合はクロージャの内部に記述します。 ネストされた要素はタスクと同じように、指定したい要素名と同じメソッドを呼び出すことで指定できます。

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

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.

Antタスクにアクセスするのと同じ方法、すなわちタイプ名をメソッド名として利用することでAntタイプにアクセスできます。 メソッド呼び出しの戻り値はAntデータ型なので、ビルドスクリプトの中で直接利用できます。 次の例では、Antのpathオブジェクトを生成し、その内容をすべてイテレートしています。

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

More information about AntBuilder can be found in 'Groovy in Action' 8.4 or at the Groovy Wiki

AntBuilderに関する詳細は「Groovy in Action」の8.4節、ないしは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')
    }
}

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()メソッドを利用して、GradleプロジェクトにAntビルドをインポートできます。 Antビルドをインポートした場合、各AntターゲットはGradleのタスクとして扱われます。 つまり、AntターゲットとGradleタスクをまったく同一の方法で操作することができるということです。

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

You can add a task which depends on an Ant target:

Antターゲットに依存するタスクを追加することもできます:

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

Or, you can add behaviour to an Ant target:

Antターゲットにふるまいを追加することも可能です:

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

It is also possible for an Ant target to depend on a Gradle task:

Gradleタスクに依存するAntターゲットを定義することも可能です:

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

Sometimes it may be necessary to “rename” the task generated for an Ant target to avoid a naming collision with existing Gradle tasks. To do this, use the AntBuilder.importBuild() method.

ant.importBuild('build.xml') { antTargetName ->
    'a-' + antTargetName
}

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

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

BUILD SUCCESSFUL

Total time: 1 secs

Note that while the second argument to this method should be a Transformer, when programming in Groovy we can simply use a closure instead of an anonymous inner class (or similar) due to Groovy's support for automatically coercing closures to single-abstract-method types.

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タスクで利用できるようにAntプロパティを設定する方法は複数あります。 AntBuilderインスタンスのプロパティを直接設定できます。 Antプロパティは変更可能なMapとしても利用可能です。 Antのpropertyタスクも利用できます。 以下はこれらをどのように実行するのかを示すサンプルです。

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

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

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.

多くのAntタスクは実行時にプロパティを設定します。 これらのプロパティを取得する方法も複数あります。 AntBuilderインスタンスからプロパティを直接取得できます。 AntプロパティはMapとしても参照可能です。 以下はサンプルです。

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

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

There are several ways to set an Ant reference:

Antリファレンスを設定する方法は複数あります:

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

<path refid="classpath"/>

There are several ways to get an Ant reference:

Antリファレンスを取得する方法も複数あります:

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

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

The Ant integration is provided by AntBuilder.

Ant統合機能はAntBuilderによって提供されています。