Android Studio-Projekt einrichten

Auf dieser Seite wird beschrieben, wie Sie das Navigation SDK in Ihr Entwicklungsprojekt einbinden.

Navigation SDK zu Ihrem Projekt hinzufügen

Das Navigation SDK ist über das Google Maven-Repository verfügbar. Sie können das SDK Ihrem Projekt entweder über Ihre Gradle-build.gradle- oder Maven-pom.xml-Konfiguration hinzufügen.

1. Fügen Sie Ihrer Gradle- oder Maven-Konfiguration die folgende Abhängigkeit hinzu und ersetzen Sie den Platzhalter VERSION_NUMBER durch die gewünschte Version des Navigation SDK for Android.

   Gradle

   Fügen Sie der Datei build.gradle auf Modulebene Folgendes hinzu:

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

   Maven

   Fügen Sie zum pom.xml Folgendes hinzu:

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

2. Wenn Sie Abhängigkeiten haben, die das Maps SDK verwenden, müssen Sie die Abhängigkeit in jeder deklarierten Abhängigkeit ausschließen, die auf dem Maps SDK basiert.

   Gradle

   Fügen Sie der Datei build.gradle auf oberster Ebene Folgendes hinzu:

   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

   Fügen Sie zum pom.xml Folgendes hinzu:

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

Build konfigurieren

Nachdem Sie das Projekt erstellt haben, können Sie die Einstellungen für einen erfolgreichen Build und die Verwendung des Navigation SDK konfigurieren.

Lokale Attribute aktualisieren

• Öffnen Sie im Ordner „Gradle-Scripts“ die Datei local.properties und fügen Sie android.useDeprecatedNdk=true hinzu.

Gradle-Build-Skript aktualisieren

• Öffnen Sie die Datei build.gradle (Module:app) und folgen Sie der Anleitung unten, um die Einstellungen zu aktualisieren und die Anforderungen für das Navigation SDK zu erfüllen. Sie sollten auch die Optimierungsoptionen festlegen.

  Erforderliche Einstellungen für das Navigation SDK

  1. Legen Sie minSdkVersion auf 24 oder höher fest.
  2. Legen Sie targetSdkVersion auf mindestens 36 fest.
  3. Fügen Sie eine dexOptions-Einstellung hinzu, die den javaMaxHeapSize erhöht.
  4. Legen Sie den Speicherort für zusätzliche Bibliotheken fest.
  5. Fügen Sie repositories und dependencies für das Navigation SDK hinzu.
  6. Ersetzen Sie die Versionsnummern in den Abhängigkeiten durch die neuesten verfügbaren Versionen.

  Optionale Einstellungen zur Verkürzung der Build-Zeit

  • Aktivieren Sie Code- und Ressourcen-Shrinking mit R8/ProGuard, um nicht verwendeten Code und nicht verwendete Ressourcen aus Abhängigkeiten zu entfernen. Wenn der R8-/ProGuard-Schritt zu lange dauert, sollten Sie Multidex für die Entwicklung aktivieren.
  • Reduzieren Sie die Anzahl der Sprachübersetzungen im Build: Legen Sie während der Entwicklung resConfigs für eine Sprache fest. Legen Sie für den endgültigen Build resConfigs für die Sprachen fest, die Sie tatsächlich verwenden. Standardmäßig enthält Gradle Ressourcenstrings für alle Sprachen, die vom Navigation SDK unterstützt werden.

  Desugaring für Java 8-Unterstützung hinzufügen

  • Wenn Sie Ihre App mit dem Android-Gradle-Plug-in 4.0.0 oder höher erstellen, bietet das Plug-in Unterstützung für die Verwendung einer Reihe von Java 8-Sprach-APIs. Weitere Informationen finden Sie unter Unterstützung für Desugaring in Java 8. Im Beispiel-Snippet für das Build-Skript unten sehen Sie, wie Sie Kompilierungs- und Abhängigkeitsoptionen festlegen.
  • Verwenden Sie die Gradle-, Android-Gradle-Plug-in- (AGP) und Desugar-Bibliotheksversionen, die mit Ihrer Navigation SDK-Version übereinstimmen. Die folgende Tabelle verdeutlicht dies.
  • Die Desugar-Bibliothek muss für das app-Modul und alle Module aktiviert sein, die direkt vom Navigation SDK abhängig sind.

In der folgenden Tabelle sind die für jede Navigation SDK-Version erforderlichen Gradle-, AGP- und Desugar-Bibliotheksversionen aufgeführt.

Unten sehen Sie ein Beispiel für das Gradle-Build-Skript für die Anwendung. Sehen Sie sich die Beispiel-Apps an, um die aktualisierten Abhängigkeiten zu prüfen, da die Version des Navigation SDK, die Sie verwenden, möglicherweise etwas neuer oder älter als diese Dokumentation ist.

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'
}

API-Schlüssel in die App einfügen

In diesem Abschnitt wird beschrieben, wie Sie Ihren API-Schlüssel speichern, damit er von Ihrer App sicher referenziert werden kann. Er sollte nicht in Ihrem Versionsverwaltungssystem eingecheckt werden. Stattdessen empfehlen wir Ihnen, ihn im Stammverzeichnis Ihres Projekts in der Datei secrets.properties zu speichern. Weitere Informationen zur Datei secrets.properties finden Sie unter Gradle properties files.

Sie können das Secrets Gradle-Plug-in for Android verwenden, um diese Aufgabe zu optimieren.

So installieren Sie das Secrets Gradle-Plug-in für Android und speichern Ihren API-Schlüssel:

1. Öffnen Sie in Android Studio die Datei build.gradle auf Stammebene und fügen Sie den folgenden Code in das dependencies-Element unter buildscript ein.

   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. Öffnen Sie die Datei build.gradle auf App-Ebene und fügen Sie dem plugins-Element den folgenden Code hinzu.

   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. Wenn Sie Android Studio verwenden, synchronisieren Sie Ihr Projekt mit Gradle.
4. Öffnen Sie die Datei local.properties in Ihrem Verzeichnis auf Projektebene und fügen Sie den folgenden Code ein. Ersetzen Sie dabei YOUR_API_KEY durch Ihren eigenen API-Schlüssel.

   MAPS_API_KEY=YOUR_API_KEY

5. Sie können den API-Schlüssel entweder der Datei AndroidManifest.xml hinzufügen oder programmatisch bereitstellen.
   • Fügen Sie der Datei AndroidManifest.xml Ihren API-Schlüssel hinzu:

     <meta-data
         android:name="com.google.android.geo.API_KEY"
         android:value="${MAPS_API_KEY}" />
             

     Hinweis:Für den API-Schlüssel wird com.google.android.geo.API_KEY als Metadatenname empfohlen. Ein Schlüssel mit diesem Namen kann zur Authentifizierung bei mehreren Google Maps-basierten APIs auf der Android-Plattform verwendet werden, einschließlich des Navigation SDK for Android. Aus Gründen der Abwärtskompatibilität unterstützt die API auch den Namen com.google.android.maps.v2.API_KEY. Für diesen alten Namen wird nur die Authentifizierung bei Version 2 der Android Maps API unterstützt. In der App kann nicht beides angegeben werden, sondern nur jeweils einer der Metadatennamen für den API-Schlüssel. Falls beide angegeben werden, gibt die API eine Ausnahme aus.

   • API-Schlüssel programmatisch angeben:

     Das Secrets Gradle-Plug-in macht den Schlüssel in der Klasse BuildConfig verfügbar. Rufen Sie die Methode bei der Initialisierung Ihrer App (z. B. in der Methode Application.onCreate()) so auf:

     Kotlin

     1. Fügen Sie die folgenden Importanweisungen hinzu:

        import com.google.android.libraries.navigation.NavigationApi

     2. Fügen Sie der Methode Application.onCreate() Folgendes hinzu:

        NavigationApi.setApiKey(BuildConfig.MAPS_API_KEY)

     Java

     1. Fügen Sie die folgenden Importanweisungen hinzu:

        import com.google.android.libraries.navigation.NavigationApi;

     2. Fügen Sie der Methode Application.onCreate() Folgendes hinzu:

        NavigationApi.setApiKey(BuildConfig.MAPS_API_KEY);

     Hinweis:Beachten Sie bei der Verwendung von setApiKey() Folgendes:

     • Geben Sie einen API-Schlüssel an, der nicht null und nicht leer ist.
     • Rufen Sie setApiKey() nur einmal während der Lebensdauer Ihrer Anwendung auf. Die Methode löst eine IllegalStateException aus, wenn sie mehr als einmal aufgerufen wird.
     • Rufen Sie setApiKey() auf, bevor Sie andere Navigation SDK-Komponenten wie Navigator initialisieren.
     • Der Schlüssel, den Sie mit dieser Methode angeben, überschreibt alle API-Schlüssel in Ihrer AndroidManifest.xml.
     • Verwenden Sie das Navigation SDK in Version 7.6 oder höher.

Erforderliche Quellenangaben in Ihre App einfügen

Wenn Sie das Navigation SDK for Android in Ihrer App verwenden, müssen Sie Quellenangaben und Open-Source-Lizenzen in den Abschnitt mit den rechtlichen Hinweisen Ihrer App aufnehmen.

Den erforderlichen Attributionshinweis und die Open-Source-Lizenzen finden Sie in der ZIP-Datei des Navigation SDK for Android:

• NOTICE.txt
• LICENSES.txt