Secrets Gradle 外掛程式

Google 強烈建議您不要在版本管控系統登錄 API 金鑰。而是應該將 API 金鑰儲存在專案根目錄的 secrets.properties 檔案中 (但不在版本管控中)，然後使用 Secrets Gradle Plugin for Android 讀取金鑰。

Secrets Gradle for Android 會從未登錄在版本管控系統中的屬性檔案讀取 Secret，包括 API 金鑰。接著，這個外掛程式會在 Gradle 產生的 BuildConfig 類別和 Android 資訊清單檔案中，將這些屬性公開為變數。

如需使用 Secrets Gradle Plugin for Android 存取 API 金鑰的完整範例，請參閱「設定 Android Studio 專案」一文。

安裝與使用

如要在 Google 地圖專案中安裝 Secrets Gradle Plugin for Android，請按照下列步驟操作：

  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 金鑰。 
    MAPS_API_KEY=YOUR_API_KEY
  6. 儲存檔案。
  7. 找到 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}" />

  8. 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 the name of your local properties file (either local.properties or local.defaults.properties depending on how you created the project), 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.*"
}

後續步驟