如何使用Maven构建Gradle插件及相关发布疑问

一、用Maven构建Gradle插件的步骤 #

Gradle插件本质是实现了Gradle Plugin接口的Java/Groovy/Kotlin类，完全可以在现有Maven项目中开发和构建，具体步骤如下：

1. 添加Gradle API依赖
   在Maven项目的pom.xml中加入Gradle API的依赖，注意选择与目标使用环境匹配的Gradle版本，建议设为provided scope（Gradle运行时会自带该API，无需打包进最终JAR）：

   <dependency>
       <groupId>org.gradle</groupId>
       <artifactId>gradle-api</artifactId>
       <version>7.6</version> <!-- 替换为你需要的Gradle版本 -->
       <scope>provided</scope>
   </dependency>
   

2. 编写Gradle插件实现类
   新建Java/Groovy/Kotlin类，实现org.gradle.api.Plugin接口，重写apply方法，把原Maven插件的功能逻辑迁移过来。示例Java代码：

   package com.example;
   
   import org.gradle.api.Plugin;
   import org.gradle.api.Project;
   
   public class MyGradlePlugin implements Plugin<Project> {
       @Override
       public void apply(Project project) {
           // 实现你的插件逻辑，比如创建任务、配置项目等
           project.getTasks().create("myCustomTask", task -> {
               task.doLast(t -> {
                   System.out.println("执行自定义Gradle插件任务");
               });
           });
       }
   }
   

3. 配置Gradle插件元数据
   Gradle需要通过元数据识别插件，在Maven项目的src/main/resources目录下创建META-INF/gradle-plugins文件夹，然后新建一个以插件ID命名的properties文件（比如com.example.myplugin.properties），文件内容指向插件实现类的全限定名：

   implementation-class=com.example.MyGradlePlugin
   

4. Maven打包发布
   执行常规Maven命令完成打包和发布：

   mvn clean install
   

   执行后，插件JAR会被安装到本地Maven仓库，也可以配置Maven发布到远程仓库供其他项目使用。

二、Gradle插件的查找来源与发布要求 #

1. Gradle查找插件的渠道
   Gradle会从以下位置查找插件：
   • 本地Maven仓库（~/.m2/repository）
   • 配置的远程Maven仓库
   • Gradle官方插件门户（可选）
   • 本地文件系统的JAR包
2. 仅发布到Maven仓库足够吗？
   完全足够，不需要发布到Gradle插件门户。只要使用插件的Gradle项目配置了对应Maven仓库地址，就能拉取到插件。

其他项目引入该插件的示例 #

在使用插件的Gradle项目中，需要先配置仓库，再引入插件：

• 方式一：通过pluginManagement配置仓库（推荐，适用于多模块项目）
  在settings.gradle中添加：

  pluginManagement {
      repositories {
          mavenLocal() // 本地仓库
          maven { url "https://your-remote-maven-repo.com" } // 远程仓库
      }
  }
  

  然后在build.gradle中通过plugins块引入：

  plugins {
      id 'com.example.myplugin' version '1.0.0'
  }
  

• 方式二：通过buildscript块引入
  在build.gradle中直接配置：

  buildscript {
      repositories {
          mavenLocal()
          maven { url "https://your-remote-maven-repo.com" }
      }
      dependencies {
          classpath 'com.example:my-gradle-plugin:1.0.0' // 对应Maven的groupId:artifactId:version
      }
  }
  apply plugin: 'com.example.myplugin'
  

内容的提问来源于stack exchange，提问作者talex