Configurare un progetto Android Studio

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

Aggiungere 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.

Nota: questo metodo non è compatibile con alcune librerie che dipendono dall'SDK Navigation tramite l'ID elemento precedente. Sono incluse le release dell'SDK Driver 4.4 o precedenti.

1. Aggiungi la seguente dipendenza alla configurazione Gradle o Maven, sostituendo il segnaposto VERSION_NUMBER con la versione desiderata dell'SDK Navigation per 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>
   

   Nota: se sei un cliente di Mobility Services che esegue l'upgrade dal repository Maven privato originale, tieni presente che i nomi dei gruppi e degli elementi sono stati modificati e il plug-in com.google.cloud.artifactregistry.gradle-plugin non è più necessario.

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 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 la compilazione e l'utilizzo dell'SDK Navigation.

Aggiornare le proprietà locali

• Nella cartella Script Gradle, apri il file local.properties e aggiungiandroid.useDeprecatedNdk=true.

Aggiorna le proprietà gradle

• Nella cartella Script di Gradle, apri il file gradle.properties e aggiungi quanto segue, 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 Navigation 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 dexOptions che aumenti il valore javaMaxHeapSize.
  4. Imposta la posizione di librerie aggiuntive.
  5. Aggiungi repositories e dependencies per l'SDK Navigation.
  6. Sostituisci i numeri di versione nelle dipendenze con le ultime versioni disponibili.

  Impostazioni facoltative per ridurre il tempo di compilazione

  • Attiva la riduzione del codice e delle risorse utilizzando R8/ProGuard per rimuovere le risorse e il codice inutilizzati dalle dipendenze. Se la fase R8/ProGuard richiede troppo tempo per l'esecuzione, valuta la possibilità di attivare multidex per il lavoro di sviluppo.
  • Riduci il numero di traduzioni in lingua incluse nella compilazione: 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.

  Aggiunta del supporto per la desugaring per Java 8

  • Se stai creando la tua app utilizzando il plug-in Android 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 la rimozione di sugar da Java 8. Consulta lo snippet di script di compilazione di esempio riportato di seguito per informazioni su come compilare e sulle opzioni di dipendenza.
  • 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 Navigation per Android 6.0.0 e versioni successive.
  • La libreria Desugar deve essere attivata per il modulo app e per qualsiasi modulo che dipende direttamente dall'SDK Navigation.

Di seguito è riportato un esempio di script di compilazione Gradle per l'applicazione. Controlla le app di esempio per trovare insiemi aggiornati di dipendenze, poiché la versione dell'SDK Navigation che utilizzi potrebbe essere leggermente precedente o successiva 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 possa essere richiamata in modo sicuro dalla tua app. Non devi inserire la chiave API nel sistema di controllo delle versioni, quindi ti consigliamo di archiviarla nel file secrets.properties, che si trova nella directory principale del progetto. Per ulteriori informazioni sul file secrets.properties, consulta File di proprietà Gradle.

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

Nota: consulta la documentazione del plug-in Secrets Gradle per Android su GitHub per conoscere i requisiti di sistema e le istruzioni di installazione più recenti.

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.
   Nota: se il file secrets.properties non esiste, crealo nella stessa cartella del file local.properties.

   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.

   Nota: inserisci il codice come mostrato. Non sostituire DEFAULT_API_KEY con la tua chiave API.

   NAV_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 falliscano. 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.

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, creane uno 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 Navigation SDK for Android. For backwards compatibility, the API also supports the name com.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.

10. In Android Studio, open your module-level build.gradle.kts or build.gradle file and edit the secrets property. If the secrets property does not exist, add it.

    Edit the properties of the plugin to set propertiesFileName to secrets.properties, set defaultPropertiesFileName to local.defaults.properties, and set any other properties.

    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.

Punto chiave: per includere le attribuzioni, aggiungile come voce di menu indipendente o come voce di un menu Informazioni.

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 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 ulteriori informazioni su come registrare le transazioni, consulta Configurare la fatturazione, Registrare le transazioni fatturabili, Report e Registrare le transazioni fatturabili (Android).