Thiết lập dự án Android Studio

Trang này giải thích cách tích hợp Navigation SDK vào dự án phát triển của bạn.

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

Navigation SDK có sẵn thông qua Kho lưu trữ Maven của Google. Bạn có thể thêm SDK vào dự án bằng cách sử dụng cấu hình build.gradle Gradle hoặc pom.xml Maven.

1. 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 for Android mà bạn muốn.

   Gradle

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

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

   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>
   

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

   Gradle

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

Đị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 cửa hàng đị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à sử dụng 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á.

  Các chế độ cài đặt bắt buộc cho Navigation SDK

  1. Đặt minSdkVersion thành 24 trở lên.
  2. Đặt targetSdkVersion thành 36 trở lên.
  3. Thêm một 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à 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 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ợ.

  Thêm tính năng đơn giản hoá để hỗ trợ Java8

  • Nếu bạn đang xây dựng ứng dụng bằng trình bổ trợ Android cho Gradle 4.0.0 trở lên, thì trình bổ trợ sẽ mở rộng khả năng hỗ trợ sử dụng một số API ngôn ngữ Java 8. Hãy xem phần Hỗ trợ việc loại bỏ đường cú pháp Java 8 để biết thêm thông tin. Hãy xem đoạn mã tập lệnh bản dựng mẫu bên dưới để biết cách biên dịch và các lựa chọn về phần phụ thuộc.
  • Sử dụng các phiên bản Gradle, trình bổ trợ Android cho Gradle (AGP) và thư viện Desugar phù hợp với phiên bản Navigation SDK của bạn. Hãy xem bảng sau.
  • Bạn cần bật thư viện Desugar cho mô-đun app và mọi mô-đun trực tiếp phụ thuộc vào Navigation SDK.

Bảng sau đây liệt kê các phiên bản Gradle, AGP và thư viện Desugar cần thiết cho từng phiên bản Navigation SDK.

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

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 34
        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_nio:2.1.5'
}

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á 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á thao tá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:

1. Trong Android Studio, hãy mở tệp build.gradle ở cấp gốc rồi thêm đoạn mã sau vào phần tử dependencies trong buildscript.

   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. Mở tệp build.gradle ở cấp ứng dụng rồi thêm đoạn mã sau vào phần tử plugins.

   Groovy

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

   Kotlin

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

3. Nếu bạn sử dụng Android Studio, hãy đồng bộ hoá dự án với Gradle.
4. Mở local.properties trong thư mục cấp dự án, sau đó thêm đoạn mã sau. Thay thế YOUR_API_KEY bằng khoá API của bạn.

   MAPS_API_KEY=YOUR_API_KEY

5. 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 khoá có tên này để xác thực cho 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ệ.

   • 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 và không có giá trị rỗng.
     • Chỉ gọi setApiKey() một lần trong vòng đời của ứng dụng. Phương thức này sẽ gửi một 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 Navigation SDK, chẳng hạn như Navigator.
     • Khoá mà bạn cung cấp bằng phương thức này sẽ ghi đè mọi khoá API trong AndroidManifest.xml.
     • Sử dụng Navigation SDK phiên bản 7.6 trở lên.

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

Nếu sử dụng Navigation SDK cho Android trong ứng dụng, bạn phải thêm 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 và giấy phép nguồn mở bắt buộc trong tệp ZIP Navigation SDK cho Android:

• NOTICE.txt
• LICENSES.txt