Plug-in Secrets Gradle

Google consiglia vivamente di non archiviare una chiave API nel sistema di controllo della versione. Archiviala invece in un file locale secrets.properties, che si trova nella directory root del tuo progetto ma è escluso dal controllo della versione, quindi utilizza il plug-in Secrets Gradle per Android per leggere la chiave API.

Il plug-in Secrets Gradle per Android legge i secret, inclusa la chiave API, da un file di proprietà non archiviato in un sistema di controllo della versione. Il plug-in espone quindi queste proprietà come variabili nella classe BuildConfig generata da Gradle e nel file manifest Android.

Per un esempio completo di utilizzo del plug-in Secrets Gradle per Android per accedere a una chiave API, consulta Configurare un progetto Android Studio.

Installazione e utilizzo

Per installare il plug-in Secrets Gradle per Android e archiviare la chiave API:

  1. In Android Studio, apri il file build.gradle.kts o build.gradle di primo livello e aggiungi il seguente codice al blocco plugins.

    Kotlin

    plugins {
    // ...
    id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin") version "2.0.1" apply false
}

    Groovy

    plugins {
    // ...
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin' version '2.0.1' apply false
}
  2. Apri il file build.gradle.kts o build.gradle a livello di modulo e aggiungi il seguente codice all'elemento plugins.

    Kotlin

    plugins {
    id("com.android.application")
    // ...
    id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
}

    Groovy

    plugins {
    id 'com.android.application'
    // ...
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
}
  3. Se utilizzi Android Studio, sincronizza il progetto con Gradle.
  4. Apri il file secrets.properties nella directory di primo livello, e aggiungi il seguente codice. Sostituisci YOUR_API_KEY con la tua chiave API. Assicurati di aggiungere secrets.properties al tuo .gitignore file (o di escluderlo in altro modo dal sistema di controllo della versione) in modo da non archiviare la chiave API nel controllo della versione. 
    MAPS_API_KEY=YOUR_API_KEY

  5. Crea il file local.defaults.properties nella directory di primo livello, nella stessa cartella del file secrets.properties quindi aggiungi il seguente codice.

    MAPS_API_KEY=DEFAULT_API_KEY

    Lo scopo di questo file è fornire una posizione di backup per la chiave API se il file secrets.properties non viene trovato, in modo che le build non vadano in errore. Questo può accadere se cloni l'app da un sistema di controllo della versione che omette secrets.properties e non hai ancora creato un file secrets.properties in locale per fornire la chiave API.

  6. Nel file AndroidManifest.xml, vai a com.google.android.geo.API_KEY e aggiorna l'attributo android:value come segue: 
    <meta-data
    android:name="com.google.android.geo.API_KEY"
    android:value="${MAPS_API_KEY}" />

    Nota: com.google.android.geo.API_KEY è il nome dei metadati consigliato per la chiave API. Una chiave con questo nome può essere utilizzata per l'autenticazione a multiple Google Maps-based APIs sulla piattaforma Android, incluso the Maps SDK for Android. Per la compatibilità con le versioni precedenti, l'API supporta anche il nome com.google.android.maps.v2.API_KEY. Questo nome legacy consente l'autenticazione solo all'API di Google Maps Android v2. Un'applicazione può specificare solo uno dei nomi dei metadati della chiave API. Se vengono specificati entrambi, l'API genera un'eccezione.

  7. In Android Studio, apri il file a livello di modulo build.gradle.kts o build.gradle e modifica la proprietà secrets. Se la proprietà secrets non esiste, aggiungila.

    Modifica le proprietà del plug-in per impostare propertiesFileName su "secrets.properties", impostare defaultPropertiesFileName su "local.defaults.properties" e qualsiasi altra proprietà.

    Kotlin

    secrets {
    // To add your Maps API key to this project:
    // 1. If the secrets.properties file does not exist, create it in the root directory (the same folder as the root local.properties file).
    // 2. Add this line, where YOUR_API_KEY is your API key:
    //        MAPS_API_KEY=YOUR_API_KEY
    propertiesFileName = "secrets.properties"

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

    Groovy

    secrets {
    // To add your Maps API key to this project:
    // 1. If the secrets.properties file does not exist, create it in the root directory (the same folder as the root local.properties file).
    // 2. Add this line, where YOUR_API_KEY is your API key:
    //        MAPS_API_KEY=YOUR_API_KEY
    propertiesFileName = "secrets.properties"

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

Passaggi successivi