Configurare un progetto Android Studio

L'SDK di navigazione è disponibile tramite Maven. Dopo il giorno crei il tuo progetto di sviluppo, puoi integrare l'SDK al suo interno utilizzando uno dei seguenti approcci.

Utilizzo di Maven per l'SDK di navigazione (consigliato)

Di seguito viene utilizzato il Repository Maven di google(), che è il metodo più semplice metodo consigliato per aggiungere l'SDK di navigazione al progetto.

1. Aggiungi la seguente dipendenza alla configurazione Gradle o Maven, sostituendo il segnaposto VERSION_NUMBER con 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 Maps SDK, devi escludere in ogni dipendenza dichiarata che si basa su Maps SDK.

   Gradle

   Aggiungi quanto segue al 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 di un la creazione e l'utilizzo dell'SDK di navigazione correttamente.

Aggiorna 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 segui queste linee guida di aggiornare le impostazioni in modo da soddisfare i requisiti per SDK di navigazione e valuta la possibilità di impostare opzioni di ottimizzazione.

  Impostazioni obbligatorie per l'SDK di navigazione

  1. Imposta minSdkVersion su 23 o superiore.
  2. Imposta targetSdkVersion su 33 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 SDK di navigazione.
  6. Sostituisci i numeri di versione nelle dipendenze con il numero più recente versioni disponibili.

  Impostazioni facoltative per ridurre il tempo di compilazione

  • Abilita la riduzione del codice e le risorse restringendo utilizzando R8/ProGuard per rimuovere il codice e le risorse inutilizzati dalle dipendenze. Se l'esecuzione del passaggio R8/ProGuard richiede troppo tempo, valuta la possibilità di abilitare multidex per attività di sviluppo.
  • Riduci il numero di traduzioni in lingue incluse nella build: imposta resConfigs per una lingua durante lo sviluppo. Per la build finale, imposta resConfigs per le lingue che usi effettivamente. Per impostazione predefinita, Gradle include stringhe di risorse per tutti i linguaggi supportati SDK di navigazione.

  Aggiungere il desugaring per il supporto Java8

  • Se stai creando la tua app utilizzando il plug-in Android per Gradle 4.0.0 o il plug-in estende il supporto per l'utilizzo di un certo numero di linguaggi Java 8 su quelle di livello inferiore. Vedi Desugaring di Java 8 assistenza per ulteriori informazioni. Per sapere come fare, consulta lo snippet dello script di build di esempio riportato di seguito le opzioni di compilazione e di dipendenza.

Di seguito è riportato un esempio dello script di build Gradle per l'applicazione. Controlla il app di esempio per insiemi aggiornati di dipendenze, come versione di L'SDK di navigazione che stai utilizzando potrebbe essere leggermente in avanti o dietro 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 33
        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:1.1.9'
}

Aggiungi la chiave API all'app

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

Per semplificare questa attività, ti consigliamo di utilizzare 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 l'build.gradle o build.gradle.kts di primo livello e aggiungi il seguente codice all'elemento dependencies in buildscript.

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

2. Apri il file build.gradle a livello di modulo e aggiungi il seguente codice alla Elemento plugins.

   Trendy

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

   Kotlin

   plugins {
       id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
   }

3. Nel file build.gradle a livello di modulo, assicurati che targetSdk e I valori di compileSdk sono impostati su 34.
4. Salva il file e sincronizzare il progetto con Gradle.
5. Apri il file secrets.properties nella directory di primo livello, quindi aggiungi seguire il codice. Sostituisci YOUR_API_KEY con la tua chiave API. Memorizza la chiave in questo file perché secrets.properties è escluso dall'archiviazione in un controllo della versione di un sistema operativo completo.

   NAV_API_KEY=YOUR_API_KEY

6. Salva il file.

7. Crea il file local.defaults.properties nella directory di primo livello, uguale cartella come file secrets.properties, quindi aggiungi il codice riportato di seguito.

   NAV_API_KEY=DEFAULT_API_KEY

   Lo scopo di questo file è fornire un percorso di backup per la chiave API se Impossibile trovare il file secrets.properties per evitare errori di build. Ciò può verificarsi se cloni l'app da un sistema di controllo della versione che omette secrets.properties e non hai ancora creato un file secrets.properties in locale per fornire 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 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 or build.gradle.kts 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.

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

Includi le attribuzioni richieste nella tua app

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

Puoi trovare il testo dell'attribuzione e le licenze open source richiesti nella File ZIP dell'SDK di navigazione per Android:

• NOTICE.txt
• LICENSES.txt