Configurare un progetto Android Studio

In questa pagina viene spiegato come integrare l'SDK di navigazione nel progetto di sviluppo.

Aggiungere l'SDK Navigation al progetto

L'SDK di navigazione è disponibile tramite il repository Google Maven. Puoi aggiungere l'SDK al progetto utilizzando la configurazione Gradle build.gradle o Maven pom.xml.

  1. Aggiungi la seguente dipendenza alla configurazione Gradle o Maven, sostituendo il segnaposto VERSION_NUMBER con la versione desiderata dell'SDK di navigazione per Android.

    Gradle

    Aggiungi quanto segue al campo build.gradle a livello di modulo:

    dependencies {
        ...
        implementation 'com.google.android.libraries.navigation:navigation:VERSION_NUMBER'
}

    Maven

    Aggiungi il seguente codice a pom.xml:

    <dependencies>
  ...
  <dependency>
    <groupId>com.google.android.libraries.navigation</groupId>
    <artifactId>navigation</artifactId>
    <version>VERSION_NUMBER</version>
  </dependency>
</dependencies>

  2. Se hai dipendenze che utilizzano l'SDK Maps, devi escludere la dipendenza in ogni dipendenza dichiarata che si basa sull'SDK Maps.

    Gradle

    Aggiungi quanto segue al tuo build.gradle di primo livello:

    allprojects {
        ...
        // Required: you must exclude the Google Play service Maps SDK from
        // your transitive dependencies. This is to ensure there won't be
        // multiple copies of Google Maps SDK in your binary, as the Navigation
        // SDK already bundles the Google Maps SDK.
        configurations {
            implementation {
                exclude group: 'com.google.android.gms', module: 'play-services-maps'
            }
        }
}

    Maven

    Aggiungi il seguente codice a pom.xml:

    <dependencies>
  <dependency>
  <groupId>project.that.brings.in.maps</groupId>
  <artifactId>MapsConsumer</artifactId>
  <version>1.0</version>
    <exclusions>
      <!-- Navigation SDK already bundles Maps SDK. You must exclude it to prevent duplication-->
      <exclusion>  <!-- declare the exclusion here -->
        <groupId>com.google.android.gms</groupId>
        <artifactId>play-services-maps</artifactId>
      </exclusion>
    </exclusions>
  </dependency>
</dependencies>

Configura la build

Dopo aver creato il progetto, puoi configurare le impostazioni per una build e un utilizzo riusciti dell'SDK di navigazione.

Aggiornare le proprietà locali

  • Nella cartella Gradle Scripts, apri il file local.properties e aggiungi android.useDeprecatedNdk=true.

Aggiorna proprietà Gradle

  • Nella cartella Gradle Scripts, apri il file gradle.properties e aggiungi il codice seguente se non è già presente:

    1. android.useAndroidX=true
    2. android.enableJetifier=true

Aggiorna lo script di build Gradle

  • Apri il file build.gradle (Module:app) e utilizza le seguenti linee guida per aggiornare le impostazioni in modo da soddisfare i requisiti dell'SDK di navigazione e valuta la possibilità di impostare anche le opzioni di ottimizzazione.

    Impostazioni richieste per l'SDK Navigation

    1. Imposta minSdkVersion su 23 o superiore.
    2. Imposta targetSdkVersion su 34 o superiore.
    3. Aggiungi un'impostazione di dexOptions che aumenti il valore di javaMaxHeapSize.
    4. Imposta la posizione per le librerie aggiuntive.
    5. Aggiungi repositories e dependencies per l'SDK di navigazione.
    6. Sostituisci i numeri di versione nelle dipendenze con le ultime versioni disponibili.

    Impostazioni facoltative per ridurre il tempo di compilazione

    • Abilita la contrazione del codice e delle risorse utilizzando R8/ProGuard per rimuovere le risorse e il codice inutilizzati dalle dipendenze. Se l'esecuzione del passaggio R8/ProGuard richiede troppo tempo, valuta la possibilità di abilitare multidex per le attività di sviluppo.
    • Riduci il numero di traduzioni in diverse lingue incluse nella build: imposta resConfigs per una lingua durante lo sviluppo. Per la compilazione finale, imposta resConfigs per le lingue che utilizzi effettivamente. Per impostazione predefinita, Gradle include le stringhe di risorse per tutte le lingue supportate dall'SDK Navigation.

    Aggiungere il desugaring per il supporto Java8

    • Se stai creando la tua app utilizzando il plug-in Android per Gradle 4.0.0 o versioni successive, il plug-in estende il supporto per l'utilizzo di una serie di API del linguaggio Java 8. Per ulteriori informazioni, consulta Supporto per il desugaring di Java 8. Per informazioni sulle opzioni di compilazione e dipendenza, vedi lo snippet dello script di build di esempio riportato di seguito.
    • Ti consigliamo di utilizzare Gradle 8.4, il plug-in Android per Gradle versione 8.3.0 e la libreria Desugarcom.android.tools:desugar_jdk_libs_nio:2.0.3. Questa configurazione è compatibile con l'SDK di navigazione per Android 6.0.0 e versioni successive.
    • La libreria Desugar deve essere abilitata per il modulo app e per tutti i moduli che dipendono direttamente dall'SDK di navigazione.

Di seguito è riportato un esempio di script di compilazione Gradle per l'applicazione. Controlla se nelle app di esempio sono presenti insiemi di dipendenze aggiornati, poiché la versione dell'SDK di navigazione in uso potrebbe essere leggermente in avanti o indietro rispetto a questa documentazione.

apply plugin: 'com.android.application'

ext {
    navSdk = "__NAVSDK_VERSION__"
}

android {
    compileSdk 33
    buildToolsVersion='28.0.3'

    defaultConfig {
        applicationId "<your id>"
        // Navigation SDK supports SDK 23 and later.
        minSdkVersion 23
        targetSdkVersion 34
        versionCode 1
        versionName "1.0"
        // Set this to the languages you actually use, otherwise you'll include resource strings
        // for all languages supported by the Navigation SDK.
        resConfigs "en"
        multiDexEnabled true
    }

    dexOptions {
        // This increases the amount of memory available to the dexer. This is required to build
        // apps using the Navigation SDK.
        javaMaxHeapSize "4g"
    }
    buildTypes {
        // Run ProGuard. Note that the Navigation SDK includes its own ProGuard configuration.
        // The configuration is included transitively by depending on the Navigation SDK.
        // If the ProGuard step takes too long, consider enabling multidex for development work
        // instead.
        all {
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
    compileOptions {
        // Flag to enable support for the new language APIs
        coreLibraryDesugaringEnabled true
        // Sets Java compatibility to Java 8
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

repositories {
    // Navigation SDK for Android and other libraries are hosted on Google's Maven repository.
    google()
}

dependencies {
    // Include the Google Navigation SDK.
    // Note: remember to exclude Google Play service Maps SDK from your transitive
    // dependencies to avoid duplicate copies of the Google Maps SDK.
    api "com.google.android.libraries.navigation:navigation:${navSdk}"

    // Declare other dependencies for your app here.

    annotationProcessor "androidx.annotation:annotation:1.7.0"
    coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs_nio:2.0.3'
}

Aggiungi la chiave API all'app

Questa sezione descrive come archiviare la chiave API in modo che l'app possa farvi riferimento in modo sicuro. Non dovresti verificare la chiave API nel tuo sistema di controllo della versione, quindi ti consigliamo di memorizzarla nel file secrets.properties, che si trova nella directory radice del tuo progetto. Per ulteriori informazioni sul file secrets.properties, consulta File delle proprietà di Gradle.

Per semplificare questa attività, ti consigliamo di utilizzare il plug-in Secrets Gradle per Android.

Per installare il plug-in Secrets Gradle per Android nel tuo progetto Google Maps:

  1. In Android Studio, apri il file build.gradle.kts o build.gradle di primo livello e aggiungi il seguente codice all'elemento dependencies in buildscript.

    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"
    }
}
  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.google.android.libraries.mapsplatform.secrets-gradle-plugin")
}

    Trendy

    plugins {
    // ...
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
}
  3. Nel file build.gradle.kts o build.gradle a livello di modulo, assicurati che targetSdk e compileSdk siano impostati su 34.
  4. Salva il file e sincronizza il progetto con Gradle.
  5. Apri il file secrets.properties nella directory di primo livello e aggiungi il codice seguente. Sostituisci YOUR_API_KEY con la tua chiave API. Memorizza la chiave in questo file perché secrets.properties è esclusa dal controllo in un sistema di controllo delle versioni. 
    NAV_API_KEY=YOUR_API_KEY
  6. Salva il file.

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

    NAV_API_KEY=DEFAULT_API_KEY

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

  8. Salva il file.
  9. Nel file AndroidManifest.xml, vai a com.google.android.geo.API_KEY e aggiorna android:value attribute. Se il tag <meta-data> non esiste, crealo come tag 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 consigliato per i metadati per la chiave API. Una chiave con questo nome può essere utilizzata per autenticarsi in più API basate su Google Maps sulla piattaforma Android, incluso l'SDK Navigation per Android. Per garantire la compatibilità con le versioni precedenti, l'API supporta anche il nome com.google.android.maps.v2.API_KEY. Questo nome precedente consente l'autenticazione solo nell'API di Android Maps v2. Un'applicazione può specificare solo uno dei nomi dei metadati della chiave API. Se vengono specificati entrambi, l'API genera un'eccezione.

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

    Modifica le proprietà del plug-in per impostare propertiesFileName su secrets.properties, defaultPropertiesFileName su local.defaults.properties e 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.*"
}

Includi le attribuzioni richieste nella tua app

Se nella tua app utilizzi l'SDK Navigation per Android, devi includere il testo di attribuzione e le licenze open source nella sezione delle notifiche legali dell'app.

Puoi trovare il testo di attribuzione richiesto e le licenze open source nel file zip dell'SDK Navigation per Android:

  • NOTICE.txt
  • LICENSES.txt

Se sei un cliente di soluzioni di mobilità o di Fleet Engine Deliveries

Se sei un cliente di soluzioni per la mobilità o le consegne di Fleet Engine, scopri di più sulla fatturazione nella documentazione relativa alla mobilità. Per maggiori informazioni sulla registrazione delle transazioni, consulta gli articoli Configurare la fatturazione, Registrare le transazioni fatturabili, Reporting e Registrare le transazioni fatturabili (Android).