Gradle 是建立在插件系统之上的。 Gradle 本身主要由基础设施组成,例如复杂的依赖解析引擎。它的其余功能来自插件。
插件是一个为 Gradle 构建系统提供附加功能的软件。
插件可以应用于 Gradle 构建脚本以添加新任务、配置或其他与构建相关的功能:
- Java 库插件 -
java-library
-
用于定义和构建 Java 库。它随任务编译 Java 源代码
compileJava
,随任务生成 Javadocjavadoc
,并随任务将编译的类打包到 JAR 文件中jar
。 - Google 服务 Gradle 插件 -
com.google.gms:google-services
-
使用名为 的配置块
googleServices{}
和名为 的任务在 Android 应用程序中启用 Google API 和 Firebase 服务generateReleaseAssets
。 - Gradle Bintray 插件 -
com.jfrog.bintray
-
允许您通过使用块配置插件来将工件发布到 Bintray
bintray{}
。
插件分发
插件以三种方式分发:
-
核心插件- Gradle 开发并维护一组核心插件。
-
社区插件- Gradle 社区通过Gradle 插件门户共享插件。
-
本地插件- Gradle 使用户能够使用API创建自定义插件。
应用插件
将插件应用到项目允许插件扩展项目的功能。
您可以使用插件 ID(全局唯一标识符/名称)和版本在构建脚本中应用插件:
plugins {
id «plugin id» version «plugin version»
}
1. 核心插件
Gradle Core 插件是 Gradle 发行版本身包含的一组插件。这些插件提供了构建和管理项目的基本功能。
核心插件的一些示例包括:
-
java:提供对构建 Java 项目的支持。
-
groovy:添加对编译和测试 Groovy 源文件的支持。
-
ear:添加了对为企业应用程序构建 EAR 文件的支持。
核心插件的独特之处在于,它们在构建脚本中应用时提供短名称,例如java
核心JavaPlugin 。它们也不需要版本。要将java
插件应用到项目中:
plugins {
id("java")
}
用户可以利用许多Gradle 核心插件。
2. 社区插件
社区插件是由 Gradle 社区开发的插件,而不是核心 Gradle 发行版的一部分。这些插件提供可能特定于某些用例或技术的附加功能。
Spring Boot Gradle 插件打包可执行 JAR 或 WAR 档案,并运行Spring Boot Java 应用程序。
要将org.springframework.boot
插件应用到项目:
plugins {
id("org.springframework.boot") version "3.1.5"
}
社区插件可以在Gradle 插件门户上发布,其他 Gradle 用户可以轻松发现和使用它们。
3.本地插件
自定义或本地插件是在特定项目或组织内开发和使用的。这些插件不会公开共享,而是根据项目或组织的特定需求量身定制的。
本地插件可以封装常见的构建逻辑,提供与内部系统或工具的集成,或者将复杂的功能抽象为可重用的组件。
Gradle 为用户提供了使用 API 开发自定义插件的能力。要创建您自己的插件,您通常需要遵循以下步骤:
-
定义插件类:创建一个实现接口的新类
Plugin<Project>
。// Define a 'HelloPlugin' plugin class HelloPlugin : Plugin<Project> { override fun apply(project: Project) { // Define the 'hello' task val helloTask = project.tasks.register("hello") { doLast { println("Hello, Gradle!") } } } }
-
构建并可选择发布您的插件:生成一个包含插件代码的 JAR 文件,并可选择将此 JAR 发布到存储库(本地或远程)以在其他项目中使用。
// Publish the plugin plugins { `maven-publish` } publishing { publications { create<MavenPublication>("mavenJava") { from(components["java"]) } } repositories { mavenLocal() } }
-
应用您的插件:当您想要使用插件时,请在
plugins{}
构建文件的块中包含插件 ID 和版本。// Apply the plugin plugins { id("com.example.hello") version "1.0" }
请参阅插件开发章节以了解更多信息。
下一步: 了解增量构建和构建缓存>>