ה-Navigation SDK זמין דרך Maven. אחרי כשיוצרים פרויקט פיתוח, אפשר לשלב בו את ה-SDK באמצעות אחת מהגישות הבאות.
שימוש ב-Maven ל-Navigation SDK (מומלץ)
בדוגמה הבאה משתמשים במאגר Maven, שהוא google()
הכי פשוט
הדרך המומלצת להוסיף את Navigation SDK לפרויקט.
מוסיפים את התלות הבאה להגדרות של 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>
אם יש לך יחסי תלות שמשתמשים ב-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, פותחים את הקובץ
local.properties
ומוסיפים אתandroid.useDeprecatedNdk=true
.
עדכון סקריפט ה-build של Gradle
פותחים את הקובץ
build.gradle (Module:app)
ומשתמשים בהנחיות הבאות כדי לעדכן את ההגדרות כך שתואמות לדרישות של Navigation SDK. כדאי גם להגדיר את אפשרויות האופטימיזציה.הגדרות נדרשות ל-Navigation SDK
- צריך להגדיר את הערך של
minSdkVersion
לערך 23 ואילך. - צריך להגדיר את הערך של
targetSdkVersion
לערך 33 ואילך. - צריך להוסיף הגדרת
dexOptions
שמגדילה את הערך שלjavaMaxHeapSize
. - הגדרת המיקום לספריות נוספות.
- מוסיפים את
repositories
ואתdependencies
עבור SDK ניווט. - מחליפים את מספרי הגרסאות ביחסי התלות בגרסאות העדכניות ביותר הזמינות.
הגדרות אופציונליות להקטנת זמן ה-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 לדוגמה שבהמשך כדי לראות איך אפשרויות הידור ותלות.
- צריך להגדיר את הערך של
בהמשך מוצגת דוגמה לסקריפט ה-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 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'
}
הוספת מפתח ה-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") } }
מגניב
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") }
מגניב
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 אם קובץ
secrets.properties
לא נמצא כדי שגרסאות ה-build לא ייכשלו. הדבר יכול להתרחש אם משכפלים את האפליקציה ממערכת לניהול גרסאות שמושמטת מ-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 גרסה 2. אפליקציה יכולה לציין רק אחד משמות המטא-נתונים של מפתח ה-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, עליך לכלול טקסט ייחוס ורישיונות קוד פתוח כחלק מההודעות המשפטיות של האפליקציה .
אפשר למצוא את טקסט השיוך הנדרש ואת רישיונות הקוד הפתוח SDK ניווט לקובץ ZIP של Android:
NOTICE.txt
LICENSES.txt
אם את/ה לקוח/ה של Mobility או Fleet Engine Deliveries
אם אתם לקוחות של Mobility או Fleet Engine Deliveries, כדאי לכם לקרוא על במסמכי התיעוד בנושא ניידות. מידע נוסף על תיעוד עסקאות, להגדיר חיוב, לתיעוד עסקאות לחיוב, דיווח, וכן תיעוד עסקאות לחיוב (Android).