Configurare un progetto Android Studio

Questa pagina spiega come integrare l'SDK Navigation nel tuo progetto di sviluppo.

Aggiungi l'SDK Navigation al progetto

L'SDK Navigation è disponibile tramite il repository Maven di Google. Puoi aggiungere l'SDK al tuo 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 di Navigation SDK for Android.

    Gradle

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

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

    Maven

    Aggiungi quanto segue 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 Maps SDK, devi escludere la dipendenza in ogni dipendenza dichiarata che si basa su Maps SDK.

    Gradle

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

    allprojects {
        ...
        // Required: you must exclude the Google Play service Maps SDK from
        // your transitive dependencies to make sure 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 quanto segue 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 corretta creazione e un utilizzo ottimale di Navigation SDK.

Aggiorna le proprietà locali

  • Nella cartella Gradle Scripts, apri il file local.properties e aggiungi android.useDeprecatedNdk=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 di Navigation SDK e valuta la possibilità di impostare anche le opzioni Ottimizza.

    Impostazioni obbligatorie per l'SDK Navigation

    1. Imposta minSdkVersion su 24 o un valore superiore.
    2. Imposta targetSdkVersion su 36 o un valore superiore.
    3. Aggiungi un'impostazione dexOptions che aumenta il valore di javaMaxHeapSize.
    4. Imposta la posizione delle raccolte aggiuntive.
    5. Aggiungi repositories e dependencies per Navigation SDK.
    6. Sostituisci i numeri di versione nelle dipendenze con le ultime versioni disponibili.

    Impostazioni facoltative per ridurre i tempi di build

    • Attiva la riduzione del codice e delle risorse utilizzando R8/ProGuard per rimuovere il codice e le risorse non utilizzati dalle dipendenze. Se il passaggio R8/ProGuard richiede troppo tempo, valuta la possibilità di attivare la configurazione multidex per il lavoro di sviluppo.
    • Riduci il numero di traduzioni linguistiche incluse nella build: imposta resConfigs per una lingua durante lo sviluppo. Per la build finale, imposta resConfigs per le lingue che utilizzi effettivamente. Per impostazione predefinita, Gradle include stringhe di risorse per tutte le lingue supportate dal Navigation SDK.

    Aggiungi il desugaring per il supporto di Java8

    • Se crei 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 saperne di più, consulta Supporto del desugaring di Java 8. Consulta lo snippet di esempio dello script di build riportato di seguito per informazioni sulle opzioni di compilazione e dipendenza.
    • Utilizza le versioni di Gradle, del plug-in Android per Gradle (AGP) e della libreria Desugar che corrispondono alla versione dell'SDK di Navigation. Consulta la tabella seguente.
    • La libreria Desugar deve essere abilitata per il modulo app e per qualsiasi modulo che dipende direttamente dall'SDK Navigation.

La tabella seguente elenca le versioni delle librerie Gradle, AGP e Desugar richieste per ogni versione dell'SDK di navigazione.

Versione SDK Navigation Versione di Gradle Versione AGP Libreria di desugaring
8.0.0 e versioni successive 9.1.0 9.0.1 com.android.tools:desugar_jdk_libs_nio:2.1.5
7.7.0 - 7.9.0 8.13 8.13.2 com.android.tools:desugar_jdk_libs_nio:2.1.5
7.3.0 - 7.6.0 8.11.1 8.10.0 com.android.tools:desugar_jdk_libs_nio:2.0.3

Di seguito è riportato un esempio dello script di build Gradle per l'applicazione. Controlla le app di esempio per i set di dipendenze aggiornati, poiché la versione dell'SDK di navigazione che utilizzi potrebbe essere leggermente più recente o precedente 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.1.5'
}

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 devi inserire la chiave API nel sistema di controllo della versione, quindi ti consigliamo di archiviarla in un file secrets.properties nella directory root del progetto ed escludere il file dal controllo della versione. Per ulteriori informazioni sui file delle proprietà di Gradle, 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 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, quindi aggiungi il codice seguente. Sostituisci YOUR_API_KEY con la tua chiave API. Assicurati di aggiungere secrets.properties al file .gitignore (o di escluderlo in altro modo dal sistema di controllo della versione) in modo da non inserire 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, la stessa cartella del file secrets.properties, quindi aggiungi il codice seguente.

    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 abbiano esito negativo. 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 localmente per fornire la tua chiave API.

  6. Puoi aggiungere la chiave API al file AndroidManifest.xml o fornirla in modo programmatico.
    • Aggiungi la tua chiave API a AndroidManifest.xml: 
      <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 in più API basate su Google Maps sulla piattaforma Android, incluso l'SDK Navigation per 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 per l'API di Google Maps per Android v2. Un'applicazione può specificare solo uno dei nomi dei metadati della chiave API. Se vengono specificati entrambi, l'API genera un'eccezione.

    • Fornisci la chiave API in modo programmatico:

      Il plug-in Secrets Gradle rende disponibile la chiave nella classe BuildConfig. Nell'inizializzazione dell'app (ad esempio nel metodo Application.onCreate()), chiama il metodo come segue:

      Kotlin

      1. Aggiungi le seguenti istruzioni di importazione: 
        import com.google.android.libraries.navigation.NavigationApi
      2. Aggiungi quanto segue al metodo Application.onCreate(): 
        NavigationApi.setApiKey(BuildConfig.MAPS_API_KEY)

      Java

      1. Aggiungi le seguenti istruzioni di importazione: 
        import com.google.android.libraries.navigation.NavigationApi;
      2. Aggiungi quanto segue al metodo Application.onCreate(): 
        NavigationApi.setApiKey(BuildConfig.MAPS_API_KEY);
      Nota: quando utilizzi setApiKey(), tieni presente quanto segue:
      • Fornisci una chiave API non null e non vuota.
      • Chiama setApiKey() una sola volta durante il ciclo di vita dell'applicazione. Il metodo genera un IllegalStateException se viene chiamato più di una volta.
      • Chiama setApiKey() prima di inizializzare qualsiasi altro componente dell'SDK Navigation, ad esempio Navigator.
      • La chiave fornita con questo metodo sostituisce qualsiasi chiave API nel tuo AndroidManifest.xml.
      • Utilizza l'SDK Navigation versione 7.6 o successive.

  7. 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 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"
}

Includi le attribuzioni richieste nella tua app

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

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

  • NOTICE.txt
  • LICENSES.txt

Se sei un cliente di Mobility o Fleet Engine Deliveries

Se sei un cliente di Mobility o Fleet Engine Deliveries, scopri di più sulla fatturazione nella documentazione di Mobility. Per saperne di più sulla registrazione delle transazioni, consulta Configura la fatturazione, Registra le transazioni fatturabili, Reporting e Registra le transazioni fatturabili (Android).

Dipendenze manuali (non Gradle/Maven)

Se il tuo sistema di build non risolve le dipendenze transitive (come Bazel) o se integri l'AAR manualmente, devi aggiungere queste dipendenze al tuo progetto. Gradle e Maven li risolvono automaticamente.

  • androidx.datastore:datastore-core
  • androidx.datastore:datastore-guava
  • com.google.guava:listenablefuture
  • androidx.concurrent:concurrent-futures