如何在settings.gradle中通过Groovy脚本动态引入所有包含build.gradle的子项目？

这个需求太实用了，尤其是项目子模块越来越多的时候，硬写一堆include ':xxx'真的很繁琐，还容易漏。下面就来一步步实现你要的自动引入逻辑：

核心思路 #

我们需要遍历项目根目录下的所有子目录，找到直接包含build.gradle文件的目录，然后把这些目录的相对路径转换成Gradle识别的项目路径格式（用冒号:分隔层级），最后调用include方法完成引入。

基础实现代码 #

把这段代码放到你的settings.gradle文件里即可：

// 遍历根目录下所有子目录，自动引入包含build.gradle的项目
new File(rootDir).eachFileRecurse(FileType.DIRECTORIES) { dir ->
    // 检查当前目录下是否存在build.gradle
    def buildGradleFile = new File(dir, 'build.gradle')
    if (buildGradleFile.exists()) {
        // 将目录相对路径转换为Gradle项目路径（如sub/app → :sub:app）
        def relativePath = rootDir.toURI().relativize(dir.toURI()).getPath()
        def projectPath = relativePath.replace('/', ':').replaceAll(/:$/, '')
        // 引入该子项目
        include projectPath
        println "已自动引入子项目: $projectPath"
    }
}

关键细节解释 #

1. 用rootDir代替new File('.')：rootDir是Gradle提供的内置变量，指向项目根目录，比手动创建File对象更可靠，不会受当前工作目录影响。
2. 只遍历目录：eachFileRecurse(FileType.DIRECTORIES)只处理目录，避免遍历到无关文件，提升效率。
3. 路径转换逻辑：把目录的相对路径（比如moduleA/subModuleB）转换成Gradle要求的冒号分隔格式（:moduleA:subModuleB），最后用replaceAll(/:$/, '')去掉可能末尾的冒号。

优化：排除无关目录 #

如果你的项目里有build、.gradle、node_modules这类不需要作为子项目的目录，可以加上排除逻辑，避免误引入：

// 定义需要排除的目录名单
def excludedDirNames = ['build', '.gradle', 'node_modules', '.git', 'docs']

new File(rootDir).eachFileRecurse(FileType.DIRECTORIES) { dir ->
    // 如果当前目录在排除名单里，直接跳过该目录及其子目录
    if (excludedDirNames.contains(dir.name)) {
        dir.traverse(stopVisiting: true)
        return
    }

    def buildGradleFile = new File(dir, 'build.gradle')
    if (buildGradleFile.exists()) {
        def relativePath = rootDir.toURI().relativize(dir.toURI()).getPath()
        def projectPath = relativePath.replace('/', ':').replaceAll(/:$/, '')
        include projectPath
        println "已自动引入子项目: $projectPath"
    }
}

这样就能完美实现自动引入所有合法子项目，再也不用手动维护include列表啦！

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