Gradle如何为各子项目自定义或覆盖prep任务？

针对Gradle多模块项目中，子项目无法直接覆盖根项目定义的默认prep任务的问题，下面是几种可行的解决方法：

方法1：通过tasks.named()修改已有任务 #

根项目依然为所有子项目定义默认prep任务，子项目中不用重新声明任务，而是获取已存在的prep任务并修改其执行逻辑：

根项目build.gradle代码：

subprojects {
    task prep {
        doLast {
            // 默认实现：生成哈希、复制文件等通用操作
            println "执行默认prep任务"
        }
    }
}

子项目build.gradle代码：

// 获取已定义的prep任务，替换其动作
tasks.named("prep") {
    // 清空原有默认动作，如果需要追加逻辑可跳过这一步
    actions.clear()
    // 添加子项目专属的任务逻辑
    doLast {
        // 这里写复杂实现，比如部署包准备、特殊文件处理等
        println "执行子项目专属prep任务"
    }
}

这种方式直接修改已存在的任务，既避免了任务重复定义的冲突，又能完全替换或追加任务逻辑。

方法2：用任务规则动态创建默认任务 #

如果希望只有子项目未定义prep任务时，才自动创建默认任务，可以使用Gradle的任务规则：

根项目build.gradle代码：

subprojects {
    tasks.addRule("Pattern: prep") { String taskName ->
        if (taskName == "prep") {
            task(taskName) {
                doLast {
                    println "执行默认prep任务"
                }
            }
        }
    }
}

子项目build.gradle代码：

// 直接定义子项目专属的prep任务，不会触发根项目的规则创建逻辑
task prep {
    doLast {
        println "执行子项目专属prep任务"
    }
}

任务规则会在任务被调用时才触发创建逻辑，如果子项目已经定义了同名任务，规则就不会生效，完美规避冲突。

方法3：基于约定插件封装默认逻辑 #

这是Gradle现代多模块项目的最佳实践，将默认prep任务封装到约定插件中，子项目可灵活选择应用或修改：

1. 在根项目的buildSrc/src/main/groovy目录下创建插件类（比如com/example/DefaultPrepPlugin.groovy）：

package com.example

import org.gradle.api.Plugin
import org.gradle.api.Project

class DefaultPrepPlugin implements Plugin<Project> {
    @Override
    void apply(Project project) {
        project.tasks.register("prep") {
            doLast {
                println "执行默认prep任务"
            }
        }
    }
}

2. 根项目build.gradle中为所有子项目应用该插件：

subprojects {
    apply plugin: com.example.DefaultPrepPlugin
}

3. 子项目build.gradle中修改任务逻辑：

tasks.named("prep") {
    actions.clear()
    doLast {
        println "执行子项目专属prep任务"
    }
}

这种方式便于逻辑复用和维护，尤其适合大型多模块项目。

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