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 Repositori Maven Google. Anda dapat menambahkan SDK ke project menggunakan konfigurasi build.gradle Gradle atau pom.xml Maven.

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

    Gradle

    Tambahkan kode berikut ke build.gradle tingkat modul:

    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 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 level teratas Anda:

    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

    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 membangun dan menggunakan Navigation SDK dengan sukses.

Memperbarui properti lokal

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

Memperbarui properti gradle

  • Di folder Gradle Scripts, buka file gradle.properties dan tambahkan hal berikut jika belum ada:

    1. android.useAndroidX=true
    2. android.enableJetifier=true

Memperbarui skrip build Gradle

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

    Setelan yang diperlukan untuk Navigation SDK

    1. Tetapkan minSdkVersion ke 23 atau yang lebih tinggi.
    2. Tetapkan targetSdkVersion ke 34 atau 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 penciutan kode dan penyingkatan resource menggunakan R8/ProGuard untuk menghapus kode dan resource yang tidak digunakan dari dependensi. Jika langkah R8/ProGuard memerlukan terlalu banyak waktu untuk dijalankan, pertimbangkan untuk mengaktifkan multidex untuk pekerjaan 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 mem-build 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. Penyiapan ini kompatibel dengan Navigation SDK untuk Android versi 6.0.0 dan yang lebih tinggi.
    • Library Desugar perlu diaktifkan untuk modul app dan modul apa pun yang secara langsung bergantung pada Navigation SDK.

Berikut adalah contoh skrip build Gradle untuk aplikasi. Periksa aplikasi contoh untuk mengetahui kumpulan dependensi yang diperbarui, 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 gunakan Plugin Secrets Gradle untuk Android.

Untuk menginstal Plugin Secrets Gradle untuk Android di project Google Maps:

  1. Di Android Studio, buka file build.gradle.kts atau build.gradle tingkat teratas dan tambahkan kode berikut ke elemen dependencies di bagian 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"
    }
}
  2. Buka file build.gradle.kts atau build.gradle tingkat modul dan tambahkan kode berikut ke elemen plugins.

    Kotlin

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

    Groovy

    plugins {
    // ...
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
}
  3. Dalam file build.gradle.kts atau build.gradle tingkat modul, pastikan targetSdk dan compileSdk ditetapkan ke 34.
  4. Simpan file dan sinkronkan project Anda dengan Gradle.
  5. Buka file secrets.properties di direktori tingkat teratas, lalu tambahkan kode berikut. Ganti YOUR_API_KEY dengan kunci API Anda. Simpan kunci Anda dalam file ini karena secrets.properties tidak di-check in ke dalam sistem kontrol versi. 
    NAV_API_KEY=YOUR_API_KEY
  6. Simpan file.

  7. Buat file local.defaults.properties di direktori tingkat teratas, folder yang sama dengan file secrets.properties, lalu tambahkan kode berikut.

    NAV_API_KEY=DEFAULT_API_KEY

    File ini ditujukan untuk menyediakan lokasi cadangan Kunci API jika file secrets.properties tidak dapat ditemukan agar build tidak gagal. Build dapat gagal jika Anda meng-clone aplikasi dari sistem kontrol versi yang menghapus secrets.properties dan Anda belum membuat file secrets.properties secara lokal untuk memberikan Kunci API Anda.

  8. Simpan file.
  9. Di file AndroidManifest.xml, buka com.google.android.geo.API_KEY, lalu perbarui android:value attribute. Jika tag <meta-data> tidak ada, buat tag tersebut sebagai turunan dari tag <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.kts or build.gradle 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.

    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"

    // 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.*"
}

    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"

    // 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.*"
}

Menyertakan atribusi yang diperlukan di aplikasi Anda

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

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

  • NOTICE.txt
  • LICENSES.txt

Jika Anda adalah pelanggan Mobility atau Fleet Engine Delivery

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