第 4 部分：应用 Gradle 插件

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

在本节中，您将

应用插件
配置插件
使用插件
探索其他插件

步骤 0. 开始之前

您已在第 1 部分中初始化了 Java 应用。
您已在第 2 部分中运行了多个任务。
您已在第 3 部分中了解了依赖项管理。

步骤 1. 了解插件

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

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

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

插件可以

向项目添加任务（例如编译、测试）。
扩展基本 Gradle 模型（例如，添加可配置的新 DSL 元素）。
根据约定配置项目（例如，添加新任务或配置合理默认值）。
应用特定配置（例如，添加组织存储库或强制执行标准）。
通过扩展向现有类型添加新属性和方法。

步骤 2. 应用插件

我们的项目当前应用了一个插件，即与 Gradle 捆绑在一起的应用程序插件。

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

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

让我们将由 Gradle 维护和分发的插件应用到我们的项目中，该插件称为Maven 发布插件。Maven 发布插件提供了将构建工件发布到Apache Maven 存储库的功能。它还可以发布到 Maven 本地，即位于您计算机上的存储库。

Maven 本地存储库的默认位置可能不同，但通常是

Mac: /Users/\[username]/.m2
Linux: /home/\[username]/.m2
Windows: C:\Users\[username]\.m2

通常，目标为 Maven 存储库的发布包括

一个或多个工件
Gradle 模块元数据
Maven POM 文件

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

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

plugins {
    // Apply the application plugin to add support for building a CLI application in Java.
    id '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 发布插件的新任务现在可以在 IntelliJ 的 Gradle 右侧窗格中使用。

步骤 3. 配置插件

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

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

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

publishing {
    publications {
        create("maven", MavenPublication) {
            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.

步骤 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 文件

您还可以在 Maven 本地目录中查看文件：/Users/\[username]/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。

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

插件作者可以将他们的插件保密或分发给公众。因此，插件有三种分发方式

核心插件 - Gradle 开发并维护一组核心插件。
社区插件 - Gradle 的社区通过Gradle 插件门户共享插件。
自定义插件 - Gradle 使用户能够使用API创建自定义插件。

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

Gradle 强烈推荐使用约定插件。

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

此页面是否有用？