Kotlin中Gradle任务内注册任务并添加依赖报错的技术问询

问题分析 #

你当前的代码在CodeGeneratorTask的@TaskAction方法中注册下载/生成任务、修改kotlinCompile的依赖，触发了错误：

Cannot call Task.dependsOn(Object...) on task ':simpleCodeGenerator' after task has started execution.

原因是Gradle构建分为配置阶段和执行阶段：

• 配置阶段：Gradle解析所有任务、构建依赖图，此时可以注册任务、修改依赖。
• 执行阶段：运行具体任务的@TaskAction方法，此时任务依赖图已经固化，无法再修改任务依赖关系。

你的CodeGeneratorTask属于执行阶段任务，在它的TaskAction中修改其他任务的依赖，违反了Gradle的生命周期规则。

解决方案 #

将所有任务注册、依赖配置、源码目录添加操作，移到配置阶段执行，不要放在任务的TaskAction中。推荐通过自定义Gradle插件实现，或者在项目配置块中处理。

修正后的代码示例 #

方式1：自定义插件（推荐）

将配置逻辑封装到插件中，在配置阶段完成所有任务设置：

class CodeGeneratorPlugin : Plugin<Project> {
    override fun apply(project: Project) {
        // 获取配置扩展
        val generationConfig = project.extensions.findByType(GenerationConfiguration::class.java)
            ?: throw IllegalArgumentException("未找到GenerationConfiguration扩展")

        generationConfig.contracts.forEach { contract ->
            // 1. 注册下载任务
            val downloadTask = createContractFileTask(project.tasks, contract)

            // 2. 注册代码生成任务，并依赖下载任务
            val generateTask = project.tasks.register(contract.generateTaskName, GenerateTask::class.java) {
                dependsOn(downloadTask)
                // 传递生成逻辑所需的参数到GenerateTask
                // 示例：this.contractConfig = contract
            }

            // 3. 让Kotlin编译任务依赖生成任务（间接保证下载→生成→编译的顺序）
            project.tasks.withType(KotlinCompile::class.java) {
                dependsOn(generateTask)
            }

            // 4. 添加生成的源码目录到main源码集
            project.extensions.getByType(KotlinJvmProjectExtension::class.java).sourceSets.getByName("main").kotlin
                .srcDir(project.layout.buildDirectory.dir("generated/${contract.path}/src/main/kotlin"))
        }
    }
}

方式2：调整任务类的执行时机（不推荐）

如果必须保留CodeGeneratorTask类，将配置逻辑移到任务初始化阶段（配置阶段），移除@TaskAction：

open class CodeGeneratorTask : DefaultTask() {
    init {
        project.extensions.findByType(GenerationConfiguration::class.java)?.let { config ->
            config.contracts.forEach { contract ->
                val downloadTask = createContractFileTask(project.tasks, contract)
                val generateTask = project.tasks.register(contract.generateTaskName, GenerateTask::class.java) {
                    dependsOn(downloadTask)
                }
                project.tasks.withType(KotlinCompile::class.java) {
                    dependsOn(generateTask)
                }
                project.extensions.getByType(KotlinJvmProjectExtension::class.java).sourceSets.getByName("main").kotlin
                    .srcDir(project.layout.buildDirectory.dir("generated/${contract.path}/src/main/kotlin"))
            }
        }
    }

    // 移除原有的@TaskAction方法，因为该任务不再需要执行具体动作
}

关键注意点 #

• 任务依赖链要清晰：kotlinCompile → generateTask → downloadTask，通过间接依赖保证执行顺序，避免重复设置依赖。
• 源码目录使用dir()而不是直接get()，Gradle会自动处理路径的延迟解析，避免配置阶段就创建目录。
• 所有修改任务依赖、注册任务的操作必须在配置阶段完成，这是Gradle构建的核心约束。

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