如何为buildSrc中的Gradle自定义Project插件配置并识别ID？

关于插件ID的作用 #

指定正确匹配的插件ID确实能解决插件无法被找到的问题——Gradle正是通过插件ID来定位和加载对应实现类的，你当前的报错本质就是配置的ID没有和插件的注册信息对应上。

配置插件ID的几种方式（针对buildSrc本地插件） #

因为你的插件放在buildSrc目录下，属于项目本地插件，无需发布，以下是几种可靠的注册ID的方法：

方法1：使用java-gradle-plugin插件自动注册（推荐） #

这是最规范且不易出错的方式，Gradle会自动生成必要的配置文件：

1. 在buildSrc/build.gradle（或buildSrc/build.gradle.kts）中应用插件并引入依赖：

// buildSrc/build.gradle
plugins {
    id 'java-gradle-plugin'
}

dependencies {
    implementation gradleApi()
}

2. 用gradlePlugin块注册插件，明确指定ID和实现类的完整限定名：

gradlePlugin {
    plugins {
        myCustomPlugin { // 内部别名，可任意命名
            id = 'com.smotricz.myPlugin' // 你要使用的插件ID
            implementationClass = 'com.smotricz.MyPlugin' // 插件类的完整路径
        }
    }
}

3. 执行gradle build编译buildSrc，之后主项目就能通过id 'com.smotricz.myPlugin'引用插件。

方法2：手动创建META-INF配置文件 #

若不想依赖java-gradle-plugin，可手动生成Gradle识别的配置文件：

1. 在buildSrc/src/main/resources下创建目录结构META-INF/gradle-plugins
2. 新建以插件ID命名的.properties文件，比如com.smotricz.myPlugin.properties
3. 文件内仅需一行配置，指定插件类的完整限定名：

implementation-class=com.smotricz.MyPlugin

方法3：使用注解注册（Gradle 4.0+支持） #

在插件实现类上直接标注@PluginImplementation注解（需依赖Gradle API）：

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

@PluginImplementation(id = "com.smotricz.myPlugin")
public class MyPlugin implements Plugin<Project> {
    @Override
    public void apply(Project project) {
        // 你的插件逻辑代码
    }
}

确保buildSrc依赖中包含gradleApi()，编译后即可通过ID引用插件。

常见排查点 #

• 检查插件类的完整限定名是否完全正确（包名、类名大小写、拼写均需匹配）
• 确认buildSrc目录结构符合标准：源码放在src/main/java/groovy/kotlin下，资源文件放在src/main/resources（仅方法2需要）
• 先执行gradle clean build编译buildSrc，再同步主项目的Gradle配置

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