Secrets Gradle 插件

Google 强烈建议不要将 API 密钥签入版本控制系统。请改为将 API 密钥存储在本地 secrets.properties 文件中，该文件位于项目根目录下，但不在版本控制系统中，然后使用 Android 版 Secrets Gradle 插件读取 API 密钥。

Android 版 Secrets Gradle 插件可从未签入版本控制系统的属性文件中读取 Secret（包括 API 密钥）。然后，此插件会在 Gradle 生成的 BuildConfig 类和 Android 清单文件中，将这些属性公开为变量。

如需查看使用 Android 版 Secrets Gradle 插件访问 API 密钥的完整示例，请参阅设置 Android Studio 项目。

安装和使用

如需在 Google 地图项目中安装 Android 版 Secret Gradle 插件，请执行以下操作：

  1. 在 Android Studio 中，打开顶级 build.gradle 或 build.gradle.kts 文件，并将以下代码添加到 buildscript 下的 dependencies 元素中。

    Groovy

    buildscript {
    dependencies {
        classpath "com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1"
    }
}

    Kotlin

    buildscript {
    dependencies {
        classpath("com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1")
    }
}
  2. 打开模块级 build.gradle 文件，并将以下代码添加到 plugins 元素中。

    Groovy

    plugins {
    // ...
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
}

    Kotlin

    plugins {
    id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
}
  3. 在模块级 build.gradle 文件中，确保 targetSdk 和 compileSdk 已设置为 34。
  4. 保存文件并将项目与 Gradle 同步。
  5. 在顶级目录中打开 secrets.properties 文件，然后添加以下代码。将 YOUR_API_KEY 替换为您的 API 密钥。secrets.properties 不会签入版本控制系统，因此请将您的密钥存储在此文件中。 
    MAPS_API_KEY=YOUR_API_KEY
  6. 保存文件。

  7. 在顶级目录（即 secrets.properties 文件所在的同一文件夹）中创建 local.defaults.properties 文件，然后添加以下代码。

    MAPS_API_KEY=DEFAULT_API_KEY

    此文件的用途是，在找不到 secrets.properties 文件的情况下，为 API 密钥提供备用位置，以免构建失败。如果您是从省略 secrets.properties 的版本控制系统中克隆应用，而您在本地还没有创建 secrets.properties 文件来提供 API 密钥，就可能会出现上述情况。

  8. 保存文件。
  9. 在 AndroidManifest.xml 文件中，定位到 com.google.android.geo.API_KEY 并更新 android:value attribute。如果 <meta-data> 标记不存在，请创建该标记作为 <application> 标记的子标记。 
    <meta-data
    android:name="com.google.android.geo.API_KEY"
    android:value="${MAPS_API_KEY}" />

    Note: com.google.android.geo.API_KEY is the recommended metadata name for the API key. A key with this name can be used to authenticate to multiple Google Maps-based APIs on the Android platform, including the Maps SDK for Android. For backwards compatibility, the API also supports the name com.google.android.maps.v2.API_KEY. This legacy name allows authentication to the Android Maps API v2 only. An application can specify only one of the API key metadata names. If both are specified, the API throws an exception.

  10. In Android Studio, open your module-level build.gradle or build.gradle.kts file and edit the secrets property. If the secrets property does not exist, add it.

    Edit the properties of the plugin to set propertiesFileName to secrets.properties, set defaultPropertiesFileName to local.defaults.properties, and set any other properties.

    Groovy

    secrets {
    // Optionally specify a different file name containing your secrets.
    // The plugin defaults to "local.properties"
    propertiesFileName = "secrets.properties"

    // A properties file containing default secret values. This file can be
    // checked in version control.
    defaultPropertiesFileName = "local.defaults.properties"

    // Configure which keys should be ignored by the plugin by providing regular expressions.
    // "sdk.dir" is ignored by default.
    ignoreList.add("keyToIgnore") // Ignore the key "keyToIgnore"
    ignoreList.add("sdk.*")       // Ignore all keys matching the regexp "sdk.*"
}

    Kotlin

    secrets {
    // Optionally specify a different file name containing your secrets.
    // The plugin defaults to "local.properties"
    propertiesFileName = "secrets.properties"

    // A properties file containing default secret values. This file can be
    // checked in version control.
    defaultPropertiesFileName = "local.defaults.properties"

    // Configure which keys should be ignored by the plugin by providing regular expressions.
    // "sdk.dir" is ignored by default.
    ignoreList.add("keyToIgnore") // Ignore the key "keyToIgnore"
    ignoreList.add("sdk.*")       // Ignore all keys matching the regexp "sdk.*"
}

后续步骤