设置项目

本指南列出了使用 Navigation SDK for Android 5.0.0 及更高版本的 build 配置要求。

以下说明假定您已安装 Android IDE 并且熟悉 Android 开发。

使用 Navigation SDK 的最低要求

这些要求适用于 Navigation SDK for Android 5.0.0 及更高版本。

  • 启用了 Navigation SDK 的 Google Cloud Console 项目。如需预配，请咨询您的 Google Maps Platform 代表。

  • 您的应用必须指定 Android 版本，如下所示：

    • 目标版本必须是 Android 13（API 级别 33）或更高版本。
    • 最低版本必须是 Android 6（API 级别 23）或更高版本。

  • 如需运行使用 Navigation SDK 构建的应用，Android 设备必须满足以下要求：

  • 必须在应用中添加提供方说明和许可文本。

设置您的项目：Cloud 控制台项目和 Android 项目

您需要先创建 Cloud Console 项目并添加 API 密钥凭据，然后才能构建或测试应用。项目必须进行预配才能访问 Navigation SDK。Cloud Console 项目中的所有密钥都被授予了对 Navigation SDK 的相同访问权限。一个密钥可以关联多个开发项目。如果您已有控制台项目，则可以向当前项目添加密钥。

要进行设置

  1. 在您喜爱的网络浏览器中，登录 Cloud Console 并创建 Cloud Console 项目。
  2. 在您的 IDE（例如 Android Studio）中，创建一个 Android 应用开发项目并记下软件包名称。
  3. 如需为您的 Cloud 控制台项目提供 Navigation SDK 的访问权限，请与您的 Google Maps Platform 代表联系。
  4. 在网络浏览器中的 Cloud 控制台信息中心内，创建凭据以生成具有限制的 API 密钥。
  5. 在 API 密钥页面，点击应用限制部分中的 Android 应用。
  6. 点击添加软件包名称和指纹，然后输入开发项目的软件包名称和该密钥的 SHA-1 指纹。
  7. 点击保存。

将 Navigation SDK 添加到您的项目

Navigation SDK 可通过 Maven 获取。创建开发项目后，您可以使用以下任一方法将 SDK 集成到该项目。

以下代码使用 google() Maven 制品库，这是将 Navigation SDK 添加到项目中的最简单推荐方法。

  1. 将以下依赖项添加到您的 Gradle 或 Maven 配置中，并将 VERSION_NUMBER 占位符替换为所需的 Navigation SDK for Android 版本。

    Gradle

    将以下代码添加到模块级 build.gradle 中：

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

    如果从原始 Maven 制品库升级，请注意组和工件名称已更改，不再需要 com.google.cloud.artifactregistry.gradle-plugin 插件。

    并将以下代码添加到顶级 build.gradle：

    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

    将以下内容添加到 pom.xml 中：

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

    如果您有任何使用 Maps SDK 的依赖项，则必须在每个已声明的依赖于 Maps SDK 的依赖项中排除这些依赖项。

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

配置构建

创建项目后，您可以配置设置，以便成功构建并使用 Navigation SDK。

更新本地房源

  • 在 Gradle Scripts 文件夹中，打开 local.properties 文件并添加 android.useDeprecatedNdk=true。

更新 Gradle 构建脚本

  • 打开 build.gradle (Module:app) 文件并按照以下准则更新设置，以满足 Navigation SDK 的要求，并考虑也设置优化选项。

    Navigation SDK 的必需设置

    1. 将 minSdkVersion 设置为 23 或更高版本。
    2. 将 targetSdkVersion 设置为 33 或更高版本。
    3. 添加用于增加 javaMaxHeapSize 的 dexOptions 设置。
    4. 设置其他库的位置。
    5. 为 Navigation SDK 添加 repositories 和 dependencies。
    6. 将依赖项中的版本号替换为最新的可用版本。

    用于缩短构建时间的可选设置

    • 使用 R8/ProGuard 启用代码缩减和资源缩减，从依赖项中移除未使用的代码和资源。 如果 R8/ProGuard 步骤的运行时间过长，请考虑为开发工作启用多 dex 文件。
    • 减少 build 中包含的语言翻译数量：在开发期间为一种语言设置 resConfigs。对于最终 build，请为您实际使用的语言设置 resConfigs。默认情况下，Gradle 包含 Navigation SDK 支持的所有语言的资源字符串。

    添加脱糖以支持 Java8

    • 如果您使用 Android Gradle 插件 4.0.0 或更高版本构建应用，该插件扩展了对使用多种 Java 8 语言 API 的支持。如需了解详情，请参阅 Java 8 脱糖支持。如需了解如何编译和依赖项选项，请参阅以下示例 build 脚本代码段。

以下是应用的 Gradle 构建脚本示例。请查看示例应用，了解更新的依赖项集，因为您使用的 Navigation SDK 版本可能稍微领先或落后于本文档。

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

本部分介绍了如何存储 API 密钥，以便您的应用可以安全引用相应密钥。您不应将 API 密钥签入版本控制系统，因此建议您将其存储在项目根目录下的 secrets.properties 文件中。如需详细了解 secrets.properties 文件，请参阅 Gradle 属性文件。

为了简化此任务，建议您使用 Android 版 Secret Gradle 插件。

如需在 Google 地图项目中安装 Android 版 Secret Gradle 插件，请执行以下操作：

  1. 在 Android Studio 中，打开顶级 build.gradle 或 build.gradle.kts 文件，并将以下代码添加到 buildscript 下的 dependencies 元素中。

    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. 打开模块级 build.gradle 文件，并将以下代码添加到 plugins 元素中。

    Groovy

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

    Kotlin

    plugins {
    id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
}
  3. 在模块级 build.gradle 文件中，请务必将 targetSdk 和 compileSdk 设置为 34。
  4. 保存文件并将项目与 Gradle 同步。
  5. 在顶级目录中打开 secrets.properties 文件，然后添加以下代码。将 YOUR_API_KEY 替换为您的 API 密钥。secrets.properties 不会签入版本控制系统，因此请将您的密钥存储在此文件中。 
    MAPS_API_KEY=YOUR_API_KEY
  6. 保存文件。

  7. 在顶级目录（即 secrets.properties 文件所在的文件夹）中创建 local.defaults.properties 文件，然后添加以下代码。

    MAPS_API_KEY=DEFAULT_API_KEY

    此文件的作用是为 API 密钥提供备用位置，以免在找不到 secrets.properties 文件的情况下构建失败。如果您是从省略 secrets.properties 的版本控制系统中克隆应用，而您还没有在本地创建 secrets.properties 文件来提供 API 密钥，就可能会出现构建失败。

  8. 保存文件。
  9. 在 AndroidManifest.xml 文件中，定位到 com.google.android.geo.API_KEY 并更新 android:value attribute。如果 <meta-data> 标记不存在，请创建该标记作为 <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.*"
}

在您的应用中添加必要的提供方说明

如果您在应用中使用 Navigation SDK for Android，则必须在应用的法律声明部分中包含提供方说明文本和开源许可。

您可以在 Navigation SDK for Android 的 ZIP 文件中找到必需的提供方说明文本和开源许可：

  • NOTICE.txt
  • LICENSES.txt

如果您是移动或车队引擎交付客户

如果您是 Mobility 或 Fleet Engine Deliveries 客户，请参阅 Mobility 文档，了解结算。如需详细了解如何记录交易，请参阅设置结算信息、记录可结算交易、报告和记录可结算交易 (Android)。