Gradle 8.4自定义插件中如何引入并应用仓库中的第三方插件？

问题背景 #

我查阅过旧的解决方案，但它不适用于Gradle新版本。

前提条件 #

• Gradle 8.4
• 自定义Gradle插件

我的尝试 #

插件的build.gradle配置 #

buildscript {
    dependencies {
        classpath 'ru.vyarus:gradle-quality-plugin:4.9.0' // 尝试通过buildscript提供依赖
    }
}

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

repositories {
    mavenLocal()
    mavenCentral()
    gradlePluginPortal()
}

gradlePlugin {
    plugins {
        create('base-configurer-plugin') {
            id = 'com.test.gradle.base-configurer-plugin'
            implementationClass = 'com.test.BaseGradlePlugin'
        }
    }
}

dependencies {
    compileOnly 'ru.vyarus:gradle-quality-plugin:4.9.0' // 仅用于代码中导入类
}

自定义插件代码 #

@Override
void apply(Project project) {
    project.dependencies {
        implementation 'ru.vyarus:gradle-quality-plugin:4.9.0'
    }
    project.pluginManager.apply(QualityPlugin) // 尝试多种方式调用apply方法
}

遇到的错误 #

1. 应用自定义插件时，类加载失败：

Unable to load class 'ru.vyarus.gradle.plugin.quality.QualityPlugin'
ru.vyarus.gradle.plugin.quality.QualityPlugin

2. 尝试添加到runtimeClasspath时：

> Dependencies can not be declared against the `runtimeClasspath` configuration.

3. 尝试使用runtime()方法时：

Gradle DSL method not found: 'runtime()'

核心问题 #

如何在Gradle 8.4的自定义插件中正确引入第三方插件及其依赖？

解决方案 #

在Gradle 8.x中，自定义插件引入第三方插件需通过正确的依赖配置和插件ID引用来处理，步骤如下：

1. 修改自定义插件的build.gradle #

将第三方插件作为implementation依赖引入（替代compileOnly），确保依赖能被传递给使用该插件的项目。同时可在gradlePlugin块中声明插件依赖：

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

repositories {
    mavenLocal()
    mavenCentral()
    gradlePluginPortal()
}

gradlePlugin {
    plugins {
        create('base-configurer-plugin') {
            id = 'com.test.gradle.base-configurer-plugin'
            implementationClass = 'com.test.BaseGradlePlugin'
            // 声明插件依赖（也可直接在dependencies块定义）
            dependencies {
                implementation 'ru.vyarus:gradle-quality-plugin:4.9.0'
            }
        }
    }
}

dependencies {
    // 用implementation确保依赖被传递
    implementation 'ru.vyarus:gradle-quality-plugin:4.9.0'
    implementation gradleApi()
    implementation localGroovy()
}

2. 修改自定义插件的apply方法 #

通过插件ID应用第三方插件，避免直接引用类导致的类加载问题：

@Override
void apply(Project project) {
    // 使用插件ID应用，比直接引用类更可靠
    project.pluginManager.apply('ru.vyarus.quality')
}

关键说明 #

• implementation依赖会让第三方插件的代码被纳入自定义插件的依赖传递链，确保使用方项目能获取到对应依赖。
• 用插件ID替代直接类引用，Gradle会自动处理类加载逻辑，避免ClassNotFoundException。
• Gradle 7+已废弃buildscript块的旧依赖声明方式，runtime()方法也被移除，需使用新的依赖配置体系。

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