Gradle 插件开发笔记01

[toc]

由于工作原因，需要进行 gradle 的插件开发，因此参考官方文档记录开发 gradle 插件的过程。

你可以使用 Java、Groovy、Kotlin 等语言来实现 Gradle 插件，前提是该实现最终被编译为 JVM 字节码。通常情况下使用静态类型的 Java 或 Kotlin 实现的插件比使用 Groovy 实现的插件性能更好。

这里主要记录在一个独立项目中进行插件的开发，方便开发完成后团队其它成员使用。

创建一个单独的插件

GreetingPlugin

public class GreetingPlugin implements Plugin<Project> {
    private Project project;
    private TaskContainer taskContainer;
    @Override
    public void apply(Project target) {
        this.project = target;
        this.taskContainer = project.getTasks();
        createHelloTask();
    }
    private void createHelloTask() {
        project.afterEvaluate(new Action<Project>() {
            @Override
            public void execute(Project project) {
                TaskProvider<GreetingTask> hello = taskContainer.register("hello", GreetingTask.class);
                hello.get().dependsOn("test").setGroup(JavaBasePlugin.VERIFICATION_GROUP);
            }
        });
    }
}

插件可配置化

大多数插件为构建脚本和其他插件提供了一些配置选项，用于自定义插件的工作方式。Gradle Project有一个关联的 ExtensionContainer 对象，其中包含已应用于项目的插件的所有设置和属性。你可以通过向此容器添加扩展对象来为你的插件提供配置。扩展对象只是一个具有代表配置的 Java Bean 属性的对象。

GreetingPluginExtension

public abstract class GreetingPluginExtension {
    public abstract Property<String> getMessage();
    GreetingPluginExtension() {
        getMessage().convention("Hello from GreetingPlugin");
    }
}

GreetingPlugin

public class GreetingPlugin implements Plugin<Project> {
    private Project project;
    private TaskContainer taskContainer;
    @Override
    public void apply(Project target) {
        this.project = target;
        this.taskContainer = project.getTasks();
        createHelloTask();
    }
    private void createHelloTask() {
        GreetingPluginExtension greeting = project.getExtensions().create("greeting", GreetingPluginExtension.class);
        project.task("hello").doFirst(task -> System.out.println(greeting.getMessage().get()));
    }
}

在此示例中，GreetingPluginExtension 是一个具有名为 message 的属性的对象。扩展对象被添加到项目中，名称为greeting。然后，此对象可用作与扩展对象同名的项目属性。

通常，您需要在单个插件上指定多个相关属性。 Gradle 为每个扩展对象添加了一个配置块，因此您可以将设置组合在一起。以下示例向您展示了这是如何工作的。

interface GreetingPluginExtension {
    Property<String> getMessage()
    Property<String> getGreeter()
}
class GreetingPlugin implements Plugin<Project> {
    void apply(Project project) {
        def extension = project.extensions.create('greeting', GreetingPluginExtension)
        project.task('hello') {
            doLast {
                println "${extension.message.get()} from ${extension.greeter.get()}"
            }
        }
    }
}
apply plugin: GreetingPlugin
// Configure the extension using a DSL block
greeting {
    message = 'Hi'
    greeter = 'Gradle'
}

在此示例中，可以在问候语闭包中将多个设置组合在一起。构建脚本（greeting）中的闭包块的名称需要与扩展对象名称相匹配。然后，当执行闭包时，扩展对象上的字段将根据标准 Groovy 闭包委托功能映射到闭包内的变量。

这样，使用扩展对象扩展了 Gradle DSL 来为插件添加项目属性和 DSL 块。并且因为扩展对象只是一个常规对象，您可以通过向扩展对象添加属性和方法来提供嵌套在插件块中的自己的 DSL

开发项目扩展

您可以在开发自定义 Gradle 类型中找到更多关于实现项目扩展的信息。

使用自定义任务和插件中的文件

在开发自定义任务和插件时，在接受文件位置的输入配置时非常灵活是一个好主意。您应该使用 Gradle 的托管属性和 project.layout 来选择文件或目录位置。这样，实际位置只会在需要文件时解析，并且可以在构建配置期间随时重新配置。

abstract class GreetingToFileTask extends DefaultTask {
    @OutputFile
    abstract RegularFileProperty getDestination()
    @TaskAction
    def greet() {
        def file = getDestination().get().asFile
        file.parentFile.mkdirs()
        file.write 'Hello!'
    }
}
def greetingFile = objects.fileProperty()
tasks.register('greet', GreetingToFileTask) {
    destination = greetingFile
}
tasks.register('sayGreeting') {
    dependsOn greet
    doLast {
        def file = greetingFile.get().asFile
        println "${file.text} (file: ${file.name})"
    }
}
greetingFile.set(layout.buildDirectory.file('hello.txt'))