คู่มือนี้แสดงข้อกำหนดในการกำหนดค่าบิลด์สำหรับการใช้ Navigation SDK สำหรับ Android วิธีการนี้จะสมมติว่าคุณมี Android IDE ติดตั้งและคุ้นเคยกับการพัฒนาซอฟต์แวร์ Android
ข้อกำหนดขั้นต่ำสำหรับการใช้ Navigation SDK
ข้อกำหนดเหล่านี้มีผลกับ Navigation SDK สำหรับ Android เวอร์ชัน 4.99 และเวอร์ชันก่อนหน้า
โปรเจ็กต์ Google Cloud Console ที่เปิดใช้ Navigation SDK โปรดสอบถามตัวแทน Google Maps Platform สำหรับการจัดสรร
แอปของคุณต้องกำหนดเป้าหมายเป็น API ระดับ 30 ขึ้นไป
ในการเรียกใช้แอปที่สร้างด้วย Navigation SDK ระบบปฏิบัติการ Android อุปกรณ์ต้องมีบริการ Google Play ติดตั้งและเปิดใช้แล้ว
ตั้งค่าโปรเจ็กต์: โปรเจ็กต์ Cloud Console และโปรเจ็กต์ Android
คุณต้องสร้างโปรเจ็กต์ Cloud Console ก่อน จึงจะสร้างหรือทดสอบแอปได้ และเพิ่มข้อมูลเข้าสู่ระบบคีย์ API โปรเจ็กต์ต้องมีการจัดสรรเพื่อเข้าถึง SDK การนำทาง คีย์ทั้งหมดในโปรเจ็กต์ Cloud Console ได้รับสิทธิ์เข้าถึง Navigation SDK ในระดับเดียวกัน คีย์ เชื่อมโยงโปรเจ็กต์การพัฒนาได้มากกว่า 1 โปรเจ็กต์ หากมีโปรเจ็กต์คอนโซลอยู่แล้ว คุณจะเพิ่มคีย์ในโปรเจ็กต์ปัจจุบันได้
วิธีตั้งค่า
- ในเว็บเบราว์เซอร์ที่คุณชื่นชอบ ให้ลงชื่อเข้าใช้ Cloud Console และสร้าง Cloud Console
- ใน IDE เช่น Android Studio ให้สร้างการพัฒนาแอป Android โปรเจ็กต์และจดชื่อแพ็กเกจ
- โปรดติดต่อตัวแทน Google Maps Platform เพื่อให้สิทธิ์การเข้าถึง Navigation SDK สำหรับ Cloud Console
- เมื่ออยู่ในแดชบอร์ด Cloud Console ในเว็บเบราว์เซอร์ สร้างข้อมูลเข้าสู่ระบบเพื่อสร้างคีย์ API ที่มีข้อจำกัด
- ในหน้าคีย์ API ให้คลิกแอป Android ในการจำกัดแอปพลิเคชัน ของคุณ
- คลิกเพิ่มชื่อแพ็กเกจและลายนิ้วมือ แล้วป้อนแพ็กเกจ ชื่อโปรเจ็กต์การพัฒนาและลายนิ้วมือ SHA-1 สำหรับคีย์ดังกล่าว
- คลิกบันทึก
เพิ่ม Navigation SDK ลงในโปรเจ็กต์
Navigation SDK มีให้บริการผ่าน Maven หรือ แพ็กเกจ AAR หลังจากสร้างโปรเจ็กต์การพัฒนาแล้ว คุณจะผสานรวม SDK เข้ากับโปรเจ็กต์ได้โดย โดยใช้วิธีใดวิธีหนึ่งต่อไปนี้
การใช้ Maven สำหรับ SDK การนำทาง เวอร์ชัน 4.5 ขึ้นไป (แนะนำ)
รายการต่อไปนี้ใช้ที่เก็บ google()
ของ Maven ซึ่งใช้งานง่ายที่สุด
และวิธีที่แนะนำสำหรับการเพิ่ม Navigation SDK ลงใน
โปรเจ็กต์
เพิ่มทรัพยากร Dependency ต่อไปนี้ในการกำหนดค่า Gradle หรือ Maven โดยแทนที่ตัวยึดตำแหน่ง
VERSION_NUMBER
ด้วยค่า เวอร์ชันที่ต้องการของ Navigation SDK สำหรับ AndroidGradle
เพิ่มข้อมูลต่อไปนี้ลงใน
build.gradle
ระดับโมดูลdependencies { ... implementation 'com.google.android.libraries.navigation:navigation:VERSION_NUMBER' }
หากอัปเกรดจากที่เก็บ Maven เดิม โปรดทราบว่ากลุ่มและ มีการเปลี่ยนแปลงชื่ออาร์ติแฟกต์ และ ใช้งานปลั๊กอิน
com.google.cloud.artifactregistry.gradle-plugin
ไม่ได้อีกต่อไป ตามความจำเป็นและเพิ่มรายการต่อไปนี้ใน
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>com.google.android.libraries.navigation</groupId> <artifactId>navigation</artifactId> <version>VERSION_NUMBER</version> </dependency> </dependencies>
หากคุณมีทรัพยากร Dependency ที่ใช้ Maps SDK คุณต้องยกเว้น Dependency ในทรัพยากร Dependency ที่ประกาศแต่ละรายการที่ต้องใช้ Maps SDK
<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>
การใช้ Maven สำหรับ SDK การนำทางเวอร์ชันก่อนหน้าเวอร์ชัน 4.5 หรือ SDK ไดรเวอร์
Navigation SDK ยังคงใช้งานได้ผ่าน
ที่เก็บ Maven ดั้งเดิมจนถึงเวอร์ชัน v4 ที่เหลือ นี่คือ
ไลบรารีเดียวกันที่มีการอัปเดตเหมือนกับเวอร์ชันด้านบนทั้งหมด
ความเข้ากันได้กับ Driver SDK และไลบรารีอื่นๆ ในระหว่างการเปลี่ยน การใช้
ทรัพยากร Dependency นี้จำเป็นต้องเข้าสู่ระบบโปรเจ็กต์ระบบคลาวด์ผ่าน gcloud
เมื่อ
ในการคอมไพล์
- ตั้งค่าสภาพแวดล้อมของคุณเพื่อเข้าถึงที่เก็บ Maven ของ Google ตามที่อธิบายไว้ใน ข้อกำหนดเบื้องต้น ในเอกสารประกอบของ Consumer SDK สิทธิ์เข้าถึง SDK การนำทางควบคุมผ่านกลุ่มพื้นที่ทำงาน
เพิ่มทรัพยากร Dependency ต่อไปนี้ในการกำหนดค่า Gradle หรือ Maven โดยแทนที่
VERSION_NUMBER
ตัวยึดตำแหน่งสำหรับ Navigation SDK เวอร์ชันที่ต้องการGradle
เพิ่มข้อมูลต่อไปนี้ลงใน
build.gradle
ระดับโมดูลdependencies { ... implementation 'com.google.android.maps:navsdk:VERSION_NUMBER' }
และเพิ่มรายการต่อไปนี้ใน
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>com.google.android.maps</groupId> <artifactId>navsdk</artifactId> <version>VERSION_NUMBER</version> </dependency> </dependencies>
หากคุณมีทรัพยากร Dependency ที่ใช้ Maps SDK คุณต้องยกเว้น Dependency ในทรัพยากร Dependency ที่ประกาศแต่ละรายการที่ต้องใช้ Maps SDK
<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>
การใช้แพ็กเกจ AAR ที่ดาวน์โหลด (ไม่แนะนำ)
Navigation SDK มีให้บริการเป็นแพ็กเกจ AAR ด้วย หลังจากสร้างโปรเจ็กต์การพัฒนาแล้ว คุณจะผสานรวม SDK ได้ วิธีการเหล่านี้ ต้องใช้ Android Studio สำหรับ IDE ของคุณ
ดาวน์โหลด Navigation SDK เวอร์ชันล่าสุด จาก Google ไดรฟ์ที่แชร์ และแตกไฟล์ หากคุณ ไม่มีสิทธิ์เข้าถึง โปรดติดต่อตัวแทนของคุณ
ใน Android Studio ให้เปิดโปรเจ็กต์และ เพิ่มแพ็กเกจบริการ Google Play โดยใช้ SDK Manager
จากไดเรกทอรีไฟล์ ZIP ให้คัดลอก
libs/google_navigation_navmap.aar
ไปไว้ใน ไดเรกทอรีapp/libs
ของโปรเจ็กต์เพิ่มข้อมูลต่อไปนี้ลงใน
build.gradle
ระดับโมดูลimplementation(name: 'google_navigation_navmap', ext: 'aar')
และเพิ่มรายการต่อไปนี้ใน
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' } } }
กำหนดค่าบิลด์
หลังจากสร้างโปรเจ็กต์แล้ว คุณจะกำหนดการตั้งค่าสำหรับ ในการสร้างและใช้ Navigation SDK อย่างถูกต้อง
อัปเดตพร็อพเพอร์ตี้ในพื้นที่
- ในโฟลเดอร์ Gradle Scripts ให้เปิดไฟล์
local.properties
และเพิ่มandroid.useDeprecatedNdk=true
อัปเดตสคริปต์บิลด์ Gradle
เปิดไฟล์
build.gradle (Module:app)
และใช้หลักเกณฑ์ต่อไปนี้เพื่อ อัปเดตการตั้งค่าให้เป็นไปตามข้อกำหนดของ Navigation SDK และพิจารณาตั้งค่าตัวเลือกการเพิ่มประสิทธิภาพด้วยการตั้งค่าที่จำเป็นสำหรับ SDK การนำทาง
- โปรดตั้งค่า
minSdkVersion
เป็น 23 ขึ้นไป - ตั้งค่า
targetSdkVersion
เป็น 30 ขึ้นไป - เพิ่มการตั้งค่า
dexOptions
ที่จะเพิ่มjavaMaxHeapSize
- ตั้งค่าตำแหน่งสำหรับไลบรารีเพิ่มเติม
- เพิ่ม
repositories
และdependencies
สำหรับ Navigation SDK - แทนที่หมายเลขเวอร์ชันในทรัพยากร Dependency ด้วยเวอร์ชันล่าสุดที่มีอยู่
การตั้งค่าที่ไม่บังคับเพื่อลดเวลาบิลด์
- เปิดใช้ การย่อโค้ดและการย่อทรัพยากร โดยใช้ R8/ProGuard เพื่อนำโค้ดและทรัพยากรที่ไม่ได้ใช้ออกจากทรัพยากร Dependency หากขั้นตอน R8/ProGuard ใช้เวลาเรียกใช้มากเกินไป ให้พิจารณาเปิดใช้ multidex สำหรับงานพัฒนาต่างๆ
- ลดจำนวนการแปลเป็นภาษาที่รวมอยู่ในบิลด์: ตั้งค่า
resConfigs
สำหรับ 1 ภาษาระหว่างการพัฒนา สำหรับบิลด์สุดท้าย ให้ตั้งค่าresConfigs
สำหรับภาษาที่คุณใช้จริง โดยค่าเริ่มต้น Gradle จะรวม สตริงทรัพยากรสำหรับทุกภาษาที่ Navigation SDK สนับสนุน
- โปรดตั้งค่า
ด้านล่างเป็นตัวอย่างของสคริปต์บิลด์ Gradle สำหรับแอปพลิเคชัน ตรวจสอบ แอปตัวอย่างสำหรับชุดทรัพยากร Dependency ที่อัปเดตแล้ว เป็นเวอร์ชันของ SDK การนำทางที่คุณใช้อยู่อาจนำหน้าไปเล็กน้อยหรือ ที่อยู่เบื้องหลังเอกสารนี้
apply plugin: 'com.android.application'
apply plugin: 'com.google.cloud.artifactregistry.gradle-plugin'
ext {
androidxVersion = "1.0.0"
lifecycle_version = "1.1.1"
}
android {
compileSdkVersion 30
buildToolsVersion '28.0.3'
defaultConfig {
applicationId "<your id>"
// Navigation SDK supports SDK 23 and later.
minSdkVersion 23
targetSdkVersion 30
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 {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}
// This tells Gradle where to look to find additional libraries - in this case, the
// google_navigation_navmap.aar file.
repositories {
flatDir {
dirs 'libs'
}
google()
// Required for accessing the Navigation SDK on Google's Maven repository.
maven {
url "artifactregistry://us-west2-maven.pkg.dev/gmp-artifacts/transportation"
}
}
dependencies {
// Include the Google Navigation SDK
implementation 'com.google.android.maps:navsdk:4.4.0'
// The included AAR file under libs can be used instead of the Maven repository.
// Uncomment the line below and comment out the previous dependency to use
// the AAR file instead. Ensure that you add the AAR file to the libs directory.
// implementation(name: 'google_navigation_navmap', ext: 'aar')
// These dependencies are required for the Navigation SDK to function
// properly at runtime.
implementation 'org.chromium.net:cronet-fallback:69.3497.100'
// Optional for Cronet users:
// implementation 'org.chromium.net:cronet-api:69.3497.100'
implementation 'androidx.appcompat:appcompat:${androidxVersion}'
implementation 'androidx.cardview:cardview:${androidxVersion}'
implementation 'com.google.android.material:material:${androidxVersion}'
implementation 'androidx.mediarouter:mediarouter:${androidxVersion}'
implementation 'androidx.preference:preference:${androidxVersion}'
implementation 'androidx.recyclerview:recyclerview:${androidxVersion}'
implementation 'androidx.legacy:legacy-support-v4:${androidxVersion}'
implementation 'com.github.bumptech.glide:glide:4.9.0'
implementation 'com.github.bumptech.glide:okhttp-integration:4.9.0'
implementation 'android.arch.lifecycle:common-java8:$lifecycle_version'
implementation 'com.android.support:multidex:1.0.3'
implementation 'com.google.android.datatransport:transport-api:2.2.0'
implementation 'com.google.android.datatransport:transport-backend-cct:2.2.0'
implementation 'com.google.android.datatransport:transport-runtime:2.2.0'
implementation 'joda-time:joda-time:2.9.9'
annotationProcessor 'androidx.annotation:annotation:1.1.0'
annotationProcessor 'com.github.bumptech.glide:compiler:4.9.0'
}
เพิ่มคีย์ API ลงในแอป
ส่วนนี้จะอธิบายวิธีจัดเก็บคีย์ API เพื่อให้ใช้อ้างอิงได้อย่างปลอดภัยโดย
แอปของคุณ คุณไม่ควรตรวจสอบคีย์ API ในระบบควบคุมเวอร์ชัน เราจึงขอแนะนำ
จัดเก็บไว้ในไฟล์ secrets.properties
ซึ่งอยู่ในไดเรกทอรีรากของ
ดูข้อมูลเพิ่มเติมเกี่ยวกับไฟล์ secrets.properties
ได้ที่
ไฟล์คุณสมบัติ Gradle
เราขอแนะนำให้คุณใช้ ปลั๊กอินข้อมูลลับ Gradle สำหรับ Android
วิธีติดตั้งปลั๊กอิน Secrets Gradle สำหรับ Android ในโปรเจ็กต์ Google Maps
-
ใน 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
เพื่อไม่ให้บิลด์ล้มเหลว เหตุการณ์นี้อาจเกิดขึ้นได้หาก คุณโคลนแอปจากระบบควบคุมเวอร์ชันที่ยกเว้น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 Maps บนแพลตฟอร์ม 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.*" }
ดึงดูด
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