Menyiapkan project Android Studio

Navigation SDK tersedia melalui Maven. Sesudah Anda membuat proyek pengembangan, Anda dapat mengintegrasikan SDK ke dalamnya dengan menggunakan salah satu pendekatan berikut.

Menggunakan Maven untuk Navigation SDK (direkomendasikan)

Berikut ini menggunakan repositori Maven google(), yang merupakan cara paling sederhana dan cara yang disarankan untuk menambahkan Navigation SDK ke project Anda.

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

   Gradle

   Tambahkan kode berikut ke build.gradle level 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 Anda memiliki dependensi yang menggunakan Maps SDK, Anda harus mengecualikan di setiap dependensi yang dideklarasikan yang bergantung pada Maps SDK.

   Gradle

   Tambahkan hal berikut ke build.gradle tingkat teratas:

   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 keberhasilan build dan penggunaan Navigation SDK.

Perbarui properti lokal

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

Mengupdate skrip build Gradle

• Buka file build.gradle (Module:app) dan gunakan panduan berikut untuk memperbarui pengaturan untuk memenuhi persyaratan untuk Navigation SDK, dan mempertimbangkan untuk menyetel serta opsi pengoptimalan.

  Setelan yang diperlukan untuk Navigation SDK

  1. Tetapkan minSdkVersion ke 23 atau lebih tinggi.
  2. Tetapkan targetSdkVersion ke 33 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. Mengganti nomor versi dalam dependensi dengan nomor versi terbaru versi yang tersedia.

  Setelan opsional untuk mengurangi waktu build

  • Aktifkan penyingkatan kode dan resource penyingkatan menggunakan R8/ProGuard untuk menghapus kode dan resource yang tidak digunakan dari dependensi. Jika langkah R8/ProGuard membutuhkan terlalu banyak waktu untuk dijalankan, sebaiknya aktifkan multidex untuk pengembangan perangkat lunak.
  • Mengurangi jumlah terjemahan bahasa yang disertakan dalam build: Setel resConfigs untuk satu bahasa selama pengembangan. Untuk build akhir, menyetel resConfigs untuk bahasa yang sebenarnya Anda gunakan. Secara default, Gradle menyertakan string resource untuk semua bahasa yang didukung oleh Navigation SDK.

  Menambahkan desugaring untuk dukungan Java8

  • Jika Anda membangun aplikasi menggunakan plugin Android Gradle 4.0.0 atau lebih tinggi, plugin memperluas dukungan untuk menggunakan sejumlah bahasa Java 8 Google Cloud Platform. Lihat Desugaring Java 8 tim dukungan untuk informasi selengkapnya. Lihat contoh cuplikan skrip build di bawah untuk mengetahui caranya kompilasi, dan opsi dependensi.

Di bawah ini adalah contoh skrip build Gradle untuk aplikasi. Periksa aplikasi contoh untuk kumpulan dependensi yang diupdate, Navigation SDK yang Anda gunakan mungkin sedikit lebih cepat atau di balik 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 33
        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:1.1.9'
}

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 atau build.gradle.kts tingkat teratas 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 modul dan tambahkan kode berikut ke elemen plugins.

   Groovy

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

   Kotlin

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

3. Di file 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 or build.gradle.kts 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.

    Groovy

    secrets {
        // Optionally specify a different file name containing your secrets.
        // The plugin defaults to "local.properties"
        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.*"
    }
            

    Kotlin

    secrets {
        // Optionally specify a different file name containing your secrets.
        // The plugin defaults to "local.properties"
        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 dalam aplikasi

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

Anda dapat menemukan teks atribusi dan lisensi open source yang diperlukan di File ZIP Navigation SDK untuk Android:

• NOTICE.txt
• LICENSES.txt