如何为Gradle buildSrc指定所需Java版本并自动下载使用？

Gradle 7.0及以上版本原生支持为buildSrc单独声明Java版本依赖，配合内置的toolchain机制可以实现自动下载对应版本JDK，无需手动安装配置全局JAVA_HOME，哪怕运行环境默认只有Java 8也能正常完成全构建流程。

配置步骤 #

• 确认Gradle wrapper版本
  该特性最低支持Gradle 7.0版本，若当前项目使用的Gradle版本低于该要求，直接在项目目录执行wrapper升级命令即可，操作无需root权限：

  ./gradlew wrapper --gradle-version 7.6.4
  

  7.6.x是Gradle 7系列的稳定维护版本，对Java 8启动环境兼容性最好。

• 为buildSrc编写独立构建配置
  buildSrc本身是独立于主项目的Gradle子项目，其构建配置需要单独写在buildSrc目录下的构建脚本中。

  • 若使用Groovy DSL，在buildSrc/build.gradle中添加如下配置：

    plugins {
        id 'java'
    }
    
    java {
        toolchain {
            languageVersion = JavaLanguageVersion.of(11)
        }
    }
    

  • 若使用Kotlin DSL，在buildSrc/build.gradle.kts中添加如下配置：

    plugins {
        `java`
    }
    
    java {
        toolchain {
            languageVersion.set(JavaLanguageVersion.of(11))
        }
    }
    

运行逻辑说明 #

配置完成后，Gradle会自动拆分JDK使用逻辑：

• 环境中默认安装的Java 8仅用于启动Gradle主进程，Gradle 7.x本身完全兼容Java 8启动，不会出现版本冲突
• 进入配置阶段后，Gradle会检测到buildSrc声明了Java 11的toolchain要求，自动从默认的Adoptium JDK源下载对应系统、架构的Java 11发行版，缓存到~/.gradle/jdks目录（用户目录下，无需root权限）
• 后续buildSrc代码编译、自定义任务类加载执行，都会自动使用下载好的Java 11环境，不会再出现自定义任务的版本兼容错误

注意事项 #

• 根项目下配置的java toolchain仅对主项目源码、测试代码生效，无法约束buildSrc本身的构建JDK版本，必须将配置写到buildSrc目录下的构建脚本中
• 若处于内网环境无法访问公网JDK源，可以在项目settings.gradle中配置toolchain的自定义镜像源，该配置对buildSrc的JDK下载同样生效
• Gradle 7.0以下版本无该特性支持，没有其他兼容方案，必须升级wrapper版本

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