Hãy tham gia Ngày cộng đồng nhà phát triển Google Maps Platform tiếp theo của chúng tôi tại San Francisco vào tháng 12! Đăng ký ngay để tham dự.

Google sử dụng công nghệ AI để dịch nội dung sang ngôn ngữ bạn ưu tiên. Bản dịch bằng AI có thể có lỗi.

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 SDK Điều hướng 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 quá trình phát triển Android.

Yêu cầu tối thiểu để sử dụng SDK Điều hướng

Các yêu cầu này áp dụng cho SDK điều hướng cho Android phiên bản 4.99 trở xuống.

Google Cloud Console

dự án đã bật SDK Điều hướng. Để được cấp phép, hãy liên hệ với người đại diện của Google Maps Platform.
Ứng dụng của bạn phải nhắm đến cấp độ API mục tiêu 30 trở lên.
Để chạy một ứng dụng được xây dựng 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 tác giả và cấp phép vào ứng dụng.

Thiết lập dự án: Dự án trên Google Cloud Console và dự án Android

Trước khi có thể tạo hoặc thử nghiệm 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 xác thực khoá API. Dự án phải được cấp phép để truy cập vào SDK Điều hướng. Tất cả khoá trong dự án Google Cloud Console đều được cấp quyền truy cập như nhau vào SDK Điều hướng. Một khoá có thể liên kết với nhiều dự án phát triển. Nếu đã có 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 hay dùng, 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.
Hãy liên hệ với người đại diện của Google Maps Platform để cấp quyền truy cập vào SDK Điều hướng cho dự án của bạn trên Cloud Console.
Khi đang ở bảng điều khiển của 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 quy định 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à vân tay số, sau đó nhập tên gói của dự án phát triển và vân tay số SHA-1 cho khoá đó.
Nhấp vào Lưu.

Thêm SDK Điều hướng vào dự án của bạn

Bạn có thể sử dụng SDK điều hướng 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 cách sử dụng một trong các phương pháp sau.

Sử dụng Maven cho SDK điều hướng phiên bản 4.5 trở lên (nên dùng)

Sau đây là cách sử dụng kho lưu trữ Maven google(), đây là cách đơn giản nhất và được đề xuất để thêm SDK Điều hướng 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 bằng phiên bản SDK Điều hướng cho Android.

Gradle

Thêm đoạn mã sau vào tệp 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à cấu phần phần mềm đã thay đổi, đồng thời trình bổ trợ com.google.cloud.artifactregistry.gradle-plugin không còn cần thiết nữa.

Và thêm đoạn mã 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 đoạn mã 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 SDK Maps, 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 vào SDK Maps.

<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 SDK điều hướng trước phiên bản 4.5 hoặc với SDK trình điều khiển

SDK điều hướng tiếp tục được cung cấp bằng kho lưu trữ Maven ban đầu thông qua 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, đồng thời cung cấp khả năng tương thích với SDK trình điều khiển 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 về SDK Người tiêu dùng. Quyền truy cập vào SDK Điều hướng được kiểm soát thông qua một nhóm 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 bằng phiên bản SDK Điều hướng.

Gradle

Thêm đoạn mã sau vào tệp build.gradle ở cấp mô-đun:

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

Và thêm đoạn mã 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 đoạn mã 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 SDK Maps, 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 vào SDK Maps.

<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 cung cấp 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. Các hướng dẫn này giả định rằng bạn sử dụng Android Studio cho IDE của mình.

Tải phiên bản mới nhất của SDK Điều hướng 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 rồi thêm gói Dịch vụ Google Play bằng Trình quản lý SDK.
Trong 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 đoạn mã sau vào tệp build.gradle ở cấp mô-đun:

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

Và thêm đoạn mã 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 thành công SDK Điều hướng.

Cập nhật cơ sở lưu trú 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 của SDK Điều hướng, đồng thời cân nhắc việc đặt các tuỳ chọn tối ưu hoá.

Các 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 tạo bản dựng
- Bật tính năng rút gọn mã và rút gọn tài nguyên bằng R8/ProGuard để xoá 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 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 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 các ngôn ngữ bạn thực sự sử dụng. Theo mặc định, Gradle 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à ví dụ về tập lệnh bản dựng Gradle cho ứng dụng. Hãy kiểm tra ứng dụng mẫu để biết các nhóm phần phụ thuộc đã cập nhật, vì phiên bản SDK Điều hướng mà bạn đang sử 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 quản lý phiên bản, vì vậy, bạn nên lưu trữ khoá đó trong tệp secrets.properties trong thư mục gốc của dự án và loại trừ tệp đó khỏi hệ thống quản lý phiên bản. Để biết thêm thông tin về tệp thuộc tính Gradle, hãy xem phần Tệp thuộc tính Gradle.

Để đơn giản hoá việc 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 và lưu trữ khoá API:

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 khối plugins.

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
}

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

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

Nếu bạn sử dụng Android Studio, hãy đồng bộ hoá dự án với Gradle.
Mở tệp secrets.properties trong thư mục cấp cao nhất, rồi thêm đoạn mã sau. Thay thế YOUR_API_KEY bằng khoá API của bạn. Hãy nhớ thêm secrets.properties vào tệp .gitignore (hoặc loại trừ tệp này khỏi hệ thống quản lý phiên bản) để không đưa khoá API 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 minh hoạ. Đừ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 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.
Bạn có thể thêm khoá API vào tệp AndroidManifest.xml hoặc cung cấp khoá API theo phương thức lập trình.
- Thêm khoá API vào AndroidManifest.xml:
```
<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ả SDK Điều hướng cho Android. Để 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 ngoại lệ.
- Cung cấp khoá API theo phương thức lập trình:
  Trình bổ trợ Secrets Gradle cung cấp khoá trong lớp BuildConfig. Trong quá trình khởi chạy ứng dụng (ví dụ: trong phương thức Application.onCreate()), hãy gọi phương thức như sau:
  Kotlin
  1. Thêm các câu lệnh nhập sau:
    import com.google.android.libraries.navigation.NavigationApi
  2. Thêm đoạn mã sau vào phương thức Application.onCreate():
    NavigationApi.setApiKey(BuildConfig.MAPS_API_KEY)
  Java
  1. Thêm các câu lệnh nhập sau:
    import com.google.android.libraries.navigation.NavigationApi;
  2. Thêm đoạn mã sau vào phương thức Application.onCreate():
    NavigationApi.setApiKey(BuildConfig.MAPS_API_KEY);
  Lưu ý: Khi sử dụng setApiKey(), hãy lưu ý những điều sau:
  - Cung cấp khoá API không rỗng, không trống.
  - Chỉ gọi setApiKey() một lần trong suốt vòng đời của ứng dụng. Phương thức này sẽ gửi IllegalStateException nếu được gọi nhiều lần.
  - Gọi setApiKey() trước khi khởi chạy bất kỳ thành phần nào khác của SDK Điều hướng, chẳng hạn như Navigator.
  - Khoá bạn cung cấp bằng phương thức này sẽ ghi đè mọi khoá API trong AndroidManifest.xml của bạn.
  - Sử dụng SDK Điều hướng phiên bản 7.6 trở lên.

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 này.

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

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

Nếu sử dụng SDK Điều hướng cho Android trong ứng dụng, bạn phải đưa văn bản ghi công 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 công bắt buộc và giấy phép nguồn mở trong tệp zip của SDK Điều hướng dành 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 SDK Điều hướng

Thiết lập dự án: Dự án trên Google Cloud Console và dự án Android

Thêm SDK Điều hướng vào dự án của bạn

Sử dụng Maven cho SDK điều hướng phiên bản 4.5 trở lên (nên dùng)

Gradle

Maven

Sử dụng Maven cho SDK điều hướng trước phiên bản 4.5 hoặc với SDK trình điều khiển

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 cơ sở lưu trú 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

Java

Kotlin

Groovy

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

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