Android Studio-Projekt einrichten

Auf dieser Seite wird erläutert, 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 entweder über die Gradle-Konfiguration (build.gradle) oder die Maven-Konfiguration (pom.xml) zu Ihrem Projekt 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 aktualisieren Sie die Einstellungen gemäß den folgenden Richtlinien, um die Anforderungen für das Navigation SDK zu erfüllen. Sie können auch die Optimierungsoptionen festlegen.

    Erforderliche Einstellungen für das Navigation SDK

    1. Legen Sie für minSdkVersion mindestens 24 fest.
    2. Legen Sie für targetSdkVersion 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 die repositories und die 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-Dauer

    • Aktivieren Sie die Codekomprimierung und die Entfernung von Ressourcen mit R8/ProGuard, um nicht verwendeten Code und nicht verwendete Ressourcen aus Abhängigkeiten zu entfernen. Wenn der R8/ProGuard-Schritt zu lange dauert, können Sie Multidex für die Entwicklungsarbeit aktivieren.
    • Reduzieren Sie die Anzahl der im Build enthaltenen Sprachübersetzungen: 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.

    Entzuckerung für Java8-Unterstützung hinzufügen

    • Wenn Sie Ihre App mit dem Android-Gradle-Plug-in 4.0.0 oder höher erstellen, wird die Unterstützung für die Verwendung einer Reihe von Java 8-Sprach-APIs erweitert. Weitere Informationen finden Sie unter Java 8-Entzuckerungsunterstützung. Im folgenden Beispiel-Build-Skript-Snippet finden Sie Informationen zu den Kompilierungs- und Abhängigkeitsoptionen.
    • Verwenden Sie die Gradle-, Android-Gradle-Plug-in- (AGP) und Desugar-Bibliotheksversionen, die Ihrer Navigation SDK-Version entsprechen. 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ängen.

In der folgenden Tabelle sind die Gradle-, AGP- und Desugar-Bibliotheksversionen aufgeführt, die für die einzelnen Navigation SDK-Versionen erforderlich sind.

Navigation SDK-Version Gradle-Version AGP-Version Desugar-Bibliothek
8.0.0 und höher 9.1.0 9.0.1 com.android.tools:desugar_jdk_libs_nio:2.1.5
7.7.0 bis 7.9.0 8.13 8.13.2 com.android.tools:desugar_jdk_libs_nio:2.1.5
7.3.0 bis 7.6.0 8.11.1 8.10.0 com.android.tools:desugar_jdk_libs_nio:2.0.3

Unten sehen Sie ein Beispiel für das Gradle-Build-Skript für die Anwendung. In den Beispiel-Apps finden Sie aktualisierte Abhängigkeiten, da die von Ihnen verwendete Version des Navigation SDK möglicherweise etwas aktueller oder älter ist als die in dieser Dokumentation beschriebene.

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, ihn im Stammverzeichnis Ihres Projekts in der Datei secrets.properties zu speichern und diese Datei von der Versionsverwaltung auszuschließen. Weitere Informationen zu Gradle-Eigenschaftendateien finden Sie unter Gradle-Eigenschaftendateien.

Sie können das Secrets Gradle-Plug-in für Android verwenden, um diese Aufgabe zu vereinfachen.

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.kts oder build.gradle auf oberster Ebene und fügen Sie den folgenden Code in den plugins-Block ein.

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

    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. Wenn Sie Android Studio verwenden, synchronisieren Sie Ihr Projekt mit Gradle.
  4. Öffnen Sie die Datei secrets.properties im Verzeichnis der obersten Ebene und fügen Sie den folgenden Code ein. Ersetzen Sie YOUR_API_KEY durch Ihren API-Schlüssel. Fügen Sie secrets.properties der Datei .gitignore hinzu oder schließen Sie sie anderweitig aus dem Versionsverwaltungssystem aus, damit Ihr API-Schlüssel nicht in die Versionsverwaltung eingecheckt wird. 
    MAPS_API_KEY=YOUR_API_KEY

  5. Erstellen Sie die Datei local.defaults.properties im Verzeichnis der obersten Ebene, im selben Ordner wie die Datei secrets.properties, und fügen Sie folgenden Code ein.

    MAPS_API_KEY=DEFAULT_API_KEY

    Diese Datei ist ein Ersatzspeicherort für den API-Schlüssel, damit Builds nicht fehlschlagen, falls die Datei secrets.properties nicht gefunden wird. Das kann passieren, wenn Sie die App aus einem Versionsverwaltungssystem klonen, in dem secrets.properties nicht vorhanden ist, und noch keine lokale Datei secrets.properties erstellt haben, um Ihren API-Schlüssel bereitzustellen.

  6. Sie können den API-Schlüssel entweder der Datei AndroidManifest.xml hinzufügen oder ihn programmatisch bereitstellen.
    • Fügen Sie Ihren API-Schlüssel in AndroidManifest.xml ein: 
      <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 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 Google Maps-API unterstützt. In der App können nicht beide Metadatennamen für den API-Schlüssel angegeben werden, sondern nur jeweils einer. Falls beide angegeben werden, gibt die API eine Ausnahme aus.

    • Stellen Sie den API-Schlüssel programmatisch bereit:

      Das Secrets Gradle-Plug-in stellt den Schlüssel in der Klasse BuildConfig zur Verfügung. 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 Verwendung von setApiKey() Folgendes:
      • Geben Sie einen API-Schlüssel an, der weder null noch leer ist.
      • Rufen Sie setApiKey() nur einmal während der Lebensdauer Ihrer Anwendung auf. Die Methode löst einen 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 ab Version 7.6.

  7. Öffnen Sie in Android Studio die Datei build.gradle.kts oder build.gradle auf Modulebene und bearbeiten Sie das Attribut secrets. Wenn die Property secrets nicht vorhanden ist, fügen Sie sie hinzu.

    Bearbeiten Sie die Attribute des Plug-ins, um propertiesFileName auf "secrets.properties", defaultPropertiesFileName auf "local.defaults.properties" und alle anderen Attribute festzulegen.

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

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.

Die erforderlichen Quellenangaben und Open-Source-Lizenzen finden Sie in der ZIP-Datei des Navigation SDK for Android:

  • NOTICE.txt
  • LICENSES.txt

Wenn Sie Mobility- oder Fleet Engine Deliveries-Kunde sind

Wenn Sie Mobility- oder Fleet Engine Deliveries-Kunde sind, finden Sie Informationen zur Abrechnung in der Mobility-Dokumentation. Weitere Informationen zum Aufzeichnen von Transaktionen finden Sie unter Abrechnung einrichten, Abrechenbare Transaktionen aufzeichnen, Berichte und Abrechenbare Transaktionen aufzeichnen (Android).

Manuelle Abhängigkeiten (nicht Gradle/Maven)

Wenn Ihr Build-System transitive Abhängigkeiten nicht auflöst (z. B. Bazel) oder wenn Sie das AAR manuell einbinden, müssen Sie diese Abhängigkeiten Ihrem Projekt hinzufügen. Gradle und Maven lösen sie automatisch auf.

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