快捷導(dǎo)航

使用 Java 開發(fā) Gradle 插件的步驟

更新時間：2021年03月03日 10:11:00 作者：https://www.cnblogs.com/robothy/p/14335174.html

這篇文章主要介紹了使用 Java 開發(fā) Gradle 插件的步驟，幫助大家更好的理解和學(xué)習(xí)使用Java，感興趣的朋友可以了解下

1 創(chuàng)建項目

Gradle 插件項目和普通的 Java 項目沒有什么不同，普通項目是基于其它三方包進行開發(fā)，而 Gradle 插件項目基于 Gradle 的 API 進行開發(fā)。

基于 Gradle 創(chuàng)建一個 Java 項目，項目目錄結(jié)構(gòu)如下，和普通項目一樣。

gradle-plugin-sample
|
├───build.gradle
├───settings.gradle
└───src
 ├───main
 │ ├───java
 │ └───resources
 └───test
  ├───java
  └───resources

引入 Gradle API 相關(guān)的 jar 包。為了方便起見，可以通過 gradle 插件 java-gradle-plugin 來引入 Java 插件，引入 Gradle API 相關(guān)依賴以及生成插件相關(guān)的描述符。

build.gradle

plugins {
 id 'java-gradle-plugin'
}

group 'com.robothy'
version '1.0-SNAPSHOT'

repositories {
 mavenLocal()
 mavenCentral()
}

wrapper{
 gradleVersion = '6.7'
}

2 動手開發(fā)

項目創(chuàng)建好之后，就可以開始動手開發(fā)了。從項目構(gòu)建角度來看，Gradle 插件是一段可重用的構(gòu)建邏輯，這段邏輯能夠被應(yīng)用到各個項目當(dāng)中。更具體來說，Gradle 插件是一個實現(xiàn)了 org.gradle.api.Plugin 接口的類，它被 Project （可以認為是 build.gralde, 它本質(zhì)是一個實現(xiàn)了 Project 接口的類）所引用。開發(fā)插件的本質(zhì)就是往 build.gradle 中插入一段邏輯。

void apply(T target)

Plugin 是一個泛型接口，有一個抽象方法 apply，它的參數(shù)類型可以是 Project, Settings, 或者 Gradle。

類型為 Project，插件可以應(yīng)用于 build.gradle；
類型為 Settings，插件可應(yīng)用于 settings.gradle；
類型為 Gradle, 插件可應(yīng)用于 Gradle 初始化腳本。

在應(yīng)用插件時，gradle 會創(chuàng)建一個插件類的實例，并調(diào)用 apply 方法。因此，插件的邏輯就是 apply 方法中的代碼。

一個獨立的項目中可以有多個實現(xiàn)了 Plugin 接口的類，意味著一個項目可以包含多個插件。每一個插件都需要在 build.gradle 中添加相應(yīng)的描述，java-gradle-plugin 會根據(jù)這些描述生成插件描述符（jar 包中的一個文件）。

假設(shè)要在 gradle-plugin-sample 項目中創(chuàng)建兩個插件 hello, goodbye，需要進行如下兩個步驟：

1）創(chuàng)建插件類

HelloPlugin.java

import org.gradle.api.Plugin;
import org.gradle.api.Project;

public class HelloPlugin implements Plugin<Project> {
 @Override
 public void apply(Project project) {
  System.out.println("Message from hello plugin.");
 }
}

GoodbyePlugin.java

import org.gradle.api.Plugin;
import org.gradle.api.Project;

public class GoodbyePlugin implements Plugin<Project> {
 @Override
 public void apply(Project project) {
  System.out.println("Message from goodbye plugin.");
 }
}

2）在 build.gradle 中添加描述內(nèi)容

描述內(nèi)容需要指定插件的 ID 和插件的入口類。

gradlePlugin {
 plugins {
  helloPlugin {
   id = 'com.robothy.hello'
   implementationClass = 'com.robothy.HelloPlugin'
  }
  googbyePlugin{
   id = 'com.robothy.goodbye'
   implementationClass = 'com.robothy.GoodbyePlugin'
  }
 }
}

完成上面步驟之后，一個簡單的插件就算完成了開發(fā)，接下來就可以發(fā)布和使用了。

3 發(fā)布插件

插件可以發(fā)布到 Maven 倉庫和 Gradle 官方插件門戶。

3.1 發(fā)布到 Maven 倉庫

發(fā)布插件到 Maven 倉庫和發(fā)布普通的 jar 包一樣，需要用到 maven-publish 插件。要發(fā)布到遠程 Maven 倉庫可能需要提供認證信息，這里簡單起見只發(fā)布到本地倉庫。

1）在 build.gradle 文件中添加 maven-publish 插件

plugins {
 id 'java-gradle-plugin'
 id 'maven-publish'
}

2）執(zhí)行 gradle publishToMavenLocal，成功之后可以在 ~/.m2 目錄下找打發(fā)布的 jar 包。

要使用發(fā)布到 Maven 倉庫中的 Gradle 插件，需要先在 settings.gradle 中指定倉庫。如下代碼指定了插件倉庫有本地 Maven 和 Gradle 插件門戶。

pluginManagement {
 repositories {
  mavenLocal()
  gradlePluginPortal()
 }
}

3.2 發(fā)布到 Gradle 官方插件門戶

我們平常使用的大部分插件來自于 Gradle 官方插件門戶，開發(fā)人員注冊一個 Gradle 賬號之后可以將插件發(fā)布到門戶，這樣其他人就可以很方便地使用了。按照如下步驟發(fā)布插件，這里如果沒有描述清楚可以移步 Gradle 官網(wǎng)文檔：How do I add my plugin to the plugin portal?。

1）注冊門戶賬戶

2）創(chuàng)建 API Key。注冊好賬戶就能夠看見了。

3）將 API Key 添加到文件 ~/.gradle/gradle.properties

4）使用插件發(fā)布插件 com.gradle.plugin-publish 發(fā)布插件（不是病句，只是有點繞 😔）

將 com.gradle.plugin-publish 添加到插件項目 gradle-plugin-sample 的 build.gradle 中，然后添加插件的描述信息。

pluginBundle {
 website = 'http://www.gradle.org/'
 vcsUrl = 'https://github.com/gradle/gradle'
 description = 'Greetings from here!'
 tags = ['greetings', 'salutations']

 plugins {
 greetingsPlugin {
  // id='com.robothy.hello' 可以省略，因為在 gradlePlugin 配置塊中已經(jīng)有 id 信息了
  displayName = 'Hello Plugin'
 }
 }
}

5）使用 gradle publishPlugins 發(fā)布插件

如果插件信息描述正確，執(zhí)行 puhlishPlugins 任務(wù)之后會打印出待審核的信息，之后就是等待了（本人發(fā)布的插件 com.robothy.cn-repo 經(jīng)過了四五個小時就審核通過了）。

Publishing plugin com.robothy.cn-repo version 1.0
Thank you. Your new plugin com.robothy.cn-repo has been submitted for approval by Gradle engineers. The request should be processed within the next few days, at which point you will be contacted via email.

4 更多

4.1 在插件中添加任務(wù)

先自定義一個 Gradle 任務(wù)類 SayHelloTask，該任務(wù)的行為是簡答的打印固定的字符串。自定義任務(wù)需要繼承 DefaultTask。

public class SayHelloTask {
 @TaskAction
 public void hello() {
  System.out.println("Hello, World!");
 }
}

然后通過 project 往項目中注冊一個 SayHelloTask 的實例，任務(wù)名為 task。

public class HelloPlugin implements Plugin<Project> {
 @Override
 public void apply(Project project) {
  System.out.println("Message from hello plugin.");
  project.getTasks().register("hello", SayHelloTask.class);
 }
}

當(dāng)然，也可以在使用 HelloPlugin 插件的 build.gradle 中注冊任務(wù)。

task hello(type: com.robothy.SayHelloTask)

重新發(fā)布插件，執(zhí)行下面命令時控制臺會打印出 "Hello, World!"。

gradle hello

4.2 添加擴展

Gradle 插件可以往 project 中注冊擴展，開發(fā)人員可以通過擴展設(shè)置一些參數(shù)值，以供其它的 Gradle Task 使用。假設(shè)我們希望在 build.gradle 中添加如下配置信息。

user {
 name = 'Robothy'
 country = 'China'
}

首先，創(chuàng)建一個配置信息接口，接口中只包含 getter 抽象方法。需要注意的是，返回的類型為 Property，并非直接返回 String。配置信息不需要創(chuàng)建為 Java 類，Gradle 在運行時會通過動態(tài)代理的方式自動往代理對象中注入值。

public interface User {
 Property<String> getName();
 Property<String> getCountry();
}

然后插件就可以往 project 中添加一個擴展了。

project.getExtensions().add("user", User.class);

重新發(fā)布插件，此時引入了插件的項目就可以在 builde.gradle 中添加本小節(jié)開頭描述的配置塊了。

Gradle 任務(wù)可以通過如下方式訪問到這些配置信息。

User user = (User) (project.getExtensions().getByName("user"));

5 小結(jié)

本文主要介紹了如何使用純 Java 語言在一個獨立的項目中編寫 Gradle 插件，插件主要通過通過傳入的 project 參數(shù)訪問項目，往項目的構(gòu)建生命周期中插入一些邏輯或者添加配置信息。插件可以發(fā)布到私有的 Maven 倉庫，也可以發(fā)布到 Gradle 插件門戶。插件項目中還可以很好地封裝一些 Gradle Task，定義一些配置類型。