Das Navigation SDK ist über Maven verfügbar. Nachher Sie Ihr Entwicklungsprojekt erstellen, können Sie das SDK mithilfe von einen der folgenden Ansätze.
Maven für das Navigation SDK verwenden (empfohlen)
Im Folgenden wird das Maven-Repository google()
verwendet, das die einfachste und einfachste Möglichkeit,
empfohlene Methode zum Hinzufügen des Navigations-SDK zu Ihrem Projekt.
Fügen Sie Ihrer Gradle- oder Maven-Konfiguration die folgende Abhängigkeit hinzu: Dabei wird der Platzhalter
VERSION_NUMBER
für den gewünschte Version des Navigation SDK für Android.Gradle
Fügen Sie
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>
Wenn Sie Abhängigkeiten haben, für die das Maps SDK verwendet wird, müssen Sie den Parameter Abhängigkeit in jeder deklarierten Abhängigkeit, die auf dem Maps SDK basiert.
Gradle
Fügen Sie Ihrem
build.gradle
auf oberster Ebene Folgendes hinzu: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
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 ein um das Navigation SDK erfolgreich zu erstellen und zu nutzen.
Lokale Unterkünfte aktualisieren
- Öffnen Sie im Ordner „Gradle Scripts“ die Datei
local.properties
und fügen Sieandroid.useDeprecatedNdk=true
.
Gradle-Build-Skript aktualisieren
Öffne die Datei
build.gradle (Module:app)
und beachte die folgenden Richtlinien um die Einstellungen so zu aktualisieren, dass sie den Anforderungen für Navigation SDK und ziehen Sie erwägen, die Optimierungsoptionen an.Erforderliche Einstellungen für das Navigation SDK
- Legen Sie
minSdkVersion
auf 23 oder höher fest. - Legen Sie
targetSdkVersion
auf 33 oder höher fest. - Fügen Sie eine
dexOptions
-Einstellung hinzu, die denjavaMaxHeapSize
erhöht. - Legen Sie den Speicherort für zusätzliche Bibliotheken fest.
- Fügen Sie
repositories
unddependencies
für die Navigation SDK - Ersetzen Sie die Versionsnummern in den Abhängigkeiten durch die neuesten verfügbaren Versionen.
Optionale Einstellungen zur Verringerung der Build-Dauer
- Codeverkleinerung und Ressource aktivieren schrumpft R8/ProGuard verwenden, um nicht verwendeten Code und nicht verwendete Ressourcen aus Abhängigkeiten zu entfernen. Wenn der R8/ProGuard-Schritt zu lange dauert, sollten Sie erwägen, multidex für und Entwicklungsarbeit.
- Anzahl der im Build enthaltenen Sprachübersetzungen reduzieren: Legen Sie während der Entwicklung
resConfigs
für eine Sprache fest. Für den endgültigen Build Legen SieresConfigs
für Sprachen fest, die Sie tatsächlich verwenden. Standardmäßig gibt Gradle enthält Ressourcen-Strings für alle vom Navigation SDK
Desugaring für Java 8-Unterstützung hinzufügen
- Wenn Sie Ihre App mit dem Android-Gradle-Plug-in 4.0.0 oder unterstützt das Plug-in eine Reihe von Java 8-Sprachen APIs Siehe Java 8-Desugaring Support . Im Beispiel-Build-Script-Snippet unten finden Sie Informationen zu den Optionen für die Kompilierung und Abhängigkeiten.
- Legen Sie
Unten finden Sie ein Beispiel für das Gradle-Build-Script für die Anwendung. Überprüfen Sie die Beispielanwendungen für aktualisierte Gruppen von Abhängigkeiten, als Version von Das von Ihnen verwendete Navigation SDK ist möglicherweise hinter dieser Dokumentation stehen.
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'
}
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. 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 in Ihrem Google Maps-Projekt:
-
Öffnen Sie in Android Studio die Datei
build.gradle.kts
oderbuild.gradle
auf oberster Ebene und fügen Sie den folgenden Code in dasdependencies
-Element unterbuildscript
ein.Kotlin
buildscript { dependencies { classpath("com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1") } }
Groovy
buildscript { dependencies { classpath "com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1" } }
-
Öffnen Sie die Datei
build.gradle.kts
oderbuild.gradle
auf Modulebene und fügen Sie demplugins
-Element den folgenden Code hinzu.Kotlin
plugins { // ... id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin") }
Groovy
plugins { // ... id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin' }
- Achten Sie in der Datei
build.gradle.kts
oderbuild.gradle
auf Modulebene darauf, dasstargetSdk
undcompileSdk
sind festgelegt bis 34. - Speichern Sie die Datei und synchronisieren Sie Ihr Projekt mit Gradle.
-
Öffnen Sie die Datei
secrets.properties
im Verzeichnis der obersten Ebene und fügen Sie den folgenden Code ein. Ersetzen Sie dabeiYOUR_API_KEY
durch Ihren eigenen API-Schlüssel. Speichern Sie den Schlüssel in dieser Datei, dasecrets.properties
nicht in ein Versionsverwaltungssystem eingecheckt werden kann.NAV_API_KEY=YOUR_API_KEY
- Speichern Sie die Datei.
-
Erstellen Sie die Datei
local.defaults.properties
im Verzeichnis der obersten Ebene, im selben Ordner wie die Dateisecrets.properties
, und fügen Sie folgenden Code ein.NAV_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 demsecrets.properties
nicht vorhanden ist, und noch keine lokale Dateisecrets.properties
erstellt haben, um Ihren API-Schlüssel bereitzustellen. - Speichern Sie die Datei.
-
Gehen Sie in der Datei
AndroidManifest.xml
zucom.google.android.geo.API_KEY
und aktualisieren Sie dasandroid:value attribute
. Falls das<meta-data>
-Tag nicht vorhanden ist, erstellen Sie es als untergeordnetes Element des<application>
-Tags.<meta-data android:name="com.google.android.geo.API_KEY" android:value="${MAPS_API_KEY}" />
Hinweis:
com.google.android.geo.API_KEY
ist der empfohlene Metadatenname für den API-Schlüssel. Ein Schlüssel mit diesem Namen kann zur Authentifizierung bei mehreren Google Maps-basierte APIs auf der Android-Plattform, einschließlich der Navigation SDK for Android Aus Gründen der Abwärtskompatibilität enthält die API auch unterstützt den Namencom.google.android.maps.v2.API_KEY
. Dieses Legacy-System name ermöglicht nur die Authentifizierung bei der Android Maps API Version 2. Eine Anwendung kann nur einen der Metadatennamen des API-Schlüssels an. Falls beide angegeben werden, gibt die API eine Ausnahme aus. -
Öffnen Sie in Android Studio das
build.gradle.kts
auf Modulebene oderbuild.gradle
-Datei und bearbeiten Sie das Attributsecrets
. Wenn die Propertysecrets
nicht vorhanden ist, fügen Sie sie hinzu.Legen Sie in den Attributen des Plug-ins
propertiesFileName
fest:secrets.properties
,defaultPropertiesFileName
festlegen auflocal.defaults.properties
und legen Sie beliebige weitere Attribute fest.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.*" }
Groovy
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.*" }
Erforderliche Quellenangaben in Ihrer App angeben
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 Quellenangabentext und die erforderlichen Open-Source-Lizenzen finden Sie in der ZIP-Datei mit dem Navigations-SDK für Android:
NOTICE.txt
LICENSES.txt
Wenn Sie Kunde von Mobility oder Fleet Engine Delivery sind
Wenn Sie ein Mobility- oder Fleet Engine Deliveries-Kunde sind, erhalten Sie hier weitere Informationen zu Abrechnung finden Sie in der Dokumentation zur Mobilität. Weitere Informationen zu Transaktionen erfassen, finden Sie Abrechnung einrichten Abrechenbare Transaktionen erfassen Berichterstellung und Abrechenbare Transaktionen erfassen (Android)