如何在Android build.gradle中读取系统环境变量中的私密凭证

Windows环境读取返回null的核心原因 #

• 环境变量修改后没有重启IDE/终端：Android Studio、命令行工具会缓存启动时的环境变量，修改后必须完全退出重启，部分Windows版本需要注销当前账号重新登录才能全局生效
• 变量名大小写不匹配：Windows系统层面环境变量默认不区分大小写，但Gradle的System.getenv()方法是大小写敏感的，读取时的变量名必须和你设置的名称完全一致
• 用户变量/系统变量权限问题：如果给系统全局设置的变量，Gradle用普通用户权限启动会读取不到，优先给当前登录用户设置用户变量，测试前可以先在cmd执行echo %你的变量名%确认能正常输出值
• WSL环境变量隔离：如果在Windows下用WSL运行Gradle，WSL和Windows宿主的环境变量不互通，需要单独在WSL的shell配置文件里设置变量

基础实现方案 #

Gradle原生提供System.getenv("变量名")方法直接读取系统环境变量，无需额外插件。

提前配置环境变量 #

• Windows：在cmd执行setx 变量名 变量值，或者通过「此电脑-属性-高级系统设置-环境变量」图形化添加
• Mac/Linux：在~/.zshrc（Zsh用户）或~/.bash_profile（Bash用户）中添加export 变量名=变量值，保存后执行source 对应配置文件路径生效

build.gradle使用示例 #

以安卓签名配置为例，代码如下：

android {
    signingConfigs {
        release {
            storeFile file("./release.jks")
            // 读取环境变量里的签名密钥密码
            storePassword System.getenv("ANDROID_SIGN_STORE_PWD")
            keyAlias "release"
            keyPassword System.getenv("ANDROID_SIGN_KEY_PWD")
        }
    }

    buildTypes {
        release {
            signingConfig signingConfigs.release
        }
    }
}

兼容优化方案（避免null导致构建失败） #

可以添加判空兜底逻辑，读取不到环境变量时自动读取本地未提交的gradle.properties里的配置，方便本地开发调试：

// 自定义获取私密信息的方法
def getPrivateCredential(String key) {
    // 优先读取系统环境变量
    def envValue = System.getenv(key)
    if (envValue != null) {
        return envValue
    }
    // 兜底读取本地gradle.properties配置
    return project.hasProperty(key) ? project.property(key) : ""
}

// 把私密凭证注入到BuildConfig供业务代码调用
android {
    defaultConfig {
        buildConfigField "String", "THIRD_PARTY_API_SECRET", "\"${getPrivateCredential("THIRD_PARTY_API_SECRET")}\""
        resValue "string", "api_key", "${getPrivateCredential("API_KEY")}"
    }
}

注意：本地的gradle.properties必须添加到.gitignore中，禁止提交到代码仓库。

快速验证读取结果 #

可以在build.gradle中添加测试任务，执行./gradlew printCredential即可直接输出变量读取结果，不需要跑完整构建流程：

task printCredential {
    doLast {
        println "签名密钥密码读取结果：" + System.getenv("ANDROID_SIGN_STORE_PWD")
        println "第三方API密钥读取结果：" + System.getenv("THIRD_PARTY_API_SECRET")
    }
}

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