בדף הזה מוסבר איך לשלב את Navigation SDK בפרויקט הפיתוח שלכם.
הוספת Navigation SDK לפרויקט
Navigation SDK זמין דרך מאגר Maven של Google.
אפשר להוסיף את ה-SDK לפרויקט באמצעות ההגדרה build.gradle
של Gradle או ההגדרה pom.xml
של Maven.
מוסיפים את יחסי התלות הבאים להגדרות של Gradle או Maven, ומחליפים את התו המשתנה
VERSION_NUMBER
בגרסה הרצויה של Navigation 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>
אם יש לכם יחסי תלות שמשתמשים ב-Maps SDK, עליכם להחריג את יחסי התלות בכל יחסי התלות המוצגים שמסתמכים על Maps SDK.
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
אחרי שתיצרו את הפרויקט, תוכלו להגדיר את ההגדרות ליצירה מוצלחת של Navigation SDK ולהשתמש בו.
עדכון נכסים מקומיים
- בתיקיית הסקריפטים של Gradle, פותחים את הקובץ
local.properties
ומוסיפים אתandroid.useDeprecatedNdk=true
.
עדכון מאפייני Gradle
בתיקיית הסקריפטים של Gradle, פותחים את הקובץ
gradle.properties
ומוסיפים את השורות הבאות, אם הן לא מופיעות כבר:android.useAndroidX=true
android.enableJetifier=true
עדכון סקריפט ה-build של Gradle
פותחים את הקובץ
build.gradle (Module:app)
ומשתמשים בהנחיות הבאות כדי לעדכן את ההגדרות כך שתואמות לדרישות של Navigation SDK. כדאי גם להגדיר את אפשרויות האופטימיזציה.הגדרות נדרשות ל-Navigation SDK
- מגדירים את
minSdkVersion
לערך 23 ומעלה. - מגדירים את
targetSdkVersion
ל-34 ומעלה. - מוסיפים הגדרה של
dexOptions
שמגדילה אתjavaMaxHeapSize
. - מגדירים את המיקום של ספריות נוספות.
- מוסיפים את
repositories
ו-dependencies
ל-Navigation SDK. - מחליפים את מספרי הגרסאות ביחסי התלות בגרסאות העדכניות ביותר הזמינות.
הגדרות אופציונליות להקטנת זמן ה-build
- הפעלה של כיווץ קוד וכיווץ משאבים באמצעות R8/ProGuard כדי להסיר קוד ומשאבים שלא נמצאים בשימוש מהיחסים של התלות. אם ריצה של שלב R8/ProGuard נמשכת יותר מדי זמן, כדאי להפעיל multidex לצורכי פיתוח.
- צמצום מספר התרגומים לשפות שכלולים ב-build: מגדירים את הערך
resConfigs
לשפה אחת במהלך הפיתוח. בגרסה הסופית של ה-build, צריך להגדיר אתresConfigs
לשפות שבהן אתם משתמשים בפועל. כברירת מחדל, Gradle כולל מחרוזות משאבים לכל השפות שנתמכות על ידי Navigation SDK.
הוספת הסרה של סוכר לתמיכה ב-Java8
- אם אתם מפתחים את האפליקציה באמצעות הפלאגין של Android Gradle מגרסה 4.0.0 ואילך, הפלאגין מרחיב את התמיכה בשימוש במספר ממשקי API של שפת Java 8. מידע נוסף זמין במאמר תמיכה ב-Java 8 להסרת סוכר. בקטע הקוד לדוגמה של סקריפט ה-build שבהמשך מוסבר איך להשתמש באפשרויות של הידור ויחסי תלות.
- מומלץ להשתמש ב-Gradle 8.4, בפלאגין Android Gradle בגרסה 8.3.0 ובספריית Desugar
com.android.tools:desugar_jdk_libs_nio:2.0.3
. ההגדרה הזו תואמת ל-Navigation SDK ל-Android מגרסה 6.0.0 ואילך. - צריך להפעיל את ספריית Desugar עבור המודול
app
וכל מודול שתלון ישירות ב-Navigation SDK.
- מגדירים את
בהמשך מוצגת דוגמה לסקריפט ה-build של Gradle לאפליקציה. מומלץ לבדוק את האפליקציות לדוגמה כדי למצוא קבוצות מעודכנות של יחסי תלות, כי ייתכן שגרסת Navigation 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:
-
ב-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" } }
-
פותחים את הקובץ
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' }
- בקובץ
build.gradle.kts
אוbuild.gradle
ברמת המודול, מוודאים שהערך שלtargetSdk
ו-compileSdk
מוגדר ל-34. - שומרים את הקובץ ומסנכרנים את הפרויקט עם Gradle.
-
פותחים את הקובץ
secrets.properties
בתיקיית הרמה העליונה ומוסיפים את הקוד הבא. מחליפים את הערךYOUR_API_KEY
במפתח ה-API שלכם. מומלץ לשמור את המפתח בקובץ הזה כיsecrets.properties
לא נכלל במערכת בקרת הגרסאות.NAV_API_KEY=YOUR_API_KEY
- שומרים את הקובץ.
-
יוצרים את הקובץ
local.defaults.properties
בספריית הרמה העליונה, באותה תיקייה שבה נמצא הקובץsecrets.properties
, ומוסיפים את הקוד הבא.NAV_API_KEY=DEFAULT_API_KEY
מטרת הקובץ הזה היא לספק מיקום גיבוי למפתח ה-API, כדי שה-builds לא יכשלו אם הקובץ
secrets.properties
לא נמצא. מצב כזה יכול לקרות אם משכפלים את האפליקציה ממערכת בקרת גרסאות שמשמיטה אתsecrets.properties
, ועדיין לא יצרתם קובץsecrets.properties
באופן מקומי כדי לספק את מפתח ה-API. - שומרים את הקובץ.
-
בקובץ
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}" />
הערה:
com.google.android.geo.API_KEY
הוא שם המטא-נתונים המומלץ למפתח ה-API. אפשר להשתמש במפתח עם השם הזה כדי לבצע אימות במספר ממשקי API שמבוססים על מפות Google בפלטפורמת Android, כולל Navigation SDK ל-Android. מטעמי תאימות לאחור, ה-API תומך גם בשםcom.google.android.maps.v2.API_KEY
. השם הקודם מאפשר אימות רק ל-Android Maps API v2. אפליקציה יכולה לציין רק אחד משמות המטא-נתונים של מפתח ה-API. אם מציינים את שניהם, ה-API יוצר חריגה. -
ב-Android Studio, פותחים את הקובץ
build.gradle.kts
אוbuild.gradle
ברמת המודול ועורכים את המאפייןsecrets
. אם הנכסsecrets
לא קיים, מוסיפים אותו.עורכים את המאפיינים של הפלאגין כדי להגדיר את
propertiesFileName
לערךsecrets.properties
, אתdefaultPropertiesFileName
לערךlocal.defaults.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 יכולים לקרוא מידע נוסף על החיוב במסמכי התיעוד של Mobility. למידע נוסף על תיעוד עסקאות, תוכלו לקרוא את המאמרים הגדרת חיוב, תיעוד עסקאות לחיוב, דיווח ותיעוד עסקאות לחיוב (Android).