הגדרת פרויקט Android Studio

בדף הזה מוסבר איך לשלב את Navigation SDK בפרויקט הפיתוח.

הוספת SDK לניווט לפרויקט

Navigation SDK זמין דרך מאגר Maven של Google. אפשר להוסיף את ה-SDK לפרויקט באמצעות Gradle build.gradle או הגדרה של Maven pom.xml.

  1. מוסיפים את התלות הבאה להגדרות של Gradle או Maven, מחליפים את ה-placeholder VERSION_NUMBER ב- הגרסה הרצויה של SDK ניווט ל-Android.

    Gradle

    מוסיפים את הפריטים הבאים ל-build.gradle ברמת המודול:

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

    Maven

    מוסיפים את הפרטים הבאים לקובץ pom.xml:

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

  2. אם יש לך יחסי תלות שמשתמשים ב-SDK של מפות Google, עליך להחריג את תלות בכל תלות מוצהרת שמסתמכת על ה-SDK של מפות Google.

    Gradle

    צריך להוסיף את הפריטים הבאים ל-build.gradle ברמה העליונה:

    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

    מוסיפים את הפרטים הבאים לקובץ 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>

הגדרת ה-build

לאחר יצירת הפרויקט, ניתן לקבוע את ההגדרות עבור פיתוח מוצלח של SDK ושימוש בו.

עדכון מאפיינים מקומיים

  • בתיקייה Gradle Scripts, פותחים את הקובץ local.properties ומוסיפים android.useDeprecatedNdk=true

עדכון סקריפט ה-build של Gradle

  • פותחים את הקובץ build.gradle (Module:app) ופועלים לפי ההנחיות הבאות כדי לעדכן את ההגדרות כך שיעמדו בדרישות של SDK לניווט וכדאי להגדיר את אפשרויות אופטימיזציה נוספות.

    ההגדרות הנדרשות ל-Navigation SDK

    1. מגדירים את minSdkVersion לערך 23 ומעלה.
    2. מגדירים את targetSdkVersion ל-34 ומעלה.
    3. צריך להוסיף הגדרת dexOptions שמגדילה את הערך של javaMaxHeapSize.
    4. הגדרת המיקום לספריות נוספות.
    5. מוסיפים את repositories ו-dependencies ל-Navigation SDK.
    6. מחליפים את מספרי הגרסאות של יחסי התלות במספר העדכני ביותר של הגרסאות הזמינות.

    הגדרות אופציונליות להקטנת זמן ה-build

    • הפעלה של כיווץ קוד וכיווץ משאבים באמצעות R8/ProGuard כדי להסיר קוד ומשאבים שלא נמצאים בשימוש מהיחסים התלויים. אם זמן הריצה של השלב R8/ProGuard ארוך מדי, מומלץ להפעיל multidex לצורכי פיתוח.
    • צמצום מספר התרגומים לשפות שכלולים ב-build: מגדירים את הערך resConfigs לשפה אחת במהלך הפיתוח. בשביל ה-build הסופי, להגדיר את resConfigs לשפות שבהן משתמשים בפועל. כברירת מחדל, Gradle כולל מחרוזות משאבים לכל השפות שנתמכות על ידי Navigation SDK.

    הוספת תמיכה ב-Java8 להסרת סוכר

    • אם אתם מפתחים את האפליקציה באמצעות הפלאגין Android Gradle מגרסה 4.0.0 או גבוהה יותר, הפלאגין מרחיב את התמיכה לשימוש במספר שפות Java 8 ממשקי API. מידע נוסף זמין במאמר תמיכה ב-Java 8 להסרת סוכר. בקטע הקוד לדוגמה של סקריפט ה-build שבהמשך מוסבר איך להשתמש באפשרויות של הידור ויחסי תלות.
    • מומלץ להשתמש ב-Gradle 8.4, בפלאגין Android Gradle בגרסה 8.3.0 ובספריית Desugar com.android.tools:desugar_jdk_libs_nio:2.0.3. ההגדרה הזו תואמת עם SDK ניווט ל-Android גרסה 6.0.0 ומעלה.
    • צריך להפעיל את ספריית Desugar למודול app ולכל שתלוי ישירות ב-Navigation SDK.

בהמשך מוצגת דוגמה לסקריפט ה-build של Gradle לאפליקציה. כדאי לבדוק את אפליקציות לדוגמה לקבוצות מעודכנות של יחסי תלות, כמו הגרסה של ערכת ה-SDK של הניווט שמשמשת אותך עשויה להוביל מעט קדימה, או שמאחורי התיעוד הזה.

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

הוספת מפתח ה-API לאפליקציה

בקטע הזה מוסבר איך לאחסן את מפתח ה-API כדי שתהיה אפשרות להפנות אליו באופן מאובטח באפליקציה שלך. אין לבדוק את מפתח ה-API במערכת ניהול הגרסאות, לכן מומלץ לאחסן אותו בקובץ secrets.properties, שממוקם בתיקיית השורש של פרויקט. מידע נוסף על הקובץ secrets.properties זמין במאמר קבצי מאפיינים של Gradle.

כדי לייעל את המשימה הזו, מומלץ להשתמש בפלאגין של Secrets Gradle ל-Android.

כדי להתקין את הפלאגין Secrets Gradle ל-Android בפרויקט במפות Google:

  1. ב-Android Studio, פותחים את הקובץ build.gradle.kts או build.gradle ברמה העליונה ומוסיפים את הקוד הבא לאלמנט dependencies בקטע 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. פותחים את הקובץ build.gradle.kts או build.gradle ברמת המודול ומוסיפים את הקוד הבא לאלמנט plugins.

    Kotlin

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

    Groovy

    plugins {
    // ...
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
}
  3. בקובץ build.gradle.kts או build.gradle ברמת המודול, מוודאים ההגדרות של targetSdk ו-compileSdk עד 34.
  4. שומרים את הקובץ ואז לסנכרן את הפרויקט עם Gradle
  5. פותחים את הקובץ secrets.properties בתיקיית הרמה העליונה ומוסיפים את הקוד הבא. מחליפים את הערך YOUR_API_KEY במפתח ה-API שלכם. אחסון המפתח בקובץ הזה כי secrets.properties לא נכלל בבדיקה לניהול גרסאות המערכת. 
    NAV_API_KEY=YOUR_API_KEY
  6. שומרים את הקובץ.

  7. יוצרים את הקובץ local.defaults.properties בספריית הרמה העליונה, באותה תיקייה שבה נמצא הקובץ secrets.properties, ומוסיפים את הקוד הבא.

    NAV_API_KEY=DEFAULT_API_KEY

    מטרת הקובץ הזה היא לספק מיקום לגיבוי של מפתח ה-API אם קובץ secrets.properties לא נמצא כדי שגרסאות ה-build לא ייכשלו. מצב כזה יכול לקרות אם משכפלים את האפליקציה ממערכת בקרת גרסאות שמשמיטה את secrets.properties, ועדיין לא יצרתם קובץ secrets.properties באופן מקומי כדי לספק את מפתח ה-API.

  8. שומרים את הקובץ.
  9. בקובץ AndroidManifest.xml, עוברים אל com.google.android.geo.API_KEY ולעדכן את android:value attribute. אם התג <meta-data> לא קיים, יוצרים אותו כצאצא של התג <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.*"
}

לכלול את הייחוסים הנדרשים באפליקציה

אם אתם משתמשים ב-Navigation SDK ל-Android באפליקציה, עליכם לכלול את טקסט השיוך ואת הרישיונות של קוד פתוח בקטע של ההודעות המשפטיות באפליקציה.

הטקסט הנדרש של הקרדיט והרישיונות של קוד פתוח מופיעים בקובץ ה-zip של Navigation SDK ל-Android:

  • NOTICE.txt
  • LICENSES.txt

אם אתם לקוחות של Mobility או של Fleet Engine Deliveries

אם אתם לקוחות של Mobility או Fleet Engine Deliveries, כדאי לכם לקרוא על במסמכי התיעוד בנושא ניידות. למידע נוסף על תיעוד עסקאות, תוכלו לקרוא את המאמרים הגדרת חיוב, תיעוד עסקאות לחיוב, דיווח ותיעוד עסקאות לחיוב (Android).