Android Studio中XML字符串如何引用密钥？MapBox API密钥配置失效

Android资源XML文件不支持直接引用Gradle/外部属性文件中的变量，所以你在mapbox_access_token.xml中写的${MAPBOX_API_KEY}不会被自动替换，这就是调试时密钥未生效的原因。以下是正确的配置方案和替代选项：

一、正确配置：通过Gradle将密钥注入资源 #

这种方式会让Gradle自动生成字符串资源，无需手动创建mapbox_access_token.xml文件，具体步骤如下：

1. 确保属性文件配置正确 #

• 根目录下的secrets.properties（已替换真实密钥）：

MAPBOX_API_KEY=你的真实MapBox密钥

• 根目录下的local.defaults.properties（含默认值）：

MAPBOX_API_KEY=DEFAULT_API_KEY

• 将secrets.properties添加到.gitignore，避免提交到GitHub：

/secrets.properties

2. 在App模块的build.gradle中配置属性读取与资源注入 #

Groovy版本（build.gradle）

// 读取属性文件
def secretsPropertiesFile = rootProject.file("secrets.properties")
def secretsProperties = new Properties()
if (secretsPropertiesFile.exists()) {
    secretsProperties.load(new FileInputStream(secretsPropertiesFile))
} else {
    // 加载默认配置
    def defaultPropertiesFile = rootProject.file("local.defaults.properties")
    secretsProperties.load(new FileInputStream(defaultPropertiesFile))
}

android {
    defaultConfig {
        // 生成字符串资源mapbox_access_token
        resValue("string", "mapbox_access_token", secretsProperties["MAPBOX_API_KEY"])
    }
}

Kotlin DSL版本（build.gradle.kts）

val secretsPropertiesFile = rootProject.file("secrets.properties")
val secretsProperties = Properties().apply {
    if (secretsPropertiesFile.exists()) {
        load(FileInputStream(secretsPropertiesFile))
    } else {
        load(FileInputStream(rootProject.file("local.defaults.properties")))
    }
}

android {
    defaultConfig {
        resValue("string", "mapbox_access_token", secretsProperties["MAPBOX_API_KEY"] as String)
    }
}

3. 代码中使用密钥 #

同步Gradle后，直接通过资源ID获取密钥：

val accessToken = getString(R.string.mapbox_access_token)
Mapbox.getInstance(this, accessToken)

二、替代方案 #

1. 使用BuildConfig字段 #

如果更倾向于通过代码常量获取密钥，可以配置BuildConfig字段：

Groovy版本

android {
    defaultConfig {
        // 注意添加双引号转义，确保生成的是字符串常量
        buildConfigField("String", "MAPBOX_API_KEY", "\"${secretsProperties["MAPBOX_API_KEY"]}\"")
    }
}

Kotlin DSL版本

android {
    defaultConfig {
        buildConfigField("String", "MAPBOX_API_KEY", "\"${secretsProperties["MAPBOX_API_KEY"]}\"")
    }
}

代码中使用：

Mapbox.getInstance(this, BuildConfig.MAPBOX_API_KEY)

2. Manifest占位符（适用于Manifest中需要密钥的场景） #

如果需要在AndroidManifest.xml中引用密钥，可配置Manifest占位符：

Groovy版本

android {
    defaultConfig {
        manifestPlaceholders = [MAPBOX_API_KEY: secretsProperties["MAPBOX_API_KEY"]]
    }
}

Kotlin DSL版本

android {
    defaultConfig {
        manifestPlaceholders["MAPBOX_API_KEY"] = secretsProperties["MAPBOX_API_KEY"] as String
    }
}

Manifest中引用：

<meta-data
    android:name="com.mapbox.access_token"
    android:value="${MAPBOX_API_KEY}" />

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