了解插件如何扩展 Gradle 的功能，并使用流行的插件。

在本节中，您将

  • 应用插件

  • 配置插件

  • 使用插件

  • 探索其他插件

步骤 0. 开始之前

  1. 您在第 1 部分中初始化了您的 Java 应用程序。

  2. 您在第 2 部分中运行了几个任务。

  3. 您在第 3 部分中学习了依赖管理。

步骤 1. 理解插件

插件是在项目中组织构建逻辑和重用构建逻辑的主要方法。

插件也用于将自定义任务作为打包代码分发。

将插件应用于项目会执行代码，这些代码可以创建任务、配置属性以及扩展项目的功能。通常，插件使用 Gradle API 来提供额外的功能并扩展 Gradle 的核心功能。

插件可以

  • 向项目添加任务（例如，compile、test）。

  • 扩展基本的 Gradle 模型（例如，添加可以配置的新 DSL 元素）。

  • 根据约定配置项目（例如，添加新任务或配置合理的默认值）。

  • 应用特定配置（例如，添加组织仓库或强制标准）。

  • 通过扩展向现有类型添加新属性和方法。

步骤 2. 应用插件

我们的项目当前应用了一个插件，即 Gradle 捆绑的 Application Plugin

KotlinGroovy
plugins {
    // Apply the application plugin to add support for building a CLI application in Java.
    application
}

让我们将 Gradle 维护和分发的插件应用于我们的项目，该插件称为 Maven Publish Plugin。Maven Publish 插件提供了将构建工件发布到 Apache Maven 仓库的功能。它还可以发布到 Maven local，这是一个位于您机器上的仓库。

Maven local 仓库的默认位置可能有所不同，但通常是

  • Mac: /Users/\[用户名]/.m2

  • Linux: /home/\[用户名]/.m2

  • Windows: C:\Users\[用户名]\.m2

发布到 Maven 仓库的出版物通常包括

  • 一个或多个工件

  • Gradle 模块元数据

  • Maven POM 文件

通过将 maven-publish 添加到 build.gradle(.kts) 中的 plugins 代码块来应用插件

KotlinGroovy
plugins {
    // Apply the application plugin to add support for building a CLI application in Java.
    application
    id("maven-publish")
}

如果您使用 IntelliJ IDEA，请不要忘记同步 Gradle。

让我们通过查看可用的新任务来确保插件已应用。

在命令行中运行 ./gradlew :app:tasks

$ ./gradlew :app:tasks

> Task :app:tasks

------------------------------------------------------------
Tasks runnable from project ':app'
------------------------------------------------------------

...

Publishing tasks
----------------
publish - Publishes all publications produced by this project.
publishToMavenLocal - Publishes all Maven publications produced by this project to the local Maven cache.

现在可以使用一组新的发布任务，称为 publish 和 publishToMavenLocal。

同样，Maven Publish 插件的新任务现在在 IntelliJ 的 Gradle 右侧窗格中可用。

intellij idea plugin

步骤 3. 配置插件

将发布信息添加到您的 build.gradle(.kts) 文件

KotlinGroovy
publishing {
    publications {
        create<MavenPublication>("maven") {
            groupId = "com.gradle.tutorial"
            artifactId = "tutorial"
            version = "1.0"

            from(components["java"])
        }
    }
}

再次在命令行中运行 ./gradlew :app:tasks，您将看到其他任务，因为我们已经为插件提供了有关我们应用程序的更多信息

$ ./gradlew :app:tasks

> Task :app:tasks

------------------------------------------------------------
Tasks runnable from project ':app'
------------------------------------------------------------

...

Publishing tasks
----------------
generateMetadataFileForMavenPublication - Generates the Gradle metadata file for publication 'maven'.
generatePomFileForMavenPublication - Generates the Maven POM file for publication 'maven'.
publish - Publishes all publications produced by this project.
publishMavenPublicationToMavenLocal - Publishes Maven publication 'maven' to the local Maven repository.
publishToMavenLocal - Publishes all Maven publications produced by this project to the local Maven cache.
intellij idea pub

步骤 4. 使用插件

要使用插件，请通过运行 ./gradlew :app:publishToMavenLocal 运行 publishToMavenLocal 任务。

$ ./gradlew :app:publishToMavenLocal

> Task :app:compileJava FROM-CACHE
> Task :app:processResources NO-SOURCE
> Task :app:classes UP-TO-DATE
> Task :app:jar
> Task :app:generateMetadataFileForMavenPublication
> Task :app:generatePomFileForMavenPublication
> Task :app:publishMavenPublicationToMavenLocal
> Task :app:publishToMavenLocal
BUILD SUCCESSFUL in 331ms

publishToMavenLocal 任务构建 POM 文件和要发布的工件。然后，它将它们安装到本地 Maven 仓库中。

您可以在 build 目录中查看 POM 和 GMM 文件

intellij idea dist

您还可以在您的 Maven Local 目录中查看文件：/Users/\[用户名]/.m2/repository/com/gradle/tutorial/tutorial/1.0。

<?xml version="1.0" encoding="UTF-8"?>
<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.gradle.tutorial</groupId>
  <artifactId>tutorial</artifactId>
  <version>1.0</version>
  <packaging>pom</packaging>
</project>

步骤 5. 探索插件

插件用于扩展构建功能和自定义 Gradle。

使用插件是组织构建逻辑的主要机制。

插件作者可以选择将他们的插件设为私有，也可以将其分发给公众。因此，插件通过三种方式分发

  1. 核心插件 - Gradle 开发和维护一组 核心插件。

  2. 社区插件 - Gradle 社区通过 Gradle 插件门户共享插件。

  3. 自定义插件 - Gradle 允许用户使用 API 创建自定义插件。

约定插件 是用于在子项目（模块）之间共享构建逻辑的插件。用户可以将通用逻辑包装在约定插件中。例如，用作约定插件的代码覆盖率插件可以调查整个项目的代码覆盖率，而不仅仅是特定的子项目。

Gradle 强烈建议使用约定插件。

下一步： 探索增量构建 >>