Android Java应用无法读取BuildConfig中从apikey.properties导入的变量

问题根因 #

• apikey.properties格式不符合规范：当前文件中CLIENT_ID、CLIENT_SECRET两个键缺失，CLIENT_yyy、CLIENT_zzz不符合properties文件key=value的键值对格式，无法被正常读取。
• Properties流加载方式错误：使用newDataInputStream()读取properties文本文件会出现解析异常，该方法是用于读写Java基础类型二进制数据的，不适合加载文本配置。
• 拼写错误：你提供的properties文件中GRANT_TYPE的值拼写错误，多打了一个字母a，会导致后续业务逻辑异常。

修复步骤 #

1. 修正apikey.properties内容 #

调整为标准键值对格式：

SCOPE=xxx
CLIENT_ID=yyy
CLIENT_SECRET=zzz
GRANT_TYPE=client_credentials

2. 修正build.gradle(:app)的配置读取逻辑 #

替换原有Properties加载段的代码：

Properties properties = new Properties()
def apiKeyFile = rootProject.file("apikey.properties")
if (apiKeyFile.exists()) {
    // 使用普通文件流加载，指定UTF-8编码避免乱码
    apiKeyFile.withInputStream("UTF-8") { stream ->
        properties.load(stream)
    }
} else {
    // 本地开发缺失配置直接抛出异常，避免后续空值排查成本
    throw new GradleException("根目录下未找到apikey.properties文件，请检查配置")
}

// 读取属性时增加兜底，避免空值
def scope = properties.getProperty("SCOPE") ?: ""
def client_Id = properties.getProperty("CLIENT_ID") ?: ""
def client_Secret = properties.getProperty("CLIENT_SECRET") ?: ""
def grant_Type = properties.getProperty("GRANT_TYPE") ?: ""

3. 重新生成BuildConfig #

所有配置修改完成后，执行 Build > Clean Project 再执行 Build > Rebuild Project，确保新的配置写入到BuildConfig类中。

兼容本地开发+DevOps流水线的通用方案 #

核心逻辑是优先读取环境变量，环境变量不存在时再读取本地配置文件，既避免敏感配置提交到代码库，也不需要在流水线中额外生成配置文件：

Properties properties = new Properties()
def apiKeyFile = rootProject.file("apikey.properties")

// 优先读取系统环境变量，适配DevOps流水线注入场景
def scope = System.getenv("SCOPE")
def client_Id = System.getenv("CLIENT_ID")
def client_Secret = System.getenv("CLIENT_SECRET")
def grant_Type = System.getenv("GRANT_TYPE")

// 环境变量不存在时读取本地配置文件，适配本地开发场景
if (!scope || !client_Id || !client_Secret || !grant_Type) {
    if (apiKeyFile.exists()) {
        apiKeyFile.withInputStream("UTF-8") { stream ->
            properties.load(stream)
        }
        scope = scope ?: properties.getProperty("SCOPE") ?: ""
        client_Id = client_Id ?: properties.getProperty("CLIENT_ID") ?: ""
        client_Secret = client_Secret ?: properties.getProperty("CLIENT_SECRET") ?: ""
        grant_Type = grant_Type ?: properties.getProperty("GRANT_TYPE") ?: ""
    } else {
        throw new GradleException("未找到有效配置：既没有注入环境变量，也没有找到本地apikey.properties文件")
    }
}

配套规则 #

• 本地开发：将apikey.properties加入.gitignore，禁止提交到代码仓库，开发者本地自行维护该配置文件即可。
• DevOps流水线：在构建任务中提前注入SCOPE、CLIENT_ID、CLIENT_SECRET、GRANT_TYPE四个环境变量，构建时会自动读取环境变量生成对应BuildConfig值，不需要依赖properties文件。

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