1. 简介
Gradle是一种非常流行的构建工具，其高度可定制的构建过程受到赞赏。
今天我们将展示如何创建自定义Gradle插件，这将允许我们修改构建过程，超出我们通过标准配置可以实现的范围。
2. 插件源位置
我们可以将代码放在几个不同的位置，它们各有优缺点。
2.1 构建脚本
我们可以简单地将插件的源代码放入构建脚本中，这将使我们能够自动编译和包含插件。
虽然很简单，但是我们的插件在构建脚本之外是不可见的，因此，我们无法在其他构建脚本中复用它。
2.2 BuildSrc文件夹
我们可以使用的另一种可能性是将插件的源代码放在buildSrc/src/main/java文件夹中。
当你运行Gradle时，它会检查buildSrc文件夹是否存在。如果存在，Gradle将自动构建并包含我们的插件。
这将使我们能够在各种构建脚本之间共享我们的插件，但我们仍然无法在其他项目中使用它。
2.3 独立项目
最后，我们可以将插件创建为一个单独的项目，这使得该插件在各种项目中完全可重复使用。
但是，要在外部项目中使用它，我们需要将其捆绑到jar文件中并添加到项目中。
3. 第一个插件
让我们从基础开始-每个Gradle插件都必须实现com.gradle.api.Plugin接口。
该接口是泛型的，因此我们可以使用各种参数类型对其进行参数化。通常，参数类型为org.gradle.api.Project。
但是，我们可以使用不同的类型参数，以便插件在不同的生命周期阶段应用：
- 使用org.gradle.api.Settings将导致将插件应用到设置脚本
- 使用org.gradle.api.Gradle将导致将插件应用于初始化脚本
我们可以创建的最简单的插件是一个hello world应用程序：
public class GreetingPlugin implements Plugin<Project> {
@Override
public void apply(Project project) {
project.task("hello")
.doLast(task -> System.out.println("Hello Gradle!"));
}
}
我们现在可以通过在构建脚本中添加一行来应用它：
apply plugin: GreetingPlugin
现在，调用gradle hello后，我们将在日志中看到“Hello Gradle”消息。
4. 插件配置
大多数插件都需要从构建脚本访问外部配置。
我们可以通过使用扩展对象来实现这一点：
public class GreetingPluginExtension {
private String greeter = "Tuyucheng";
private String message = "Message from the plugin!";
// standard getters and setters
}
现在让我们将新的扩展对象添加到我们的插件类中：
@Override
public void apply(Project project) {
GreetingPluginExtension extension = project.getExtensions()
.create("greeting", GreetingPluginExtension.class);
project.task("hello")
.doLast(task -> {
System.out.println("Hello, " + extension.getGreeter());
System.out.println("I have a message for You: " + extension.getMessage());
});
}
现在，当我们调用gradle hello时，我们将看到在GreetingPluginExtension中定义的默认消息。
但是由于我们已经创建了扩展，我们可以使用闭包在构建脚本中执行此操作：
greeting {
greeter = "Stranger"
message = "Message from the build script"
}
5. 独立插件项目
为了创建独立的Gradle插件，我们还需要做更多的工作。
5.1 设置
首先，我们需要导入Gradle API依赖，这非常简单：
dependencies {
compile gradleApi()
}
请注意，在Maven中执行相同操作需要gradle-tooling-api依赖-来自Gradle仓库：
<dependencies>
<dependency>
<groupId>org.gradle</groupId>
<artifactId>gradle-tooling-api</artifactId>
<version>3.0</version>
</dependency>
<dependency>
<groupId>org.gradle</groupId>
<artifactId>gradle-core</artifactId>
<version>3.0</version>
<scope>provided</scope>
</dependency>
</dependencies>
<repositories>
<repository>
<id>repo.gradle.org</id>
<url>https://repo.gradle.org/gradle/libs-releases-local/</url>
</repository>
</repositories>
5.2 织入插件
为了让Gradle找到我们的独立插件的实现，我们需要在src/main/resources/META-INF/gradle-plugins中创建属性文件。
资源文件的名称需要与插件ID匹配，例如，如果我们的插件ID是org.tuyucheng.greeting，那么资源文件的确切路径应该是META-INF/gradle-plugins/org.tuyucheng.greeting.properties。
接下来我们可以定义插件的实现类：
implementation-class=org.gradle.GreetingPlugin
实现类应该等于我们的插件类的完整包名。
5.3 创建插件ID
Gradle中插件ID必须遵循一些规则和约定，它们大部分与Java中的包名规则类似：
- 它们只能包含字母数字字符、“.”和“-”
- ID必须至少有一个“.”将域名与插件名称分开
- 命名空间org.gradle和com.gradleware受到限制
- ID不能以“.”开头或结尾。
- 不允许两个或两个以上连续的“.”字符
最后，有一个约定，即插件ID应该是遵循反向域名约定的小写名称。
Java包名称和Gradle插件名称之间的主要区别在于，包名称通常比插件ID更详细。
5.4 发布插件
当我们想要发布我们的插件以便能够在外部项目中重复使用它时，有两种方法可以实现。
首先，我们可以将插件JAR发布到外部仓库，如Maven或Ivy。
或者，我们可以使用Gradle插件门户，这将允许更广泛的Gradle社区访问我们的插件。更多关于将项目发布到Gradle仓库的信息，请参阅Gradle插件门户文档。
5.5 Java Gradle开发插件
当我们用Java编写插件时，我们可以从Java Gradle开发插件中受益。
这将自动编译并添加gradleApi()依赖，它还将在gradle jar任务中执行插件元数据验证。
我们可以通过在构建脚本中添加以下块来添加插件：
plugins {
id 'java-gradle-plugin'
}
6. 测试插件
为了测试我们的插件是否正常工作并且正确应用到项目中，我们可以使用org.gradle.testfixtures.ProjectBuilder来创建项目的实例。
然后，我们可以检查插件是否已应用，以及项目实例中是否存在正确的任务，我们可以使用标准的JUnit测试来做到这一点：
@Test
public void greetingTest(){
Project project = ProjectBuilder.builder().build();
project.getPluginManager().apply("cn.tuyucheng.taketoday.greeting");
assertTrue(project.getPluginManager()
.hasPlugin("cn.tuyucheng.taketoday.greeting"));
assertNotNull(project.getTasks().getByName("hello"));
}
7. 总结
本文介绍了在Gradle中编写自定义插件的基础知识，如需深入了解插件创建，请参阅Gradle文档。
Post Directory
