Gradle中project.buildDir弃用后，如何用环境变量定义构建目录？

在Gradle 8.6+的Kotlin DSL中，buildDir属性已被弃用，官方推荐使用**layout.buildDirectory**（基于Provider API的配置方式）来指定构建目录。以下是具体实现方案：

基础配置（单模块项目） #

直接在build.gradle.kts中添加以下代码：

// 读取环境变量，若未设置则抛出异常（或指定默认值）
val tmpBuildDir = System.getenv("TMP_GRADLE_BUILD_DIR") 
    ?: throw GradleException("请设置环境变量TMP_GRADLE_BUILD_DIR")

// 设置构建目录，拼接项目名称（对应Maven中的artifactId）
layout.buildDirectory.set(file("$tmpBuildDir/${project.name}"))

如果希望环境变量未设置时使用默认构建目录，可以修改为：

val tmpBuildDir = System.getenv("TMP_GRADLE_BUILD_DIR") ?: "./build"
layout.buildDirectory.set(file("$tmpBuildDir/${project.name}"))

多模块项目统一配置 #

如果是多模块项目，可在根目录的build.gradle.kts中通过subprojects块统一配置所有子模块：

subprojects {
    val tmpBuildDir = System.getenv("TMP_GRADLE_BUILD_DIR") ?: "./build"
    layout.buildDirectory.set(file("$tmpBuildDir/${project.name}"))
}

为什么用layout.buildDirectory？ #

Gradle弃用buildDir是为了推广更灵活的配置模型：

• 支持延迟求值，能动态响应环境变量、系统属性的变化
• 符合Gradle的配置缓存机制，提升构建性能
• 与现代Gradle插件的配置风格一致

效果说明 #

配置完成后，构建产物（如classes、jar、test-results等）会生成到TMP_GRADLE_BUILD_DIR指定的目录下，与项目源码目录分离，完美满足"备份项目时无需包含构建产物"的需求，和你提供的Maven配置效果一致。

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