Projekt einrichten – Version 4.99 und niedriger

In dieser Anleitung sind die Build-Konfigurationsanforderungen für die Verwendung des Navigation SDK for Android In der Anleitung wird davon ausgegangen, dass Sie eine Android-IDE haben. installiert und mit der Android-Entwicklung vertraut sind.

Mindestanforderungen für die Verwendung des Navigation SDK

Diese Anforderungen gelten für das Navigation SDK for Android 4.99 und niedriger.

  • Ein Google Cloud Console-Projekt mit aktiviertem Navigation SDK Wenden Sie sich bezüglich der Bereitstellung an Ihren Google Maps Platform-Ansprechpartner.

  • Ihre App muss auf API-Level 30 oder höher ausgerichtet sein.

  • Um eine mit dem Navigation SDK erstellte App auszuführen, Gerät muss Google Play-Dienste haben installiert und aktiviert ist.

  • Quellenangaben und Lizenztext muss der App hinzugefügt werden.

Projekte einrichten: Cloud Console-Projekt und Android-Projekt

Bevor Sie eine Anwendung erstellen oder testen können, müssen Sie ein Cloud Console-Projekt erstellen und fügen Sie Anmeldedaten für den API-Schlüssel hinzu. Das Projekt muss über Bereitstellungen verfügen, um auf die Navigation SDK Alle Schlüssel im Cloud Console-Projekt erhalten denselben Zugriff auf das Navigation SDK. Ein Schlüssel mit mehreren Entwicklungsprojekten verknüpft sein. Wenn Sie bereits ein Konsolenprojekt haben, können Sie Ihrem aktuellen Projekt einen Schlüssel hinzufügen.

Einrichtung

  1. Melden Sie sich in Ihrem bevorzugten Webbrowser in der Cloud Console und erstellen Sie die Cloud Console Projekt arbeiten.
  2. Erstellen Sie in Ihrer IDE, z. B. Android Studio, eine Android-App-Entwicklung. und notieren Sie sich den Paketnamen.
  3. Wenden Sie sich an Ihren Google Maps Platform-Ansprechpartner, um Zugriff auf die Navigations-SDK für die Cloud Console Projekt arbeiten.
  4. Öffnen Sie das Cloud Console-Dashboard in Ihrem Webbrowser und gehen Sie so vor: Anmeldedaten erstellen, um einen API-Schlüssel mit Einschränkungen zu generieren
  5. Klicken Sie auf der Seite API-Schlüssel unter Anwendungseinschränkungen auf „Android-Apps“. Bereich.
  6. Klicken Sie auf Paketname und Fingerabdruck hinzufügen und geben Sie dann das Paket ein. Name Ihres Entwicklungsprojekts und den SHA-1-Fingerabdruck für diesen Schlüssel.
  7. Klicken Sie auf Speichern.

Dem Projekt das Navigation SDK hinzufügen

Das Navigation SDK ist über Maven oder als AAE-Bundle: Nachdem Sie Ihr Entwicklungsprojekt erstellt haben, können Sie das SDK integrieren, indem Sie mit einem der folgenden Ansätze.

Im Folgenden wird das Maven-Repository google() verwendet, das die einfachste und empfohlene Methode zum Hinzufügen des Navigation SDK zu Ihrem Projekt

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

    Wenn Sie ein Upgrade vom ursprünglichen Maven-Repository durchführen, beachten Sie, dass die Gruppe und und die Namen der Artefakte com.google.cloud.artifactregistry.gradle-plugin-Plug-in ist nicht mehr verfügbar notwendig ist.

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

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

Verwendung von Maven für das Navigation SDK vor Version 4.5 oder mit dem Treiber SDK

Das Navigation SDK ist weiterhin über die des ursprünglichen Maven-Repositorys bis zu den übrigen Versionen der Version 4. Dies ist die Bibliothek mit denselben Updates wie die obige Version Kompatibilität mit Driver SDK und anderen Bibliotheken. Mit Für diese Abhängigkeit müssen Sie sich über gcloud bei Ihrem Cloud-Projekt anmelden, wenn Kompilieren.

  1. Richten Sie Ihre Umgebung so ein, dass sie auf das Maven-Repository von Google zugreifen kann, wie in den Voraussetzungen der Consumer SDK-Dokumentation. Zugriff auf Das Navigation SDK wird über eine Arbeitsbereichsgruppe gesteuert.
  2. Fügen Sie Ihrer Gradle- oder Maven-Konfiguration die folgende Abhängigkeit hinzu. Ersetzen Sie dabei den Parameter VERSION_NUMBER-Platzhalter für die gewünschte Version des Navigation SDK.

    Gradle

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

    dependencies {
      ...
      implementation 'com.google.android.maps:navsdk:VERSION_NUMBER'
    }
    

    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>com.google.android.maps</groupId>
        <artifactId>navsdk</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.

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

Das Navigation SDK ist auch als AAE-Paket verfügbar. Nachdem Sie das Entwicklungsprojekt erstellt haben, können Sie das SDK integrieren. Diese Anleitung gehen davon aus, dass Sie Android Studio für Ihre IDE verwenden.

  1. Neueste Version des Navigation SDK herunterladen aus der geteilten Google Drive-Ablage aus und entpacken Sie sie. Wenn Sie keinen Zugriff haben, wenden Sie sich an Ihren Ansprechpartner.

  2. Öffnen Sie in Android Studio ein Projekt und Das Paket Google Play-Dienste hinzufügen über den SDK-Manager.

  3. Kopieren Sie libs/google_navigation_navmap.aar aus dem Verzeichnis der ZIP-Datei in im app/libs-Verzeichnis Ihres Projekts gespeichert.

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

    implementation(name: 'google_navigation_navmap', ext: 'aar')
    

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

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 Sie android.useDeprecatedNdk=true.

Gradle-Build-Skript aktualisieren

  • Öffnen Sie die Datei build.gradle (Module:app) und beachten Sie die folgenden Richtlinien, um Einstellungen aktualisieren, um die Anforderungen für das Navigation SDK zu erfüllen und legen Sie eventuell die Optimierungsoptionen fest.

    Erforderliche Einstellungen für das Navigation SDK

    1. Setze minSdkVersion auf 23 oder höher.
    2. Legen Sie für targetSdkVersion mindestens 30 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 Verringerung der Build-Dauer

    • Aktivieren Codereduzierung und Ressourcenverkleinerung R8/ProGuard verwenden, um nicht verwendeten Code und nicht verwendete Ressourcen aus Abhängigkeiten zu entfernen. Wenn der Schritt R8/ProGuard zu viel Zeit in Anspruch nimmt, sollten Sie erwägen, Multidex für die Entwicklungsarbeit.
    • Reduzieren Sie die Anzahl der im Build enthaltenen Übersetzungen: Festlegen resConfigs für eine Sprache während der Entwicklung. Legen Sie für den endgültigen Build resConfigs für Sprachen, die Sie tatsächlich verwenden. Standardmäßig enthält Gradle Ressourcenstrings für alle vom Navigation SDK unterstützten Sprachen.

Im Folgenden finden Sie ein Beispiel für das Gradle-Build-Skript für die Anwendung. Überprüfen Sie die Beispielanwendungen für aktualisierte Gruppen von Abhängigkeiten, als Version von Das verwendete Navigation SDK ist möglicherweise etwas voraus oder hinter dieser Dokumentation stehen.

apply plugin: 'com.android.application'
apply plugin: 'com.google.cloud.artifactregistry.gradle-plugin'

ext {
    androidxVersion = "1.0.0"
    lifecycle_version = "1.1.1"
}

android {
    compileSdkVersion 30
    buildToolsVersion '28.0.3'

    defaultConfig {
        applicationId "<your id>"
        // Navigation SDK supports SDK 23 and later.
        minSdkVersion 23
        targetSdkVersion 30
        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 {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

// This tells Gradle where to look to find additional libraries - in this case, the
// google_navigation_navmap.aar file.
repositories {
    flatDir {
        dirs 'libs'
    }
    google()

    // Required for accessing the Navigation SDK on Google's Maven repository.
    maven {
        url "artifactregistry://us-west2-maven.pkg.dev/gmp-artifacts/transportation"
    }
}

dependencies {
    // Include the Google Navigation SDK
    implementation 'com.google.android.maps:navsdk:4.4.0'

    // The included AAR file under libs can be used instead of the Maven repository.
    // Uncomment the line below and comment out the previous dependency to use
    // the AAR file instead. Ensure that you add the AAR file to the libs directory.
    // implementation(name: 'google_navigation_navmap', ext: 'aar')

    // These dependencies are required for the Navigation SDK to function
    // properly at runtime.
    implementation 'org.chromium.net:cronet-fallback:69.3497.100'
    // Optional for Cronet users:
    // implementation 'org.chromium.net:cronet-api:69.3497.100'
    implementation 'androidx.appcompat:appcompat:${androidxVersion}'
    implementation 'androidx.cardview:cardview:${androidxVersion}'
    implementation 'com.google.android.material:material:${androidxVersion}'
    implementation 'androidx.mediarouter:mediarouter:${androidxVersion}'
    implementation 'androidx.preference:preference:${androidxVersion}'
    implementation 'androidx.recyclerview:recyclerview:${androidxVersion}'
    implementation 'androidx.legacy:legacy-support-v4:${androidxVersion}'
    implementation 'com.github.bumptech.glide:glide:4.9.0'
    implementation 'com.github.bumptech.glide:okhttp-integration:4.9.0'
    implementation 'android.arch.lifecycle:common-java8:$lifecycle_version'
    implementation 'com.android.support:multidex:1.0.3'
    implementation 'com.google.android.datatransport:transport-api:2.2.0'
    implementation 'com.google.android.datatransport:transport-backend-cct:2.2.0'
    implementation 'com.google.android.datatransport:transport-runtime:2.2.0'
    implementation 'joda-time:joda-time:2.9.9'
    annotationProcessor 'androidx.annotation:annotation:1.1.0'
    annotationProcessor 'com.github.bumptech.glide:compiler:4.9.0'
}

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:

  1. Öffnen Sie in Android Studio die Datei build.gradle oder build.gradle.kts auf oberster Ebene 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 Modulebene und fügen Sie den folgenden Code in das plugins-Element ein.

    Groovy

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

    Kotlin

    plugins {
        id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
    }
  3. In der Datei build.gradle auf Modulebene müssen targetSdk und compileSdk auf 34 gesetzt sein.
  4. Speichern Sie die Datei und synchronisieren Sie Ihr Projekt mit Gradle.
  5. Öffnen Sie die Datei secrets.properties im Verzeichnis der obersten Ebene und fügen Sie den folgenden Code ein. Ersetzen Sie dabei YOUR_API_KEY durch Ihren eigenen API-Schlüssel. Speichern Sie den Schlüssel in dieser Datei, da secrets.properties nicht in ein Versionsverwaltungssystem eingecheckt werden kann.
    NAV_API_KEY=YOUR_API_KEY
  6. Speichern Sie die Datei.
  7. 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.

    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 dem secrets.properties nicht vorhanden ist, und noch keine lokale Datei secrets.properties erstellt haben, um Ihren API-Schlüssel bereitzustellen.

  8. Speichern Sie die Datei.
  9. Gehen Sie in der Datei AndroidManifest.xml zu com.google.android.geo.API_KEY und aktualisieren Sie das android: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}" />

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

Fügen Sie Ihrer App die erforderlichen Quellenangaben hinzu.

Wenn Sie das Navigation SDK for Android in Ihrer App verwenden, müssen Sie Attributionstext und Open-Source-Lizenzen als Teil der rechtlichen Hinweise Ihrer App .

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