Google consiglia vivamente di non controllare una chiave API nelle
di controllo della versione. Devi archiviarlo in un file secrets.properties
locale,
che si trova nella directory principale del progetto, ma è esclusa dal controllo della versione,
Utilizzare 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,
di un file delle proprietà di cui non è stato inserito
il controllo in un sistema di controllo della versione. Il plug-in mostra quindi queste proprietà.
come variabili nella classe BuildConfig
generata da Gradle e nel file manifest Android.
Per un esempio completo dell'utilizzo del plug-in Secrets Gradle per Android per accedere a una chiave API, consulta l'articolo Configurare un progetto Android Studio.
Installazione e utilizzo
Per installare il plug-in Secrets Gradle per Android nel tuo progetto Google Maps:
-
In Android Studio, apri l'
build.gradle.kts
obuild.gradle
di primo livello e aggiungi il seguente codice all'elementodependencies
inbuildscript
.Kotlin
buildscript { dependencies { classpath("com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1") } }
Trendy
buildscript { dependencies { classpath "com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1" } }
-
Apri il file
build.gradle.kts
obuild.gradle
a livello di modulo e aggiungi il seguente codice all'elementoplugins
.Kotlin
plugins { // ... id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin") }
Trendy
plugins { // ... id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin' }
- Nel file
build.gradle.kts
obuild.gradle
a livello di modulo, assicurati chetargetSdk
ecompileSdk
sono impostati a 34. - Salva il file e sincronizzare il progetto con Gradle.
-
Apri il file
secrets.properties
nella directory di primo livello, quindi aggiungi seguire il codice. SostituisciYOUR_API_KEY
con la tua chiave API. Memorizza la chiave in questo file perchésecrets.properties
è escluso dall'archiviazione in un controllo della versione di un sistema operativo completo.MAPS_API_KEY=YOUR_API_KEY
- Salva il file.
-
Crea il file
local.defaults.properties
nella directory di primo livello, uguale cartella come filesecrets.properties
, quindi aggiungi il codice riportato di seguito.MAPS_API_KEY=DEFAULT_API_KEY
Lo scopo di questo file è fornire un percorso di backup per la chiave API se Impossibile trovare il file
secrets.properties
per evitare errori di build. Ciò può verificarsi se cloni l'app da un sistema di controllo della versione che omettesecrets.properties
e non hai ancora creato un filesecrets.properties
in locale per fornire chiave API. - Salva il file.
-
Nel file
AndroidManifest.xml
, vai acom.google.android.geo.API_KEY
e aggiornaandroid:value attribute
. Se il tag<meta-data>
non esiste, crealo come elemento secondario del Tag<application>
.<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 eseguire l'autenticazione API basate su Google Maps sulla piattaforma Android, tra cui Maps SDK per Android. Per garantire la compatibilità con le versioni precedenti, l'API supporta il nomecom.google.android.maps.v2.API_KEY
. Questa eredità permette l'autenticazione solo all'API di Android Maps v2. Un'applicazione può specificare solo uno dei nomi dei metadati delle chiavi API. Se sono specificati entrambi, l'API genera un'eccezione. -
In Android Studio, apri l'
build.gradle.kts
a livello di modulo oppurebuild.gradle
e modifica la proprietàsecrets
. Se La proprietàsecrets
non esiste. Aggiungila.Modifica le proprietà del plug-in impostando
propertiesFileName
susecrets.properties
, impostadefaultPropertiesFileName
sulocal.defaults.properties
e imposta eventuali altre 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 same folder as the 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" // 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.*" }
Trendy
secrets { // To add your Maps API key to this project: // 1. If the secrets.properties file does not exist, create it in the same folder as the 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" // 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.*" }
Passaggi successivi
- Visualizza il plug-in Secrets Gradle per Android Pagina del progetto GitHub.
- Visualizza la pagina Configurare un progetto Android Studio per un esempio completo di utilizzo .