第61章 初期化スクリプト

Initialization scripts (a.k.a. init scripts) are similar to other scripts in Gradle. These scripts, however, are run before the build starts. Here are several possible uses: 初期化スクリプト(init scripts)は、Gradleで使う他のスクリプトと似たものですが、ビルドの開始前に実行されます。使用する場面としては次のようなものがあります。

One main limitation of init scripts is that they cannot access classes in the buildSrc project (see 「buildSrcプロジェクトのソースをビルドするBuild sources in the buildSrc project」 for details of this feature). 初期化スクリプトの主な制限は、buildSrcプロジェクトにアクセスできないことです（この機能の詳細は「buildSrcプロジェクトのソースをビルドするBuild sources in the buildSrc project」を参照してください）。

There are several ways to use an init script:

初期化スクリプトを使うには、いくつかの方法があります。

If more than one init script is found they will all be executed, in the order specified above. Scripts in a given directory are executed in alphabetical order. This allows, for example, a tool to specify an init script on the command line and the user to put one in their home directory for defining the environment and both scripts will run when Gradle is executed.

複数の初期化スクリプトが見つかった場合、そのすべてが上で記載した順番で実行されます。同じディレクトリのスクリプトはアルファベット順に実行されます。これにより、たとえば、ツールがコマンドラインで初期化スクリプトを指定し、ユーザーはホームディレクトリに環境設定のためのスクリプトを置いて、ビルド時にその両方を実行する、といったことが可能です。

Similar to a Gradle build script, an init script is a Groovy script. Each init script has a Gradle instance associated with it. Any property reference and method call in the init script will delegate to this Gradle instance.

Gradleのビルドスクリプトと同様、初期化スクリプトもGroovyスクリプトです。すべての初期化スクリプトにGradleのインスタンスが割り当てられ、初期化スクリプト内でのプロパティアクセス、メソッドコールはすべてこのGradleインスタンスに委譲されます。

Each init script also implements the Script interface.

また、すべての初期化スクリプトはScriptインターフェースを実装しています。

repositories {
    mavenCentral()
}

task showRepos << {
    println "All repos:"
    println repositories.collect { it.name }
}

allprojects {
    repositories {
        mavenLocal()
    }
}

> gradle --init-script init.gradle -q showRepos
All repos:
[MavenLocal, MavenRepo]

In 「ビルドスクリプトで外部ライブラリを使うときの依存関係設定External dependencies for the build script」 it is was explained how to add external dependencies to a build script. Init scripts can also declare dependencies. You do this with the initscript() method, passing in a closure which declares the init script classpath.

「ビルドスクリプトで外部ライブラリを使うときの依存関係設定External dependencies for the build script」でビルドスクリプトに依存関係を追加する方法が解説されていますが、初期化スクリプトでも似たような方法で依存関係を定義できます。初期化スクリプトに依存関係を追加するには、initscript()メソッドに初期化スクリプトのクラスパスを宣言したクロージャを引き渡してください。

initscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath group: 'org.apache.commons', name: 'commons-math', version: '2.0'
    }
}

The closure passed to the initscript() method configures a ScriptHandler instance. You declare the init script classpath by adding dependencies to the classpath configuration. This is the same way you declare, for example, the Java compilation classpath. You can use any of the dependency types described in 「依存関係の定義方法 How to declare your dependencies」, except project dependencies.

initscript()に渡したクロージャは、ScriptHandlerインスタンスを設定します。これは、たとえば、Javaのコンパイルクラスパスを宣言するのと同じ方法です。「依存関係の定義方法 How to declare your dependencies」に載っている依存関係は、プロジェクト依存関係を除いてすべて使うことができます。

Having declared the init script classpath, you can use the classes in your init script as you would any other classes on the classpath. The following example adds to the previous example, and uses classes from the init script classpath.

このようにして初期化スクリプトのクラスパスを宣言すれば、初期化スクリプト内でどんなクラスでもインポートできます。次の例では、前の例に加えて、クラスパスからクラスをインポートして使用しています。

import org.apache.commons.math.fraction.Fraction

initscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath group: 'org.apache.commons', name: 'commons-math', version: '2.0'
    }
}

println Fraction.ONE_FIFTH.multiply(2)

> gradle --init-script init.gradle -q doNothing
2 / 5

Similar to a Gradle build script or a Gradle settings file, plugins can be applied on init scripts.

apply plugin:EnterpriseRepositoryPlugin

class EnterpriseRepositoryPlugin implements Plugin<Gradle> {

    private static String ENTERPRISE_REPOSITORY_URL = "https://repo.gradle.org/gradle/repo"

    void apply(Gradle gradle) {
        // ONLY USE ENTERPRISE REPO FOR DEPENDENCIES
        gradle.allprojects{ project ->
            project.repositories {

                // Remove all repositories not pointing to the enterprise repository url
                all { ArtifactRepository repo ->
                    if (!(repo instanceof MavenArtifactRepository) ||
                          repo.url.toString() != ENTERPRISE_REPOSITORY_URL) {
                        project.logger.lifecycle "Repository ${repo.url} removed. Only $ENTERPRISE_REPOSITORY_URL is allowed"
                        remove repo
                    }
                }

                // add the enterprise repository
                maven {
                    name "STANDARD_ENTERPRISE_REPO"
                    url ENTERPRISE_REPOSITORY_URL
                }
            }
        }
    }
}

repositories{
    mavenCentral()
}

 task showRepositories << {
    repositories.each{
        println "repository: ${it.name} ('${it.url}')"
    }
}

> gradle -q -I init.gradle showRepositories
repository: STANDARD_ENTERPRISE_REPO ('https://repo.gradle.org/gradle/repo')

The plugin in the init script ensures that only a specified repository is used when running the build.

When applying plugins within the init script, Gradle instantiates the plugin and calls the plugin instance's Plugin.apply() method. The gradle object is passed as a parameter, which can be used to configure all aspects of a build. Of course, the applied plugin can be resolved as an external dependency as described in 「初期化スクリプトの外部依存関係External dependencies for the init script」