第59章 カスタムプラグインの作成

A Gradle plugin packages up reusable pieces of build logic, which can be used across many different projects and builds. Gradle allows you to implement your own custom plugins, so you can reuse your build logic, and share it with others.

Gradleプラグインは再利用可能なビルドロジックの断片をパッケージとしてまとめ、異なるプロジェクトやビルドで横断的に使えるようにします。 Gradleは独自のカスタムプラグインの実装手段を提供していますので、独自のビルドロジックを再利用し、他のユーザーと共有することができます。

You can implement a custom plugin in any language you like, provided the implementation ends up compiled as bytecode. For the examples here, we are going to use Groovy as the implementation language. You could use Java or Scala instead, if you want.

カスタムプラグインは、最終的にバイトコードへコンパイルできるなら、どんな言語でもお好みの言語で実装することができます。 このサンプルでは実装言語としてGroovyを使います。 かわりにJavaやScalaを使うこともできますので、お好きにどうぞ。

59.1. プラグインのパッケージングPackaging a plugin

There are several places where you can put the source for the plugin.

プラグインのソースを配置できる場所はいくつかあります。

ビルドスクリプトBuild script

You can include the source for the plugin directly in the build script. This has the benefit that the plugin is automatically compiled and included in the classpath of the build script without you having to do anything. However, the plugin is not visible outside the build script, and so you cannot reuse the plugin outside the build script it is defined in.

ビルドスクリプトの中にプラグインのソースを直接含めることができます。 この方法は、特になにもしなくてもプラグインが自動的にコンパイルされ、ビルドスクリプトのクラスパスに追加されるという利点があります。 しかし、プラグインはビルドスクリプトの外部から参照できないため、プラグインが定義されているビルドスクリプトの外部からは再利用できません。

buildSrcプロジェクトbuildSrc project

You can put the source for the plugin in the rootProjectDir/buildSrc/src/main/groovy directory. Gradle will take care of compiling and testing the plugin and making it available on the classpath of the build script. The plugin is visible to every build script used by the build. However, it is not visible outside the build, and so you cannot reuse the plugin outside the build it is defined in.

プラグインのソースをrootProjectDir/buildSrc/src/main/groovyディレクトリに配置できます。 Gradleがプラグインのコンパイルとテストを行い、ビルドスクリプトのクラスパスで有効になるようにしてくれます。 プラグインは、ビルドで利用されるすべてのビルドスクリプトから参照可能です。 しかし、ビルドの外部からは参照できないので、プラグインが定義されているビルドの外部から再利用することはできません。

See 60章ビルドロジックの体系化 for more details about the buildSrc project.

buildSrcプロジェクトの詳細については、60章ビルドロジックの体系化を参照してください。

スタンドアロンプロジェクトStandalone project

You can create a separate project for your plugin. This project produces and publishes a JAR which you can then use in multiple builds and share with others. Generally, this JAR might include some custom plugins, or bundle several related task classes into a single library. Or some combination of the two.

プラグイン用に独立したプロジェクトを作ることができます。 このプロジェクトはJARを生成して発行するので、複数のビルドで利用したり、他のユーザーと共有することができます。 一般的に、このJARはカスタムプラグイン、ないしは関連するいくつかのタスククラスのバンドルする場合があります。 あるいは、その両方の組み合わせです。

In our examples, we will start with the plugin in the build script, to keep things simple. Then we will look at creating a standalone project.

このサンプルでは、簡単のためにビルドスクリプト内のプラグインからはじめます。 その後、スタンドアロンプロジェクトの作り方をみてみましょう。

59.2. シンプルなプラグインの作成Writing a simple plugin

To create a custom plugin, you need to write an implementation of Plugin. Gradle instantiates the plugin and calls the plugin instance's Plugin.apply() method when the plugin is used with a project. The project object is passed as a parameter, which the plugin can use to configure the project however it needs to. The following sample contains a greeting plugin, which adds a hello task to the project.

カスタムプラグインを作るには、Pluginの実装を作成する必要があります。 Gradleはプラグインのインスタンスを生成し、プロジェクトでプラグインが利用されるときにプラグインインスタンスのPlugin.apply()メソッドを呼びます。 プロジェクトオブジェクトがパラメータとして渡され、必要に応じてプラグインがプロジェクトを構成するのに使えます。 次のサンプルは、プロジェクトにhelloタスクを追加するgreetingプラグインを含んでいます。

例59.1 カスタムプラグイン

build.gradle

apply plugin: GreetingPlugin

class GreetingPlugin implements Plugin<Project> {
    void apply(Project project) {
        project.task('hello') << {
            println "Hello from the GreetingPlugin"
        }
    }
}

gradle -q hello の出力

> gradle -q hello
Hello from the GreetingPlugin

One thing to note is that a new instance of a given plugin is created for each project it is applied to. Also note that the Plugin class is a generic type. This example has it receiving the Plugin type as a type parameter. It's possible to write unusual custom plugins that take different type parameters, but this will be unlikely (until someone figures out more creative things to do here).

注意すべきは、指定されたプラグインが適用されるプロジェクト毎に、新しいプラグインのインスタンスが生成されることです。Also note that the Plugin class is a generic type. This example has it receiving the Plugin type as a type parameter. It's possible to write unusual custom plugins that take different type parameters, but this will be unlikely (until someone figures out more creative things to do here).

59.3. ビルドから入力を得るGetting input from the build

Let's add a simple extension object to the project. Here we add a greeting extension object to the project, which allows you to configure the greeting.

プロジェクトにシンプルなextensionオブジェクトを追加してみましょう ここでは、プロジェクトにextensionオブジェクトgreetingを追加し、greetingタスクを構成可能にしています。

例59.2 カスタムプラグインのextension

build.gradle

apply plugin: GreetingPlugin

greeting.message = 'Hi from Gradle'

class GreetingPlugin implements Plugin<Project> {
    void apply(Project project) {
        // Add the 'greeting' extension object
        project.extensions.create("greeting", GreetingPluginExtension)
        // Add a task that uses the configuration
        project.task('hello') << {
            println project.greeting.message
        }
    }
}

class GreetingPluginExtension {
    def String message = 'Hello from GreetingPlugin'
}

gradle -q hello の出力

> gradle -q hello
Hi from Gradle

In this example, GreetingPluginExtension is a plain old Groovy object with a field called message. The extension object is added to the plugin list with the name greeting. This object then becomes available as a project property with the same name as the extension object.

この例では、GreetingPluginExtensionmessageフィールドを持つPOGO(plain old Groovy object)です。 extensionオブジェクトはgreetingという名前でプラグインリストに追加されます。 このオブジェクトは、extensionオブジェクトと同じ名前のプロジェクトプロパティとして有効になります。

Oftentimes, you have several related properties you need to specify on a single plugin. Gradle adds a configuration closure block for each extension object, so you can group settings together. The following example shows you how this works.

しばしば、ひとつのプラグインに対していくつかの関連したプロパティを指定する必要がある場合があります。 Gradleはそれぞれのextensionオブジェクトに対してコンフィグレーションクロージャブロックを追加するので、 グループの設定をまとめて行うことができます。 次のサンプルは、これがどのように働くのかを示しています。

例59.3 コンフィグレーションクロージャ付きのカスタムプラグイン

build.gradle

apply plugin: GreetingPlugin

greeting {
    message = 'Hi'
    greeter = 'Gradle'
}

class GreetingPlugin implements Plugin<Project> {
    void apply(Project project) {
        project.extensions.create("greeting", GreetingPluginExtension)
        project.task('hello') << {
            println "${project.greeting.message} from ${project.greeting.greeter}"
        }
    }
}

class GreetingPluginExtension {
    String message
    String greeter
}

gradle -q hello の出力

> gradle -q hello
Hi from Gradle

In this example, several settings can be grouped together within the greeting closure. The name of the closure block in the build script (greeting) needs to match the extension object name. Then, when the closure is executed, the fields on the extension object will be mapped to the variables within the closure based on the standard Groovy closure delegate feature.

この例では、greetingクロージャ内にいくつかの設定をグループ化してまとめることができています。 ビルドスクリプトにおけるクロージャブロックの名前(greeting)は、extensionオブジェクトの名前と一致している必要があります。 そして、クロージャが実行されると、Groovyの標準のクロージャ委譲機能に基づいて、extensionオブジェクトのフィールドはクロージャ内の変数にマップされます。

59.4. カスタムタスクやプラグインでファイルを扱うWorking with files in custom tasks and plugins

When developing custom tasks and plugins, it's a good idea to be very flexible when accepting input configuration for file locations. To do this, you can leverage the Project.file() method to resolve values to files as late as possible.

カスタムタスクやプラグインを開発するとき、ファイルロケーションの入力コンフィグレーションを柔軟に行えるようにするのは良いアイデアです。 これを実現するにあたり、ファイルに対する値の解決をなるべく遅らせるためにProject.file()メソッドを活用できます

例59.4 ファイルプロパティの遅延評価

build.gradle

class GreetingToFileTask extends DefaultTask {

    def destination

    File getDestination() {
        project.file(destination)
    }

    @TaskAction
    def greet() {
        def file = getDestination()
        file.parentFile.mkdirs()
        file.write "Hello!"
    }
}

task greet(type: GreetingToFileTask) {
    destination = { project.greetingFile }
}

task sayGreeting(dependsOn: greet) << {
    println file(greetingFile).text
}

ext.greetingFile = "$buildDir/hello.txt"

gradle -q sayGreeting の出力

> gradle -q sayGreeting
Hello!

In this example, we configure the greet task destination property as a closure, which is evaluated with the Project.file() method to turn the return value of the closure into a file object at the last minute. You will notice that in the example above we specify the greetingFile property value after we have configured to use it for the task. This kind of lazy evaluation is a key benefit of accepting any value when setting a file property, then resolving that value when reading the property.

この例では、greetタスクのdestinationプロパティをクロージャで定義したので、 クロージャの戻り値をfileオブジェクトに変換することが必要になる直前にProject.file()メソッドによって評価されます。 上記のサンプルでは、タスクで値を利用するコンフィグレーションを行った後でgreetingFileプロパティの値を指定していることに気づくでしょう。 この種の遅延評価は、ファイルプロパティを設定する際に任意の値を受け入れ、そしてプロパティの読み出し時に値を解決することができるという重要なメリットをもたらします。

59.5. スタンドアロンプロジェクトA standalone project

Now we will move our plugin to a standalone project, so we can publish it and share it with others. This project is simply a Groovy project that produces a JAR containing the plugin classes. Here is a simple build script for the project. It applies the Groovy plugin, and adds the Gradle API as a compile-time dependency.

それでは、プラグインをスタンドアロンプロジェクトに移動して、発行して他のユーザーと共有できるようにしましょう。 このプロジェクトは、プラグインクラスを含むJARを発行する単なるGroovyプロジェクトです。 プロジェクトに対するシンプルなビルドスクリプトはこのようになります。 Groovyプラグインを適用して、コンパイル時の依存関係としてGradle APIを追加しています。

例59.5 カスタムプラグインに対するビルド

build.gradle

apply plugin: 'groovy'

dependencies {
    compile gradleApi()
    compile localGroovy()
}

ノート: 本例のソースコードは、Gradleのバイナリ配布物またはソース配布物に含まれています。以下の場所をご参照ください。samples/customPlugin/plugin


So how does Gradle find the Plugin implementation? The answer is you need to provide a properties file in the jar's META-INF/gradle-plugins directory that matches the id of your plugin.

GradleはどのようにしてPluginの実装を探すのでしょうか? その答えは、JARのMETA-INF/gradle-pluginsディレクトリに、 プラグインのIDに対応するプロパティファイルを提供する必要があるということです。

例59.6 カスタムプラグインに対するワイヤリング

src/main/resources/META-INF/gradle-plugins/org.samples.greeting.properties

implementation-class=org.gradle.GreetingPlugin

Notice that the properties filename matches the plugin id and is placed in the resources folder, and that the implementation-class property identifies the Plugin implementation class.

プロパティファイルの名前がプラグインIDと一致していてリソースフォルダに配置されていること、 implementation-classプロパティにPluginの実装クラスを指定していることに注意してください。

59.5.1. Creating a plugin id

Plugin ids are fully qualified in a manner similar to Java packages (i.e. a reverse domain name). This helps to avoid collisions and provides a way to group plugins with similar ownership.

Your plugin id should be a combination of components that reflect namespace (a reasonable pointer to you or your organization) and the name of the plugin it provides. For example if you had a Github account named “foo” and your plugin was named “bar”, a suitable plugin id might be com.github.foo.bar. Similarly, if the plugin was developed at the baz organization, the plugin id might be org.baz.bar.

Plugin ids should conform to the following:

  • May contain any alphanumeric character, '.', and '-'.
  • Must contain at least one '.' character separating the namespace from the name of the plugin.
  • Conventionally use a lowercase reverse domain name convention for the namespace.
  • Conventionally use only lowercase characters in the name.
  • org.gradle and com.gradleware namespaces may not be used.
  • Cannot start or end with a '.' character.
  • Cannot contain consecutive '.' characters (i.e. '..').

Although there are conventional similarities between plugin ids and package names, package names are generally more detailed than is necessary for a plugin id. For instance, it might seem reasonable to add “gradle” as a component of your plugin id, but since plugin ids are only used for Gradle plugins, this would be superfluous. Generally, a namespace that identifies ownership and a name are all that are needed for a good plugin id.

59.5.2. Publishing your plugin

If you are publishing your plugin internally for use within your organization, you can publish it like any other code artifact. See the ivy and maven chapters on publishing artifacts.

If you are interested in publishing your plugin to be used by the wider Gradle community, you can publish it to the Gradle plugin portal. This site provides the ability to search for and gather information about plugins contributed by the Gradle community. See the instructions here on how to make your plugin available on this site.

59.5.3. 別のプロジェクトでプラグインを使うUsing your plugin in another project

To use a plugin in a build script, you need to add the plugin classes to the build script's classpath. To do this, you use a “buildscript { }” block, as described in 「ビルドスクリプトで外部ライブラリを使うときの依存関係設定External dependencies for the build script. The following example shows how you might do this when the JAR containing the plugin has been published to a local repository:

ビルドスクリプトでプラグインを使うためには、ビルドスクリプトのクラスパスにプラグインクラスを追加する必要があります。 このために、「ビルドスクリプトで外部ライブラリを使うときの依存関係設定External dependencies for the build scriptで説明したように、buildscript { }ブロックが使えます 次のサンプルは、プラグインを含むJARがローカルリポジトリに発行済みのときにこれを行う方法を示しています:

例59.7 別のプロジェクトでカスタムプラグインを使う

build.gradle

buildscript {
    repositories {
        maven {
            url uri('../repo')
        }
    }
    dependencies {
        classpath group: 'org.gradle', name: 'customPlugin',
                  version: '1.0-SNAPSHOT'
    }
}
apply plugin: 'org.samples.greeting'

Alternatively, if your plugin is published to the plugin portal, you can use the incubating plugins DSL (see 「Applying plugins with the plugins DSL」) to apply the plugin:

例59.8 Applying a community plugin with the plugins DSL

build.gradle

plugins {
    id "com.jfrog.bintray" version "0.4.1"
}

59.5.4. プラグインに対するテストの作成Writing tests for your plugin

You can use the ProjectBuilder class to create Project instances to use when you test your plugin implementation.

プラグイン実装をテストするときには、Projectインスタンスを生成するために ProjectBuilderクラスが利用できます。

例59.9 カスタムプラグインのテスト

src/test/groovy/org/gradle/GreetingPluginTest.groovy

class GreetingPluginTest {
    @Test
    public void greeterPluginAddsGreetingTaskToProject() {
        Project project = ProjectBuilder.builder().build()
        project.apply plugin: 'org.samples.greeting'

        assertTrue(project.tasks.hello instanceof GreetingTask)
    }
}

59.5.5. Using the Java Gradle Plugin development plugin

You can use the incubating Java Gradle Plugin development plugin to eliminate some of the boilerplate declarations in your build script and provide some basic validations of plugin metadata. This plugin will automatically apply the Java plugin, add the gradleApi() dependency to the compile configuration, and perform plugin metadata validations as part of the jar task execution.

例59.10 Using the Java Gradle Plugin Development plugin

build.gradle

apply plugin: 'java-gradle-plugin'

59.6. 複数のドメインオブジェクトの管理Maintaining multiple domain objects

Gradle provides some utility classes for maintaining collections of objects, which work well with the Gradle build language.

Gradleはオブジェクトのコレクションを管理するためのユーティリティクラスを提供しており、それらはGradleビルド言語の中で活用できます。

例59.11 ドメインオブジェクトの管理

build.gradle

apply plugin: DocumentationPlugin

books {
    quickStart {
        sourceFile = file('src/docs/quick-start')
    }
    userGuide {

    }
    developerGuide {

    }
}

task books << {
    books.each { book ->
        println "$book.name -> $book.sourceFile"
    }
}

class DocumentationPlugin implements Plugin<Project> {
    void apply(Project project) {
        def books = project.container(Book)
        books.all {
            sourceFile = project.file("src/docs/$name")
        }
        project.extensions.books = books
    }
}

class Book {
    final String name
    File sourceFile

    Book(String name) {
        this.name = name
    }
}

gradle -q books の出力

> gradle -q books
developerGuide -> /home/user/gradle/samples/userguide/organizeBuildLogic/customPluginWithDomainObjectContainer/src/docs/developerGuide
quickStart -> /home/user/gradle/samples/userguide/organizeBuildLogic/customPluginWithDomainObjectContainer/src/docs/quick-start
userGuide -> /home/user/gradle/samples/userguide/organizeBuildLogic/customPluginWithDomainObjectContainer/src/docs/userGuide

The Project.container() methods create instances of NamedDomainObjectContainer, that have many useful methods for managing and configuring the objects. In order to use a type with any of the project.container methods, it MUST expose a property named “name” as the unique, and constant, name for the object. The project.container(Class) variant of the container method creates new instances by attempting to invoke the constructor of the class that takes a single string argument, which is the desired name of the object. See the above link for project.container method variants that allow custom instantiation strategies.

Project.container()メソッドは、 オブジェクトの管理やコンフィグレーションに便利な多くのメソッドを提供する NamedDomainObjectContainerのインスタンスを生成します。 project.containerのメソッドでタイプを扱うためには、 オブジェクトのユニークかつ固定の名前を提供する“name”プロパティを公開しなければなりません。 project.container(Class)メソッドおよびそのバリエーションは、 単一のstringを引数として取るクラスのコンストラクタの実行を試みることで新しいインスタンスを生成します。 このとき、引数はオブジェクトの名前となることが期待されます。 カスタムのインスタンス化戦略を可能にするproject.containerメソッドのバリエーションについては、上記のリンクを参照してください。