Gradle 附带了一套强大的核心系统，例如依赖管理、任务执行和项目配置。但它能做的其他一切都由插件提供。

插件封装了特定任务或集成的逻辑，例如编译代码、运行测试或部署 artifacts。通过应用插件，用户可以轻松地为构建过程添加新功能，而无需从头编写复杂的代码。

这种基于插件的方法使 Gradle 轻量且模块化。它还促进了代码重用和可维护性，因为插件可以在项目之间或组织内部共享。

在阅读本章之前，建议您先阅读学习基础知识并完成教程。

插件简介

插件可以来自 Gradle 或 Gradle 社区。但是，当用户想要组织他们的构建逻辑或需要现有插件未提供的特定构建功能时，他们可以自行开发插件。

因此，我们将插件分为以下三类：

  1. 核心插件 - 来自 Gradle 的插件。

  2. 社区插件 - 来自Gradle 插件门户或公共仓库的插件。

  3. 本地或自定义插件 - 您自行开发的插件。

核心插件

术语核心插件指代 Gradle 分发版中的插件，例如Java 库插件。它们始终可用。

社区插件

术语社区插件指代发布到 Gradle 插件门户（或其他公共仓库）的插件，例如Spotless 插件。

本地或自定义插件

术语本地或自定义插件指代您为自己的构建编写的插件。

自定义插件

自定义插件有三种类型：

# 类型 位置 最可能 优点

1

脚本插件

一个 .gradle(.kts) 脚本文件

本地插件

插件会自动编译并包含在构建脚本的 classpath 中。

2

预编译脚本插件

buildSrc 文件夹或复合构建

约定插件

插件会自动编译、测试，并可在构建脚本的 classpath 中使用。该插件对构建使用的每个构建脚本都可见。

3

二进制插件

独立项目

共享插件

生成并发布插件 JAR。该插件可在多个构建中使用，并与其他人共享。

脚本插件

脚本插件通常是小型本地插件，编写在脚本文件中，用于特定于单个构建或项目的任务。它们不需要在多个项目之间重用。不建议使用脚本插件，但许多其他形式的插件都从脚本插件演变而来。

要创建插件，您需要编写一个实现 Plugin 接口的类。

以下示例创建一个 GreetingPlugin，它在应用时会向项目添加一个 hello 任务

build.gradle.kts
class GreetingPlugin : Plugin<Project> {
    override fun apply(project: Project) {
        project.task("hello") {
            doLast {
                println("Hello from the GreetingPlugin")
            }
        }
    }
}

// Apply the plugin
apply<GreetingPlugin>()
build.gradle
class GreetingPlugin implements Plugin<Project> {
    void apply(Project project) {
        project.task('hello') {
            doLast {
                println 'Hello from the GreetingPlugin'
            }
        }
    }
}

// Apply the plugin
apply plugin: GreetingPlugin
$ gradle -q hello
Hello from the GreetingPlugin

Project 对象作为参数传递给 apply() 方法，插件可以使用它来根据需要配置项目（例如添加任务、配置依赖项等）。在此示例中，插件直接编写在构建文件中，这不是推荐的做法。

当插件编写在单独的脚本文件中时，可以使用 apply(from = "file_name.gradle.kts") 或 apply from: 'file_name.gradle' 应用。在下面的示例中，插件代码写在 other.gradle(.kts) 脚本文件中。然后，使用 apply from 将 other.gradle(.kts) 应用到 build.gradle(.kts) 中。

other.gradle.kts
class GreetingScriptPlugin : Plugin<Project> {
    override fun apply(project: Project) {
        project.task("hi") {
            doLast {
                println("Hi from the GreetingScriptPlugin")
            }
        }
    }
}

// Apply the plugin
apply<GreetingScriptPlugin>()
other.gradle
class GreetingScriptPlugin implements Plugin<Project> {
    void apply(Project project) {
        project.task('hi') {
            doLast {
                println 'Hi from the GreetingScriptPlugin'
            }
        }
    }
}

// Apply the plugin
apply plugin: GreetingScriptPlugin
build.gradle.kts
apply(from = "other.gradle.kts")
build.gradle
apply from: 'other.gradle'
$ gradle -q hi
Hi from the GreetingScriptPlugin

应避免使用脚本插件。

预编译脚本插件

预编译脚本插件在执行之前被编译成类文件并打包成 JAR。这些插件使用 Groovy DSL 或 Kotlin DSL，而不是纯 Java、Kotlin 或 Groovy。它们最适合用作在项目之间共享构建逻辑的约定插件，或者作为一种整洁地组织构建逻辑的方式。

要创建预编译脚本插件，您可以：

  1. 使用 Gradle 的 Kotlin DSL - 插件是 .gradle.kts 文件，并应用 kotlin-dsl。

  2. 使用 Gradle 的 Groovy DSL - 插件是 .gradle 文件，并应用 id("groovy-gradle-plugin")。

要应用预编译脚本插件，您需要知道其 ID。该 ID 源自插件脚本的文件名及其（可选的）包声明。

例如，脚本 src/main/*/some-java-library.gradle(.kts) 的插件 ID 为 some-java-library（假设没有包声明）。同样，src/main/*/my/some-java-library.gradle(.kts) 的插件 ID 为 my.some-java-library，前提是它有一个 my 的包声明。

预编译脚本插件名称有两个重要限制：

  • 不能以 org.gradle 开头。

  • 不能与核心插件同名。

当插件应用到项目时，Gradle 会创建一个插件类的实例，并调用该实例的 Plugin.apply() 方法。

在应用该插件的每个项目内都会创建一个新的 Plugin 实例。

让我们将 GreetingPlugin 脚本插件重写为预编译脚本插件。由于我们使用 Groovy 或 Kotlin DSL，该文件本质上就变成了插件。原始脚本插件只是创建了一个打印问候语的 hello 任务，这就是我们在预编译脚本插件中要做的。

buildSrc/src/main/kotlin/GreetingPlugin.gradle.kts
tasks.register("hello") {
    doLast {
        println("Hello from the convention GreetingPlugin")
    }
}
buildSrc/src/main/groovy/GreetingPlugin.gradle
tasks.register("hello") {
    doLast {
        println("Hello from the convention GreetingPlugin")
    }
}

现在可以使用其 ID 在其他子项目的构建中应用 GreetingPlugin

app/build.gradle.kts
plugins {
    application
    id("GreetingPlugin")
}
app/build.gradle
plugins {
    id 'application'
    id('GreetingPlugin')
}
$ gradle -q hello
Hello from the convention GreetingPlugin

约定插件

约定插件通常是一种预编译脚本插件，它使用您自己的约定（即默认值）来配置现有的核心插件和社区插件，例如使用 java.toolchain.languageVersion = JavaLanguageVersion.of(17) 设置 Java 版本。约定插件还用于强制执行项目标准并帮助简化构建过程。它们可以应用和配置插件、创建新任务和扩展、设置依赖项等等。

让我们来看一个包含三个子项目的示例构建：一个用于 data-model，一个用于 database-logic，一个用于 app 代码。项目结构如下：

.
├── buildSrc
│   ├── src
│   │   └──...
│   └── build.gradle.kts
├── data-model
│   ├── src
│   │   └──...
│   └── build.gradle.kts
├── database-logic
│   ├── src
│   │   └──...
│   └── build.gradle.kts
├── app
│   ├── src
│   │   └──...
│   └── build.gradle.kts
└── settings.gradle.kts

database-logic 子项目的构建文件如下：

database-logic/build.gradle.kts
plugins {
    id("java-library")
    id("org.jetbrains.kotlin.jvm") version "2.0.21"
}

repositories {
    mavenCentral()
}

java {
    toolchain.languageVersion.set(JavaLanguageVersion.of(11))
}

tasks.test {
    useJUnitPlatform()
}

kotlin {
    jvmToolchain(11)
}

// More build logic
database-logic/build.gradle
plugins {
    id 'java-library'
    id 'org.jetbrains.kotlin.jvm' version '2.0.21'
}

repositories {
    mavenCentral()
}

java {
    toolchain.languageVersion.set(JavaLanguageVersion.of(11))
}

tasks.test {
    useJUnitPlatform()
}

kotlin {
    jvmToolchain {
        languageVersion.set(JavaLanguageVersion.of(11))
    }
}

// More build logic

我们应用 java-library 插件并添加 org.jetbrains.kotlin.jvm 插件以支持 Kotlin。我们还配置了 Kotlin、Java、测试等。

我们的构建文件开始变得越来越大…​

我们应用的插件越多，配置的插件越多，它就越大。app 和 data-model 子项目的构建文件中也存在重复，尤其是在配置公共扩展（如设置 Java 版本和 Kotlin 支持）时。

为了解决这个问题，我们使用约定插件。这使我们能够避免在每个构建文件中重复配置，并使我们的构建脚本更加简洁和可维护。在约定插件中，我们可以封装任意构建配置或自定义构建逻辑。

要开发约定插件，我们建议使用buildSrc——它代表一个完全独立的 Gradle 构建。buildSrc 有自己的 settings 文件来定义此构建的依赖项位于何处。

我们在 buildSrc/src/main/kotlin 目录中添加一个名为 my-java-library.gradle.kts 的 Kotlin 脚本。或者，在 buildSrc/src/main/groovy 目录中添加一个名为 my-java-library.gradle 的 Groovy 脚本。我们将 database-logic 构建文件中的所有插件应用和配置放入其中。

buildSrc/src/main/kotlin/my-java-library.gradle.kts
plugins {
    id("java-library")
    id("org.jetbrains.kotlin.jvm")
}

repositories {
    mavenCentral()
}

java {
    toolchain.languageVersion.set(JavaLanguageVersion.of(11))
}

tasks.test {
    useJUnitPlatform()
}

kotlin {
    jvmToolchain(11)
}
buildSrc/src/main/groovy/my-java-library.gradle
plugins {
    id 'java-library'
    id 'org.jetbrains.kotlin.jvm'
}

repositories {
    mavenCentral()
}

java {
    toolchain.languageVersion.set(JavaLanguageVersion.of(11))
}

tasks.test {
    useJUnitPlatform()
}

kotlin {
    jvmToolchain {
        languageVersion.set(JavaLanguageVersion.of(11))
    }
}

文件名 my-java-library 是我们全新的插件的 ID，现在我们可以在所有子项目中使用它。

为什么缺少 id 'org.jetbrains.kotlin.jvm' 的版本？请参阅将外部插件应用于预编译脚本插件。

通过移除所有冗余的构建逻辑并应用我们的约定 my-java-library 插件，database-logic 构建文件变得更加简洁。

database-logic/build.gradle.kts
plugins {
    id("my-java-library")
}
database-logic/build.gradle
plugins {
    id('my-java-library')
}

这个约定插件使我们能够轻松地在所有构建文件中共享通用配置。任何修改都可以在一处完成，简化了维护。

二进制插件

Gradle 中的二进制插件是构建为独立 JAR 文件并使用构建脚本中的 plugins{} 块应用到项目的插件。

让我们将 GreetingPlugin 移到一个独立的项目中，以便我们可以发布它并与他人共享。该插件实质上是从 buildSrc 文件夹移到了一个名为 greeting-plugin 的单独构建中。

您可以从 buildSrc 发布插件，但这并不是推荐的做法。准备好发布的插件应该放在它们自己的构建中。

greeting-plugin 只是一个生成包含插件类的 JAR 的 Java 项目。

将插件打包并发布到仓库的最简单方法是使用Gradle 插件开发插件。此插件提供了必要的任务和配置（包括插件元数据），可以将您的脚本编译成可以在其他构建中应用的插件。

这是使用 Gradle 插件开发插件的 greeting-plugin 项目的简单构建脚本：

build.gradle.kts
plugins {
    `java-gradle-plugin`
}

gradlePlugin {
    plugins {
        create("simplePlugin") {
            id = "org.example.greeting"
            implementationClass = "org.example.GreetingPlugin"
        }
    }
}
build.gradle
plugins {
    id 'java-gradle-plugin'
}

gradlePlugin {
    plugins {
        simplePlugin {
            id = 'org.example.greeting'
            implementationClass = 'org.example.GreetingPlugin'
        }
    }
}

有关发布插件的更多信息，请参阅发布插件。

项目插件 vs Settings 插件 vs 初始化插件

在本节使用的示例中，插件接受 Project 类型作为类型参数。或者，插件可以接受 Settings 类型的参数以应用于 settings 脚本，或接受 Gradle 类型的参数以应用于初始化脚本。

这些类型插件之间的区别在于其应用范围：

项目插件

项目插件是应用于构建中特定项目的插件。它可以自定义构建逻辑、添加任务以及配置项目特定的设置。

Settings 插件

Settings 插件是应用于 settings.gradle 或 settings.gradle.kts 文件中的插件。它可以配置应用于整个构建的设置，例如定义构建中包含哪些项目、配置构建脚本仓库以及将通用配置应用于所有项目。

初始化插件

初始化插件是应用于 init.gradle 或 init.gradle.kts 文件中的插件。它可以配置应用于机器上所有 Gradle 构建的全局设置，例如配置 Gradle 版本、设置默认仓库或将通用插件应用于所有构建。