Gradle插件如何基于用户提供的可选依赖配置运行Java代码？

你已经创建了名为myPlugin的自定义Configuration，接下来需要完成三个核心步骤，让任务能加载并使用该配置下的依赖类：

1. 配置自定义Configuration的解析属性 #

首先要确保myPlugin配置是可解析的（Gradle需要解析它来获取具体的依赖文件），在插件类中修改Configuration的创建代码：

class MyPlugin : Plugin<Project> {
    override fun apply(project: Project) {
        val extension = project.extensions.create<MyPluginExtension>("myPlugin")
        // 配置myPlugin为可解析、不可消费的配置
        val config = project.configurations.create("myPlugin") {
            isCanBeResolved = true
            isCanBeConsumed = false
            // 可选：限制依赖类型为jar，避免引入不必要的文件
            attributes.attribute(Usage.USAGE_ATTRIBUTE, project.objects.named(Usage.JAVA_RUNTIME))
        }

        val task = project.tasks.register<MyTask>("myTask") {
            // 将配置的类路径关联到任务
            pluginClasspath.from(config)
        }
    }
}

2. 在任务中声明类路径输入并加载依赖 #

在MyTask中用@Classpath注解声明类路径属性，Gradle会自动处理依赖解析和增量构建，之后通过自定义类加载器加载依赖类：

abstract class MyTask : DefaultTask() {
    // 用@Classpath标记，Gradle会自动处理依赖的解析和缓存
    @get:Classpath
    val pluginClasspath = project.objects.fileCollection()

    @TaskAction
    fun execute() {
        // 基于配置的类路径创建自定义类加载器
        val classLoader = URLClassLoader(
            pluginClasspath.files.map { it.toURI().toURL() }.toTypedArray(),
            // 使用当前类加载器作为父加载器，避免类隔离问题
            javaClass.classLoader
        )

        // 方式1：用反射加载类并创建实例
        val targetClass = classLoader.loadClass("com.example.ExamplePlugin")
        val instance = targetClass.getDeclaredConstructor().newInstance()
        // 调用实例方法（假设ExamplePlugin有doSomething方法）
        targetClass.getMethod("doSomething").invoke(instance)

        // 方式2：用ServiceLoader加载服务实现（推荐，更规范）
        // 需提前定义一个公共接口，比如ExamplePluginInterface
        val services = ServiceLoader.load(ExamplePluginInterface::class.java, classLoader)
        services.forEach { service ->
            service.doSomething()
        }
    }
}

若使用ServiceLoader方式，需要在用户提供的依赖jar中，在META-INF/services目录下创建以接口全类名为文件名的文件，内容填写实现类的全类名。

3. 关键细节说明 #

• 可解析配置：必须设置isCanBeResolved = true，否则Gradle不会解析该配置的依赖文件，无法获取到具体的jar路径。
• 类加载器隔离：使用自定义URLClassLoader可以避免和插件自身的类路径冲突，确保加载的是用户提供的依赖类。
• 增量构建：@Classpath注解会让Gradle跟踪类路径的变化，只有当依赖变更时才会重新执行任务，提升构建效率。

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