Google consiglia vivamente di non controllare una chiave API nel tuo sistema di controllo della versione. Dovresti invece archiviarlo in un file secrets.properties
locale, che si trova nella directory root del progetto ma escluso dal controllo della versione, quindi 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, da un file delle proprietà non archiviato in un sistema di controllo della versione. Quindi, il plug-in espone 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 la pagina 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 il file
build.gradle
obuild.gradle.kts
di primo livello e aggiungi il seguente codice all'elementodependencies
inbuildscript
.Trendy
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") } }
-
Apri il file
build.gradle
a livello di modulo e aggiungi il seguente codice all'elementoplugins
.Trendy
plugins { // ... id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin' }
Kotlin
plugins { id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin") }
- Nel file
build.gradle
a livello di modulo, assicurati chetargetSdk
ecompileSdk
siano impostati su 34. - Salva il file e sincronizza il progetto con Gradle.
-
Apri il file
secrets.properties
nella directory di primo livello e aggiungi il codice seguente. SostituisciYOUR_API_KEY
con la tua chiave API. Archivia la chiave in questo file perchésecrets.properties
è escluso dal check-in in un sistema di controllo della versione.MAPS_API_KEY=YOUR_API_KEY
- Salva il file.
-
Crea il file
local.defaults.properties
nella directory di primo livello, la stessa cartella del filesecrets.properties
, quindi aggiungi il codice seguente.MAPS_API_KEY=DEFAULT_API_KEY
Lo scopo di questo file è fornire un percorso di backup per la chiave API nel caso in cui il file
secrets.properties
non venga trovato, in modo che le build non generino errori. Questo può accadere 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 la tua 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}" />
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 namecom.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. -
In Android Studio, open your module-level
build.gradle
orbuild.gradle.kts
file and edit thesecrets
property. If thesecrets
property does not exist, add it.Edit the properties of the plugin to set
propertiesFileName
tosecrets.properties
, setdefaultPropertiesFileName
tolocal.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.*" }
Passaggi successivi
- Visualizza la pagina del progetto GitHub del plug-in Secrets Gradle per Android.
- Consulta la pagina Configurare un progetto Android Studio per un esempio completo dell'utilizzo del plug-in.
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2024-07-26 UTC.
[{ "type": "thumb-down", "id": "missingTheInformationINeed", "label":"Mancano le informazioni di cui ho bisogno" },{ "type": "thumb-down", "id": "tooComplicatedTooManySteps", "label":"Troppo complicato/troppi passaggi" },{ "type": "thumb-down", "id": "outOfDate", "label":"Obsoleti" },{ "type": "thumb-down", "id": "translationIssue", "label":"Problema di traduzione" },{ "type": "thumb-down", "id": "samplesCodeIssue", "label":"Problema relativo a esempi/codice" },{ "type": "thumb-down", "id": "otherDown", "label":"Altra" }] [{ "type": "thumb-up", "id": "easyToUnderstand", "label":"Facile da capire" },{ "type": "thumb-up", "id": "solvedMyProblem", "label":"Il problema è stato risolto" },{ "type": "thumb-up", "id": "otherUp", "label":"Altra" }]