如何实现含include/includeBuild的复杂Gradle复合构建并解决依赖问题？

项目目录结构 #

.
├── project/
│   ├── fruit/
│   │   ├── banana/
│   │   │   └── build.gradle.kts
│   │   ├── apple/
│   │   │   └── build.gradle.kts
│   │   ├── build.gradle.kts
│   │   └── settings.gradle.kts
│   └── shared/
│       ├── common/
│       │   └── build.gradle.kts
│       ├── util/
│       │   └── build.gradle.kts
│       └── build.gradle.kts
├── build.gradle.kts
└── settings.gradle.kts

需求与现有配置 #

核心需求 #

• 最外层build.gradle.kts通过allProjects和subProjects统一管理全局依赖
• 各子目录的build.gradle.kts负责自身及子模块的专属依赖配置
• fruit下的apple、banana模块需要依赖shared下的common和util模块

现有配置 #

最外层settings.gradle.kts

rootProject.name = "root"

include("fruit")
include("fruit:apple")
include("fruit:banana")
include("shared")
include("shared:common")
include("shared:util")

fruit/build.gradle.kts（依赖无法解析）

dependencies {
  implementation("com.example.shared:common")
  implementation("com.example.shared:util")
}

fruit/settings.gradle.kts

includeBuild("../shared/common")
includeBuild("../shared/util")

问题现象 #

project/fruit/apple/src/com.example.fruit.apple/Main.java中的依赖无法被Gradle解析，编译报错。

问题原因与解决方案 #

问题根源 #

你混淆了Gradle单项目多模块和复合构建的用法：

1. 最外层settings.gradle.kts已经通过include将所有模块纳入同一个根项目，此时不需要用includeBuild（该方法用于引入独立的外部Gradle项目）
2. 同一项目内的子模块依赖不能用Maven坐标格式引用，必须使用项目路径

解决步骤 #

1. 删除fruit/settings.gradle.kts文件：所有模块已被最外层配置统一管理，子目录无需单独的settings文件
2. 修正fruit/build.gradle.kts的依赖引用：改用项目路径格式声明依赖

dependencies {
  implementation(project(":shared:common"))
  implementation(project(":shared:util"))
}

3. 验证子模块配置：确保shared/common和shared/util的build.gradle.kts已正确应用java插件，示例：

plugins {
    id("java")
}

java {
    sourceCompatibility = JavaVersion.VERSION_17
    targetCompatibility = JavaVersion.VERSION_17
}

4. 同步并构建项目：执行./gradlew clean build（或在IDE中触发Gradle同步），验证依赖解析是否正常

额外优化建议 #

全局依赖版本统一管理 #

在最外层build.gradle.kts中添加dependencyResolutionManagement块，统一管控依赖版本：

dependencyResolutionManagement {
    repositories {
        mavenCentral()
    }
    versionCatalogs {
        create("libs") {
            version("guava", "32.1.3-jre")
            library("guava", "com.google.guava", "guava").versionRef("guava")
        }
    }
}

allProjects {
    repositories {
        mavenCentral()
    }
}

subprojects {
    apply(plugin = "java")
}

shared模块通用配置 #

在shared/build.gradle.kts中配置子模块的通用规则：

subprojects {
    apply(plugin = "java")
    java {
        sourceCompatibility = JavaVersion.VERSION_17
        targetCompatibility = JavaVersion.VERSION_17
    }
}

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