Menyiapkan project Android Studio

Halaman ini menjelaskan cara mengintegrasikan Navigation SDK ke dalam project pengembangan Anda.

Menambahkan Navigation SDK ke project Anda

Navigation SDK tersedia melalui Google Maven Repository. Anda dapat menambahkan SDK ke project menggunakan konfigurasi Gradle build.gradle atau Maven pom.xml.

  1. Tambahkan dependensi berikut ke konfigurasi Gradle atau Maven Anda, dengan mengganti placeholder VERSION_NUMBER dengan versi Navigation SDK for Android yang diinginkan.

    Gradle

    Tambahkan kode berikut ke build.gradle tingkat modul Anda:

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

    Maven

    Tambahkan kode berikut ke pom.xml Anda:

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

  2. Jika Anda memiliki dependensi yang menggunakan Maps SDK, Anda harus mengecualikan dependensi di setiap dependensi yang dideklarasikan yang mengandalkan Maps SDK.

    Gradle

    Tambahkan kode berikut ke build.gradle tingkat teratas Anda:

    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

    Tambahkan kode berikut ke pom.xml Anda:

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

Mengonfigurasi build

Setelah membuat project, Anda dapat mengonfigurasi setelan untuk build dan penggunaan Navigation SDK yang berhasil.

Memperbarui properti lokal

  • Di folder Gradle Scripts, buka file local.properties dan tambahkan android.useDeprecatedNdk=true.

Memperbarui skrip build Gradle

  • Buka file build.gradle (Module:app) dan gunakan panduan berikut untuk memperbarui setelan agar memenuhi persyaratan Navigation SDK dan pertimbangkan untuk menyetel opsi pengoptimalan juga.

    Setelan yang diperlukan untuk Navigation SDK

    1. Tetapkan minSdkVersion ke 23 atau yang lebih tinggi.
    2. Setel targetSdkVersion ke 34 atau yang lebih tinggi.
    3. Tambahkan setelan dexOptions yang meningkatkan javaMaxHeapSize.
    4. Tetapkan lokasi untuk library tambahan.
    5. Tambahkan repositories dan dependencies untuk Navigation SDK.
    6. Ganti nomor versi dalam dependensi dengan versi terbaru yang tersedia.

    Setelan opsional untuk mengurangi waktu build

    • Aktifkan penyingkatan kode dan penyingkatan resource menggunakan R8/ProGuard untuk menghapus kode dan resource yang tidak digunakan dari dependensi. Jika langkah R8/ProGuard memerlukan waktu terlalu lama untuk dijalankan, pertimbangkan untuk mengaktifkan multidex untuk tugas pengembangan.
    • Kurangi jumlah terjemahan bahasa yang disertakan dalam build: Tetapkan resConfigs untuk satu bahasa selama pengembangan. Untuk build akhir, tetapkan resConfigs untuk bahasa yang benar-benar Anda gunakan. Secara default, Gradle menyertakan string resource untuk semua bahasa yang didukung oleh Navigation SDK.

    Menambahkan desugaring untuk dukungan Java8

    • Jika Anda membuat aplikasi menggunakan plugin Android Gradle 4.0.0 atau yang lebih tinggi, plugin tersebut akan memperluas dukungan untuk penggunaan sejumlah API bahasa Java 8. Lihat dukungan desugaring Java 8 untuk mengetahui informasi selengkapnya. Lihat contoh cuplikan skrip build di bawah untuk mengetahui cara mengompilasi dan opsi dependensi.
    • Sebaiknya gunakan Gradle 8.4, plugin Android Gradle versi 8.3.0, dan library Desugar com.android.tools:desugar_jdk_libs_nio:2.0.3. Konfigurasi ini kompatibel dengan Navigation SDK for Android versi 6.0.0 dan yang lebih tinggi.
    • Library Desugar harus diaktifkan untuk modul app dan modul apa pun yang bergantung langsung pada Navigation SDK.

Berikut adalah contoh skrip build Gradle untuk aplikasi. Periksa aplikasi contoh untuk mengetahui kumpulan dependensi yang telah diupdate, karena versi Navigation SDK yang Anda gunakan mungkin sedikit lebih baru atau lebih lama dari dokumentasi ini.

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

Menambahkan kunci API ke aplikasi

Bagian ini menjelaskan cara menyimpan kunci API sehingga dapat dirujuk dengan aman oleh aplikasi Anda. Anda tidak boleh memasukkan kunci API ke dalam sistem kontrol versi Anda, jadi sebaiknya simpan kunci tersebut dalam file secrets.properties, yang terletak di direktori root project Anda. Untuk informasi selengkapnya tentang file secrets.properties, lihat file properti Gradle.

Untuk menyederhanakan tugas ini, sebaiknya Anda menggunakan Plugin Secrets Gradle untuk Android.

Untuk menginstal Plugin Secrets Gradle untuk Android dan menyimpan kunci API Anda:

  1. Di Android Studio, buka file build.gradle tingkat root dan tambahkan kode berikut ke elemen dependencies di bagian 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. Buka file build.gradle tingkat aplikasi dan tambahkan kode berikut ke elemen 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. Jika Anda menggunakan Android Studio, sinkronkan project Anda dengan Gradle.
  4. Buka local.properties di direktori tingkat project, lalu tambahkan kode berikut. Ganti YOUR_API_KEY dengan kunci API Anda. 
    MAPS_API_KEY=YOUR_API_KEY
  5. Dalam file AndroidManifest.xml Anda, buka com.google.android.geo.API_KEY dan perbarui atribut android:value sebagai berikut: 
    <meta-data
    android:name="com.google.android.geo.API_KEY"
    android:value="${MAPS_API_KEY}" />

    Catatan: com.google.android.geo.API_KEY adalah nama metadata yang disarankan untuk kunci API. Kunci dengan nama ini dapat digunakan untuk mengautentikasi beberapa API berbasis Google Maps sekaligus di platform Android, termasuk Navigation SDK for Android. Untuk kompatibilitas mundur, API tersebut juga mendukung nama com.google.android.maps.v2.API_KEY. Nama lama ini hanya memungkinkan autentikasi untuk Android Maps API v2. Aplikasi hanya dapat menentukan salah satu nama metadata kunci API. Jika keduanya ditentukan, API akan menampilkan pengecualian.

Sertakan atribusi yang diperlukan di aplikasi Anda

Jika Anda menggunakan Navigation SDK for Android di aplikasi, Anda harus menyertakan teks atribusi dan lisensi open source sebagai bagian dari bagian pemberitahuan hukum aplikasi Anda.

Anda dapat menemukan teks atribusi dan lisensi open source yang diperlukan dalam file zip Navigation SDK for Android:

  • NOTICE.txt
  • LICENSES.txt

Jika Anda adalah pelanggan Mobility atau Fleet Engine Deliveries

Jika Anda adalah pelanggan Mobility atau Fleet Engine Deliveries, pelajari penagihan dalam dokumentasi Mobility. Untuk mengetahui informasi selengkapnya tentang mencatat transaksi, lihat Menyiapkan penagihan, Mencatat transaksi yang dapat ditagih, Pelaporan, dan Mencatat transaksi yang dapat ditagih (Android).