Java 中 Gradle 怎么编写自定义 Plugin 插件并将其发布到企业内部的 Artifact 仓库

老磊姑娘_2115

老磊姑娘_2115

2026-07-26

254人浏览

原创

java项目中自定义gradle插件并发布到企业仓库的核心步骤是三步:编写实现plugin接口的插件类、配置build.gradle启用gradle-plugin和maven-publish插件、执行./gradlew publish上传至nexus/artifactory。

java 中 gradle 怎么编写自定义 plugin 插件并将其发布到企业内部的 artifact 仓库

在 Java 项目中,用 Gradle 编写自定义 Plugin 并发布到企业内部仓库(如 Nexus 或 Artifactory),核心是三步:编写 Plugin 实现、配置构建脚本使其可发布、将产物上传到私有仓库。下面分关键环节说明。

编写自定义 Plugin 类

Plugin 必须实现 org.gradle.api.Plugin 接口,推荐使用 Kotlin 或 Java 编写(Kotlin 更简洁)。通常放在独立的 Gradle 模块中(如 my-company-gradle-plugin)。

示例(Java):

public class GreetingPlugin implements Plugin<project> {
    @Override
    public void apply(Project project) {
        // 注册一个自定义 task
        project.getTasks().register("sayHello", GreetingTask.class);
    }
}

public abstract class GreetingTask extends DefaultTask {
    @TaskAction
    public void greet() {
        getLogger().lifecycle("Hello from custom plugin!");
    }
}</project>

注意:Plugin 类需有无参构造函数;若需参数化,应通过 Extension(扩展)暴露配置项。

配置插件模块的 build.gradle

该模块本身要能被构建为 jar,并声明插件 ID 和元数据。推荐使用 Gradle Plugin Development Plugin(内置)简化流程:

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载
  • 在 build.gradle 中应用插件:plugins { id 'java-gradle-plugin' }
  • 声明插件 ID 和实现类:gradlePlugin { plugins { greeting { id = 'com.mycompany.greeting'; implementationClass = 'com.mycompany.GreetingPlugin' } } }
  • 添加必要依赖(如 gradleApi()、localGroovy())
  • 确保 src/main/resources/META-INF/gradle-plugins/com.mycompany.greeting.properties 存在,内容为:implementation-class=com.mycompany.GreetingPlugin

配置发布到企业仓库

使用 maven-publish 插件 + 企业仓库地址 + 认证信息:

  • 应用插件:plugins { id 'maven-publish' }
  • 配置 publishing { repositories { maven { url = "https://nexus.mycompany.com/repository/maven-releases/" } } }
  • 提供凭证(不硬编码):./gradle.properties 中设 nexusUsername=xxx 和 nexusPassword=yyy,然后在 build.gradle 中引用:credentials { username = project.findProperty("nexusUsername") ?: "" password = project.findProperty("nexusPassword") ?: "" }
  • 确保 group(如 com.mycompany)、version(如 1.0.0)已设置,它们决定最终坐标 com.mycompany:my-company-gradle-plugin:1.0.0

执行 ./gradlew publish 即可上传 jar、pom、module 文件到私有仓库。

在其他项目中使用该插件

发布成功后,在目标项目的 settings.gradle 或 settings.gradle.kts 中声明仓库:

pluginManagement {
    repositories {
        maven { url = "https://nexus.mycompany.com/repository/maven-releases/" }
        gradlePluginPortal() // 可选,保留默认源
    }
}

然后在 build.gradle 中应用:

plugins {
    id("com.mycompany.greeting") version "1.0.0" apply false
}
// 或在子项目中启用
apply(plugin = "com.mycompany.greeting")

注意:若插件未发布到公开源,必须在 pluginManagement 块中显式配置私有仓库,否则解析失败。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

9897

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

7022

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

6192

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1064

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

888

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1296

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2589

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

19931

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1155

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习