Gradle多项目/复合构建通用任务生成逻辑及实现方法咨询

我有一个my-commons项目，存放着其他项目使用的大量共享库及通用Gradle插件，结构如下：

my-commons
├─my-library-a
│ ├─...
│ └─build.gradle.kts
├─my-library-b
│ ├─...
│ └─build.gradle.kts
├─my-plugins
│ ├─...
│ └─build.gradle.kts
└─settings.gradle.kts

其根目录下的settings.gradle.kts文件内容如下：

rootProject.name = "my-commons"
include("my-library-a")
include("my-library-b")

pluginManagement {
    includeBuild("my-plugins")
}

在IntelliJ中打开该项目时，根项目会拥有test、build、publish等大量通用任务，执行这些任务时会在所有子项目中运行。

现在我决定创建一个复合构建，将my-commons作为其中一个included build，以更好地利用Gradle的includeBuild特性及依赖短路机制。新的项目结构如下：

my-project
├─my-commons
│ ├─my-library-a
│ │ ├─...
│ │ └─build.gradle.kts
│ ├─my-library-b
│ │ ├─...
│ │ └─build.gradle.kts
│ ├─my-plugins
│ │ ├─...
│ │ └─build.gradle.kts
│ └─settings.gradle.kts
├─my-project-x
│ ├─...
│ └─build.gradle.kts
├─my-project-y
│ ├─...
│ └─build.gradle.kts
└─settings.gradle.kts

新根目录下的settings.gradle.kts文件内容如下（my-commons中的该文件保持不变）：

rootProject.name = "my-project"
includeBuild("my-commons")
includeBuild("my-project-x")
includeBuild("my-project-y")

但在IntelliJ中打开这个复合构建项目时，根项目的所有通用任务都消失了，甚至my-commons这个included build的任务菜单中也没有这些任务。若要构建或发布内容，我需要手动为每个模块执行操作。

与此同时，在单独的IntelliJ窗口中打开my-commons时，所有任务都正常存在。

我的问题是：Gradle如何决定是否在父项目中添加这些通用任务？在当前的复合构建结构下，我该如何实现与单独项目相同的任务批量执行效果？

一、Gradle复合构建中任务可见性的逻辑 #

1. 单独项目与复合构建的核心差异

   • 单独打开my-commons时，它是独立Gradle项目，根项目的build、test等通用任务由java/java-library类插件自动生成，且默认配置为触发所有子项目的同名任务。
   • 复合构建中，每个includeBuild引入的是独立构建单元，复合根项目本身未应用任何插件，因此不会自动生成通用任务。同时IntelliJ对复合构建的任务展示逻辑是：仅显示每个included build中与当前构建依赖图直接关联的任务，而非该build内部所有任务。

2. 任务聚合的生效范围
   根项目的聚合任务（如build）本质是通过tasks.named<Build>("build") { dependsOn(subprojects.map { it.tasks.named("build") }) }这类逻辑实现，但仅在单个项目内部生效。复合构建中，不同included build相互隔离，默认不会自动聚合任务。

二、实现批量执行任务的解决方案 #

方案1：在复合根项目手动添加聚合任务 #

在my-project根目录创建build.gradle.kts，手动聚合各included build的同名任务：

// 聚合所有included build的build任务
tasks.register("buildAll") {
    description = "构建所有包含的项目"
    dependsOn(gradle.includedBuilds.map { it.task(":build") })
}

// 聚合所有included build的test任务
tasks.register("testAll") {
    description = "运行所有包含项目的测试"
    dependsOn(gradle.includedBuilds.map { it.task(":test") })
}

// 单独聚合my-commons的publish任务
tasks.register("publishCommons") {
    description = "发布my-commons下所有模块"
    dependsOn(gradle.includedBuilds.find { it.name == "my-commons" }?.task(":publish") ?: emptyList())
}

配置完成后，IntelliJ的Gradle面板中会出现buildAll、testAll等自定义任务，执行即可批量触发对应操作。

方案2：通过命令行调用included build的任务 #

my-commons内部的聚合任务实际仍存在，只是复合构建下IntelliJ默认不展示。可以直接通过Gradle命令行调用：

# 执行my-commons的build任务
./gradlew :my-commons:build

# 执行所有included build的build任务
./gradlew buildAll

也可以在IntelliJ的Gradle面板中点击右上角刷新按钮，勾选「Show all tasks」来显示更多任务，但这种方式不如自定义聚合任务直观。

方案3：调整结构，将部分项目改为子项目 #

如果my-project-x、my-project-y无需作为独立构建，可将它们改为my-project的子项目而非includeBuild，修改my-project/settings.gradle.kts：

rootProject.name = "my-project"
include("my-commons")
include("my-project-x")
include("my-project-y")

pluginManagement {
    includeBuild("my-commons/my-plugins")
}

这种方式会让my-project根项目自动继承子项目的插件任务，恢复批量执行能力，但会失去复合构建的依赖短路特性，需根据需求权衡。

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