Trang này được dịch bởi Cloud Translation API.

Thiết lập dự án -- Phiên bản 4.99 trở xuống

Hướng dẫn này liệt kê các yêu cầu về cấu hình bản dựng để sử dụng Navigation SDK cho Android. Hướng dẫn này giả định rằng bạn đã cài đặt một IDE Android và quen thuộc với quy trình phát triển Android.

Yêu cầu tối thiểu để sử dụng Navigation SDK

Những yêu cầu này áp dụng cho Navigation SDK cho Android phiên bản 4.99 trở xuống.

Một Bảng điều khiển Google Cloud

dự án có bật Navigation SDK. Để cung cấp, hãy liên hệ với người đại diện của Nền tảng Google Maps.
Ứng dụng của bạn phải nhắm đến API cấp 30 trở lên.
Để chạy một ứng dụng được tạo bằng Navigation SDK, thiết bị Android phải đã cài đặt và bật Dịch vụ Google Play.
Bạn phải thêm văn bản ghi nhận quyền tác giả và cấp phép vào ứng dụng.

Thiết lập dự án: Dự án sử dụng Cloud Console và dự án Android

Trước khi có thể tạo hoặc kiểm thử một ứng dụng, bạn cần tạo một dự án trên Cloud Console và thêm thông tin đăng nhập khoá API. Dự án phải có quy trình cung cấp để truy cập vào Navigation SDK. Tất cả các khoá trong dự án trên Bảng điều khiển đám mây đều được cấp cùng một quyền truy cập vào Navigation SDK. Một khoá có thể liên kết với nhiều dự án phát triển. Nếu đã có một dự án trên bảng điều khiển, bạn có thể thêm khoá vào dự án hiện tại.

Cách thiết lập

Trong trình duyệt web mà bạn yêu thích, hãy đăng nhập vào Cloud Console rồi tạo dự án Cloud Console.
Trong IDE (chẳng hạn như Android Studio), hãy tạo một dự án phát triển ứng dụng Android và ghi lại tên gói.
Liên hệ với người đại diện của Nền tảng Google Maps để cấp quyền truy cập vào Navigation SDK cho dự án trên Cloud Console của bạn.
Trong khi ở trang tổng quan Cloud Console trong trình duyệt web, hãy tạo thông tin xác thực để tạo khoá API có các hạn chế.
Trên trang khoá API, hãy nhấp vào Ứng dụng Android trong khu vực Hạn chế ứng dụng.
Nhấp vào Thêm tên gói và dấu vân tay, sau đó nhập tên gói của dự án phát triển và dấu vân tay SHA-1 cho khoá đó.
Nhấp vào Lưu.

Thêm Navigation SDK vào dự án của bạn

Bạn có thể sử dụng Navigation SDK thông qua Maven hoặc dưới dạng gói AAR. Sau khi tạo dự án phát triển, bạn có thể tích hợp SDK vào dự án đó bằng một trong những phương pháp sau.

Sử dụng Maven cho Navigation SDK phiên bản 4.5 trở lên (nên dùng)

Sau đây sử dụng kho lưu trữ Maven google(). Đây là cách đơn giản nhất và được đề xuất để thêm Navigation SDK vào dự án của bạn

Thêm phần phụ thuộc sau vào cấu hình Gradle hoặc Maven, thay thế phần giữ chỗ VERSION_NUMBER cho phiên bản Navigation SDK cho Android.

Gradle

Thêm nội dung sau vào build.gradle ở cấp mô-đun:

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

Nếu bạn nâng cấp từ kho lưu trữ Maven ban đầu, hãy lưu ý rằng tên nhóm và tên cấu phần phần mềm đã thay đổi và không cần thiết phải có trình bổ trợ com.google.cloud.artifactregistry.gradle-plugin nữa.

Thêm nội dung sau vào build.gradle cấp cao nhất:

allprojects {
...
// Required: you must exclude the Google Play service Maps SDK from
// your transitive dependencies to make nsure 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

Thêm nội dung sau vào pom.xml:

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

Nếu có bất kỳ phần phụ thuộc nào sử dụng Maps SDK, bạn phải loại trừ phần phụ thuộc đó trong mỗi phần phụ thuộc đã khai báo dựa trên 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>

Sử dụng Maven cho Navigation SDK trước phiên bản 4.5 hoặc với Driver SDK

Navigation SDK vẫn có thể sử dụng kho lưu trữ Maven ban đầu trong các phiên bản v4 còn lại. Đây là cùng một thư viện với tất cả các bản cập nhật giống như phiên bản ở trên và cung cấp khả năng tương thích với Driver SDK và các thư viện khác trong quá trình chuyển đổi. Để sử dụng phần phụ thuộc này, bạn cần đăng nhập vào dự án trên đám mây bằng gcloud khi biên dịch.

Thiết lập môi trường để truy cập vào kho lưu trữ Maven của Google như mô tả trong phần Điều kiện tiên quyết của tài liệu Consumer SDK. Quyền truy cập vào Navigation SDK được kiểm soát thông qua một nhóm trong không gian làm việc.

Thêm phần phụ thuộc sau vào cấu hình Gradle hoặc Maven, thay thế phần giữ chỗ VERSION_NUMBER cho phiên bản Navigation SDK.

Gradle

Thêm nội dung sau vào build.gradle ở cấp mô-đun:

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

Thêm nội dung sau vào build.gradle cấp cao nhất:

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

Thêm nội dung sau vào pom.xml:

<dependencies>
...
<dependency>
     <groupId>com.google.android.maps</groupId>
     <artifactId>navsdk</artifactId>
     <version>VERSION_NUMBER</version>
</dependency>
</dependencies>

Nếu có bất kỳ phần phụ thuộc nào sử dụng Maps SDK, bạn phải loại trừ phần phụ thuộc đó trong mỗi phần phụ thuộc đã khai báo dựa trên 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>

Sử dụng gói AAR đã tải xuống (không nên dùng)

Navigation SDK cũng có sẵn dưới dạng một gói AAR. Sau khi tạo dự án phát triển, bạn có thể tích hợp SDK. Các hướng dẫn này giả định việc sử dụng Android Studio cho IDE của bạn.

Tải phiên bản mới nhất của Navigation SDK xuống từ Google Drive dùng chung rồi giải nén. Nếu bạn không có quyền truy cập, hãy liên hệ với người đại diện của bạn.
Trong Android Studio, hãy mở một dự án và thêm gói Dịch vụ Google Play bằng Trình quản lý SDK.
Từ thư mục tệp zip, hãy sao chép libs/google_navigation_navmap.aar vào thư mục app/libs của dự án.

Thêm nội dung sau vào build.gradle ở cấp mô-đun:

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

Thêm nội dung sau vào build.gradle cấp cao nhất:

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

Định cấu hình bản dựng

Sau khi tạo dự án, bạn có thể định cấu hình các chế độ cài đặt để tạo và sử dụng Navigation SDK thành công.

Cập nhật thuộc tính tại địa phương

Trong thư mục Gradle Scripts (Tập lệnh Gradle), hãy mở tệp local.properties rồi thêm android.useDeprecatedNdk=true.

Cập nhật tập lệnh bản dựng Gradle

Mở tệp build.gradle (Module:app) và làm theo các nguyên tắc sau để cập nhật chế độ cài đặt nhằm đáp ứng các yêu cầu đối với Navigation SDK, đồng thời cân nhắc việc thiết lập các lựa chọn tối ưu hoá.

Chế độ cài đặt bắt buộc cho Navigation SDK
1. Đặt minSdkVersion thành 23 trở lên.
2. Đặt targetSdkVersion thành 30 trở lên.
3. Thêm chế độ cài đặt dexOptions để tăng javaMaxHeapSize.
4. Đặt vị trí cho các thư viện bổ sung.
5. Thêm repositories và dependencies cho Navigation SDK.
6. Thay thế số phiên bản trong các phần phụ thuộc bằng phiên bản mới nhất hiện có.
Chế độ cài đặt không bắt buộc để giảm thời gian xây dựng
- Bật tính năng rút gọn mã và tài nguyên bằng R8/ProGuard để loại bỏ mã và tài nguyên không dùng đến khỏi các phần phụ thuộc. Nếu bước R8/ProGuard mất quá nhiều thời gian để chạy, hãy cân nhắc việc bật multidex cho công việc phát triển.
- Giảm số lượng bản dịch ngôn ngữ có trong bản dựng: Đặt Set resConfigs cho một ngôn ngữ trong quá trình phát triển. Đối với bản dựng cuối cùng, hãy đặt resConfigs cho những ngôn ngữ mà bạn thực sự sử dụng. Theo mặc định, Gradle sẽ bao gồm các chuỗi tài nguyên cho tất cả ngôn ngữ mà Navigation SDK hỗ trợ.

Dưới đây là một ví dụ về tập lệnh bản dựng Gradle cho ứng dụng. Hãy kiểm tra các ứng dụng mẫu để biết các nhóm phần phụ thuộc mới nhất, vì phiên bản Navigation SDK mà bạn đang dùng có thể mới hơn hoặc cũ hơn một chút so với tài liệu này.

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. Make sure 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'
}

Thêm khoá API vào ứng dụng

Phần này mô tả cách lưu trữ khoá API để ứng dụng của bạn có thể tham chiếu một cách an toàn. Bạn không nên kiểm tra khoá API trong hệ thống kiểm soát phiên bản. Vì vậy, bạn nên lưu trữ khoá này trong tệp secrets.properties nằm trong thư mục gốc của dự án. Để biết thêm thông tin về tệp secrets.properties, hãy xem phần Tệp thuộc tính Gradle.

Để đơn giản hoá tác vụ này, bạn nên sử dụng Trình bổ trợ Secrets Gradle cho Android.

Cách cài đặt Trình bổ trợ Secrets Gradle cho Android trong dự án Google Maps:

Trong Android Studio, hãy mở tệp build.gradle.kts hoặc build.gradle cấp cao nhất rồi thêm mã sau vào phần tử dependencies trong buildscript.

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

Mở tệp build.gradle.kts hoặc build.gradle ở cấp mô-đun rồi thêm đoạn mã sau vào phần tử plugins.

Kotlin

plugins {
    // ...
    id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
}

Groovy

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

Trong tệp build.gradle.kts hoặc build.gradle ở cấp mô-đun, hãy đảm bảo rằng targetSdk và compileSdk được đặt thành 34.
Đồng bộ hoá dự án của bạn với Gradle.
Mở tệp secrets.properties trong thư mục cấp cao nhất, sau đó thêm đoạn mã sau. Thay thế YOUR_API_KEY bằng khoá API của bạn. Lưu trữ khoá của bạn trong tệp này vì secrets.properties không được đưa vào hệ thống quản lý phiên bản.
Lưu ý: Nếu tệp secrets.properties không tồn tại, hãy tạo tệp đó trong cùng thư mục với tệp local.properties.
```
MAPS_API_KEY=YOUR_API_KEY
```
Tạo tệp local.defaults.properties trong thư mục cấp cao nhất (cùng thư mục với tệp secrets.properties), rồi thêm mã sau.

Lưu ý: Nhập mã như hình. Đừng thay thế DEFAULT_API_KEY bằng khoá API của bạn.
```
MAPS_API_KEY=DEFAULT_API_KEY
```
Mục đích của tệp này là cung cấp một vị trí sao lưu cho khoá API nếu không tìm thấy tệp secrets.properties để các bản dựng không bị lỗi. Điều này có thể xảy ra nếu bạn sao chép ứng dụng từ một hệ thống kiểm soát phiên bản bỏ qua secrets.properties và bạn chưa tạo tệp secrets.properties cục bộ để cung cấp khoá API.
Trong tệp AndroidManifest.xml, hãy chuyển đến com.google.android.geo.API_KEY rồi cập nhật android:value attribute. Nếu thẻ <meta-data> không tồn tại, hãy tạo thẻ này dưới dạng thẻ con của thẻ <application>.
```
<meta-data
    android:name="com.google.android.geo.API_KEY"
    android:value="${MAPS_API_KEY}" />
```
Lưu ý: com.google.android.geo.API_KEY là tên siêu dữ liệu được đề xuất cho khoá API. Bạn có thể dùng một khoá có tên này để xác thực với nhiều API dựa trên Google Maps trên nền tảng Android, bao gồm cả Navigation SDK cho Android. Để đảm bảo khả năng tương thích ngược, API này cũng hỗ trợ tên com.google.android.maps.v2.API_KEY. Tên cũ này chỉ cho phép xác thực với Android Maps API phiên bản 2. Một ứng dụng chỉ có thể chỉ định một trong các tên siêu dữ liệu khoá API. Nếu bạn chỉ định cả hai, API sẽ gửi một trường hợp ngoại lệ.

Trong Android Studio, hãy mở tệp build.gradle.kts hoặc build.gradle ở cấp mô-đun rồi chỉnh sửa thuộc tính secrets. Nếu thuộc tính secrets không tồn tại, hãy thêm thuộc tính đó.

Chỉnh sửa các thuộc tính của trình bổ trợ để đặt propertiesFileName thành secrets.properties, đặt defaultPropertiesFileName thành local.defaults.properties và đặt mọi thuộc tính khác.

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

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

Thêm thông tin ghi nhận quyền tác giả bắt buộc vào ứng dụng của bạn

Nếu sử dụng Navigation SDK cho Android trong ứng dụng, bạn phải thêm văn bản ghi nhận quyền tác giả và giấy phép nguồn mở vào phần thông báo pháp lý của ứng dụng.

Bạn có thể tìm thấy văn bản ghi nhận quyền tác giả và giấy phép nguồn mở bắt buộc trong tệp zip Navigation SDK cho Android:

NOTICE.txt
LICENSES.txt

Thiết lập dự án -- Phiên bản 4.99 trở xuống Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.

Yêu cầu tối thiểu để sử dụng Navigation SDK

Thiết lập dự án: Dự án sử dụng Cloud Console và dự án Android

Thêm Navigation SDK vào dự án của bạn

Sử dụng Maven cho Navigation SDK phiên bản 4.5 trở lên (nên dùng)

Gradle

Maven

Sử dụng Maven cho Navigation SDK trước phiên bản 4.5 hoặc với Driver SDK

Gradle

Maven

Sử dụng gói AAR đã tải xuống (không nên dùng)

Định cấu hình bản dựng

Cập nhật thuộc tính tại địa phương

Cập nhật tập lệnh bản dựng Gradle

Thêm khoá API vào ứng dụng

Kotlin

Groovy

Kotlin

Groovy

Kotlin

Groovy

Thêm thông tin ghi nhận quyền tác giả bắt buộc vào ứng dụng của bạn

Thiết lập dự án -- Phiên bản 4.99 trở xuống