第24章 Groovyプラグイン

To use the Groovy plugin, include the following in your build script:

Groovyプラグインを使うためには、ビルドスクリプトに下記を含めます：

apply plugin: 'groovy'

The Groovy plugin adds the following tasks to the project.

Groovyプラグインは、以下のタスクをプロジェクトに追加します。

The Groovy plugin adds the following dependencies to tasks added by the Java plugin.

Groovyプラグインは、Javaプラグインによって追加されたタスクに以下の依存関係を追加します。

図24.1 Groovyプラグイン - タスクGroovy plugin - tasks

The Groovy plugin assumes the project layout shown in 表24.3「Groovyプラグイン - プロジェクトレイアウトGroovy plugin - project layout」. All the Groovy source directories can contain Groovy and Java code. The Java source directories may only contain Java source code. ^[18] None of these directories need to exist or have anything in them; the Groovy plugin will simply compile whatever it finds.

Groovyプラグインでは、表24.3「Groovyプラグイン - プロジェクトレイアウトGroovy plugin - project layout」に示したようなプロジェクトレイアウトを想定しています。すべてのGroovyソースディレクトリは、GroovyおよびJavaコードを含むことができます。Javaソースディレクトリは、Javaソースコードだけしか含むことができません。 ^[19] これらのどのディレクトリも、存在しなかったり、何も含んでいなくてもかまいません。Groovyプラグインは、単純に見つけたディレクトリをコンパイルするだけです。

sourceSets {
    main {
        groovy {
            srcDirs = ['src/groovy']
        }
    }

    test {
        groovy {
            srcDirs = ['test/groovy']
        }
    }
}

Because Gradle's build language is based on Groovy, and parts of Gradle are implemented in Groovy, Gradle already ships with a Groovy library (2.3.3 as of Gradle 2.0). Nevertheless, Groovy projects need to explicitly declare a Groovy dependency. This dependency will then be used on compile and runtime class paths. It will also be used to get hold of the Groovy compiler and Groovydoc tool, respectively.

Gradleのビルド言語はGroovyをベースにしており、Gradleの一部もGroovyで実装されているので、Gradleには既にGroovyライブラリ（Gradle2.0からは2.3.3）が同梱されています。ですが、Groovyプロジェクトでは明示的にGroovyへの依存関係を宣言しなければなりません。 ここで宣言したGroovyへの依存関係は、コンパイルクラスパスおよび実行時クラスパスに追加されます。さらに、GroovyコンパイラおよびGroovydocツールを取得するのにも使用されます。

If Groovy is used for production code, the Groovy dependency should be added to the compile configuration:

Groovyが製品コードで使われている場合は、Groovy依存関係はcompileコンフィギュレーションに追加してください。

repositories {
    mavenCentral()
}

dependencies {
    compile 'org.codehaus.groovy:groovy-all:2.3.6'
}

If Groovy is only used for test code, the Groovy dependency should be added to the testCompile configuration:

Groovyがテストコードのみで使われている場合は、Groovy依存関係はtestCompileコンフィギュレーションに追加してください。

dependencies {
    testCompile "org.codehaus.groovy:groovy:2.3.6"
}

To use the Groovy library that ships with Gradle, declare a localGroovy() dependency. Note that different Gradle versions ship with different Groovy versions; as such, using localGroovy() is less safe then declaring a regular Groovy dependency.

Gradleに同梱されているGroovyを使うには、localGroovy()を依存関係で宣言してください。ただ注意してほしいのは、Gradleのバージョンが異なれば同梱されているGroovyのバージョンも異なる可能性があるということです。localGroovy()は、普通の宣言方法に比べると安全とは言えません。

dependencies {
    compile localGroovy()
}

The Groovy library doesn't necessarily have to come from a remote repository. It could also come from a local lib directory, perhaps checked in to source control:

Groovyライブラリは、必ずしもリモートのリポジトリから取得しなければならないわけではありません。ローカルのlibディレクトリなどに格納して、ソースコード管理システムにチェックインしたりすることもできます。

repositories {
    flatDir { dirs 'lib' }
}

dependencies {
    compile module('org.codehaus.groovy:groovy:1.6.0') {
        dependency('asm:asm-all:2.2.3')
        dependency('antlr:antlr:2.7.7')
        dependency('commons-cli:commons-cli:1.2')
        module('org.apache.ant:ant:1.9.3') {
            dependencies('org.apache.ant:ant-junit:1.9.3@jar',
                         'org.apache.ant:ant-launcher:1.9.3')
        }
    }
}

The “module” reference may be new to you. See 51章依存関係の管理 for more information about this and other information about dependency management.

GroovyCompile and Groovydoc tasks consume Groovy code in two ways: on their classpath, and on their groovyClasspath. The former is used to locate classes referenced by the source code, and will typically contain the Groovy library along with other libraries. The latter is used to load and execute the Groovy compiler and Groovydoc tool, respectively, and should only contain the Groovy library and its dependencies.

GroovyCompileタスクとGroovydocタスクは二つの用途でGroovyを使用します。タスクのclasspathとgroovyClasspathです。前者はソースコードから参照されているクラスを配置するパスで、Groovyライブラリも典型的には他のライブラリと一緒に格納されます。後者はGroovyコンパイラとGroovydocツールをロードして実行するために使用されるパスで、Groovyライブラリとその依存関係のみが配置されていなければなりません。

Unless a task's groovyClasspath is configured explicitly, the Groovy (base) plugin will try to infer it from the task's classpath. This is done as follows: groovyClasspathが明示的に設定されていない場合、Groovy(base)プラグインはタスクのclasspathから以下のように設定値を推論しようとします。

Note that the “-indy” variation of each jar refers to the version with invokedynamic support.

The Groovy plugin does not add any convention properties to the project.

Groovyプラグインは、プロジェクトには規約プロパティを追加しません。

The Groovy plugin adds the following convention properties to each source set in the project. You can use these properties in your build script as though they were properties of the source set object (see 「規約 Conventions」).

Groovyプラグインは、プロジェクトの各ソースセットに以下の規約プロパティを追加します。これらのプロパティは、あたかもソースセットオブジェクトのプロパティであるかのようにビルドスクリプト内で使うことができます(「規約 Conventions」参照)。

These properties are provided by a convention object of type GroovySourceSet.

上記プロパティはGroovySourceSet型の規約オブジェクトにより提供されます。

The Groovy plugin also modifies some source set properties:

また、Groovyプラグインは、いくつかのソースセットプロパティを修正します：

The Groovy plugin adds a GroovyCompile task for each source set in the project. The task type extends the JavaCompile task (see 「CompileJavaCompileJava」). The GroovyCompile task supports most configuration options of the official Groovy compiler.

Groovyプラグインは、プロジェクトの各ソースセットにGroovyCompileタスクを追加します。このタスクはJavaCompileタスクを拡張したものです(「CompileJavaCompileJava」参照)。groovyOptions.useAntがtrueになっていなければ、GradleネイティブのGroovyコンパイラ統合が使用されます。Antベースのコンパイラを使うこともできますが、ほとんどのプロジェクトではネイティブのGroovyコンパイラを使ったほうがいいでしょう。 このGroovyCompileタスクは、公式Groovyコンパイラのオプションをほとんど全てサポートしています。