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 build.gradle di Gradle o pom.xml di Maven.

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

   Gradle

   Aggiungi quanto segue a 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 a 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>
   

Configurare la build

Dopo aver creato il progetto, puoi configurare le impostazioni per una build riuscita e l'utilizzo dell'SDK Navigation.

Aggiornare le proprietà locali

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

Aggiornare 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 obbligatorie per l'SDK Navigation

  1. Imposta minSdkVersion su 24 o versioni successive.
  2. Imposta targetSdkVersion su 36 o versioni successive.
  3. Aggiungi un'impostazione dexOptions che aumenti javaMaxHeapSize.
  4. Imposta la posizione per le 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 il codice e le risorse inutilizzati dalle dipendenze. Se il passaggio R8/ProGuard richiede troppo tempo, valuta la possibilità di attivare 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 le stringhe di risorse per tutte le lingue supportate dall'SDK Navigation.

  Aggiungere il desugaring per il supporto di Java 8

  • 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 di linguaggio Java 8. Per ulteriori informazioni, consulta Supporto per il desugaring di Java 8. Per informazioni sulle opzioni di compilazione e dipendenza, consulta lo snippet di script di build di esempio riportato di seguito.
  • Per Android versione 7.7.0 e successive, devi utilizzare Gradle 8.13, il plug-in Android per Gradle versione 8.13.2 e la libreria Desugar com.android.tools:desugar_jdk_libs_nio:2.1.5.
  • Per Android versione 7.3.0-7.6.0, devi utilizzare Gradle 8.11.1, il plug-in Android per Gradle versione 8.10.0 e la libreria Desugar com.android.tools:desugar_jdk_libs_nio:2.0.3.
  • La libreria Desugar deve essere abilitata per il modulo app e per qualsiasi modulo che dipende direttamente dall'SDK Navigation.

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 Navigation che stai utilizzando 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.1.5'
}

Aggiungere la chiave API all'app

Questa sezione descrive come archiviare la chiave API in modo che possa essere referenziata in modo sicuro dalla tua app. Non devi archiviare la chiave API nel sistema di controllo della versione, pertanto 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 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 a livello di root e aggiungi il seguente codice all'elemento dependencies in buildscript.

   Groovy

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

2. Apri il file build.gradle a livello di app e aggiungi il seguente codice all' plugins elemento.

   Groovy

   plugins {
       id 'com.android.application'
       // ...
       id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
   }

   Kotlin

   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 local.properties nella directory a livello di progetto e aggiungi il seguente codice. Sostituisci YOUR_API_KEY con la tua chiave API.

   MAPS_API_KEY=YOUR_API_KEY

5. Puoi aggiungere la chiave API al file AndroidManifest.xml o fornirla in modo programmatico.
   • Aggiungi la 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 a multiple Google Maps-based APIs 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 all'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 la chiave disponibile 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 nulla e non vuota.
     • Chiama setApiKey() una sola volta durante il ciclo di vita dell'applicazione. Se viene chiamato più di una volta, il metodo genera un'eccezione IllegalStateException.
     • Chiama setApiKey() prima di inizializzare qualsiasi altro componente dell'SDK Navigation, ad esempio Navigator.
     • La chiave fornita con questo metodo sostituisce qualsiasi chiave API in AndroidManifest.xml.
     • Utilizza l'SDK Navigation versione 7.6 o successive.

Includere le attribuzioni richieste nell'app

Se utilizzi l'SDK Navigation 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 e le licenze open source richieste nel file ZIP dell'SDK Navigation per Android:

• NOTICE.txt
• LICENSES.txt