이 가이드에서는 Android용 Navigation SDK를 사용하기 위한 빌드 구성 요구사항을 설명합니다. 이 안내는 Android IDE가 설치되어 있고 Android 개발에 익숙하다고 가정합니다.
Navigation SDK 사용을 위한 최소 요구사항
이 요구사항은 Android용 Navigation SDK 버전 4.99 이하에 적용됩니다.
Navigation SDK가 사용 설정된 Google Cloud 콘솔 프로젝트 프로비저닝에 관해서는 Google Maps Platform 담당자에게 문의하세요.
앱이 API 수준 30 이상을 타겟팅해야 합니다.
Navigation SDK로 빌드된 앱을 실행하려면 Android 기기에 Google Play 서비스가 설치되고 사용 설정되어 있어야 합니다.
저작자 표시 및 라이선스 텍스트를 앱에 추가해야 합니다.
프로젝트 설정: Cloud Console 프로젝트 및 Android 프로젝트
앱을 빌드하거나 테스트하려면 먼저 Cloud 콘솔 프로젝트를 만들고 API 키 사용자 인증 정보를 추가해야 합니다. 프로젝트에 Navigation SDK에 액세스할 수 있는 프로비저닝이 있어야 합니다. Cloud 콘솔 프로젝트 내의 모든 키에 Navigation SDK에 대한 동일한 액세스 권한이 부여됩니다. 키에 연결된 개발 프로젝트는 둘 이상일 수 있습니다. Console 프로젝트가 이미 있는 경우 현재 프로젝트에 키를 추가할 수 있습니다.
설정 방법
- 즐겨 사용하는 웹브라우저에서 Cloud Console에 로그인하고 Cloud Console 프로젝트를 만듭니다.
- Android 스튜디오와 같은 IDE에서 Android 앱 개발 프로젝트를 만들고 패키지 이름을 확인합니다.
- Google Maps Platform 담당자에게 문의하여 Cloud Console 프로젝트의 Navigation SDK에 대한 액세스 권한을 요청하세요.
- 웹브라우저의 Cloud 콘솔 대시보드에서 사용자 인증 정보를 만들어 제한이 있는 API 키를 생성합니다.
- API 키 페이지의 애플리케이션 제한사항 영역에서 Android 앱을 클릭합니다.
- 패키지 이름 및 지문 추가를 클릭한 다음 개발 프로젝트의 패키지 이름과 해당 키의 SHA-1 지문을 입력합니다.
- 저장을 클릭합니다.
프로젝트에 Navigation SDK 추가
Navigation SDK는 Maven을 통해 제공되거나 AAR 번들로 제공됩니다. 개발 프로젝트를 만든 후 다음 접근 방식 중 하나를 사용하여 SDK를 프로젝트에 통합할 수 있습니다.
Navigation SDK v4.5 이상용 Maven 사용 (권장)
다음은 프로젝트에 Navigation SDK를 추가하는 가장 간단하고 권장되는 방법인 google() Maven 저장소를 사용합니다.
Gradle 또는 Maven 구성에 다음 종속 항목을 추가하고 원하는 버전의 Android용 Navigation SDK에
VERSION_NUMBER자리표시자를 대체합니다.Gradle
모듈 수준
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>Maps SDK를 사용하는 종속 항목이 있는 경우 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>
v4.5 이전의 Navigation SDK 또는 Driver SDK에서 Maven 사용
Navigation SDK는 나머지 v4 버전까지 원래 Maven 저장소를 통해 계속 사용할 수 있습니다. 이 라이브러리는 위 버전과 동일한 업데이트를 모두 포함하며 전환 중에 Driver SDK 및 기타 라이브러리와의 호환성을 제공합니다. 이 종속 항목을 사용하려면 컴파일 시 gcloud를 통해 클라우드 프로젝트에 로그인해야 합니다.
- Consumer SDK 문서의 요구사항 섹션에 설명된 대로 Google의 Maven 저장소에 액세스하도록 환경을 설정합니다. Navigation SDK에 대한 액세스는 워크스페이스 그룹을 통해 제어됩니다.
원하는 버전의 Navigation SDK에
VERSION_NUMBER자리표시자를 대체하여 다음 종속 항목을 Gradle 또는 Maven 구성에 추가합니다.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>Maps SDK를 사용하는 종속 항목이 있는 경우 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를 통합할 수 있습니다. 이 안내는 IDE로 Android 스튜디오를 사용한다고 가정합니다.
공유 Google Drive에서 Navigation SDK의 최신 버전을 다운로드하고 압축을 풉니다. 액세스 권한이 없는 경우 담당자에게 문의하세요.
Android 스튜디오에서 프로젝트를 열고 SDK Manager를 사용하여 Google Play 서비스 패키지를 추가합니다.
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 요구사항을 충족하도록 설정을 업데이트하고 최적화 옵션도 설정해 보세요.Navigation SDK의 필수 설정
minSdkVersion을 23 이상으로 설정합니다.targetSdkVersion을 30 이상으로 설정합니다.javaMaxHeapSize를 늘리는dexOptions설정을 추가합니다.- 추가 라이브러리의 위치를 설정합니다.
- Navigation SDK에
repositories및dependencies를 추가합니다. - 종속 항목의 버전 번호를 사용 가능한 최신 버전으로 바꿉니다.
빌드 시간을 줄이는 선택적 설정
- R8/ProGuard를 사용하여 코드 축소 및 리소스 축소를 사용 설정하여 종속 항목에서 사용하지 않는 코드와 리소스를 삭제합니다. R8/ProGuard 단계를 실행하는 데 시간이 너무 오래 걸리는 경우 개발 작업에 멀티덱스를 사용 설정해 보세요.
- 빌드에 포함된 언어 번역 수 줄이기: 개발 중에 한 언어의
resConfigs를 설정합니다. 최종 빌드의 경우 실제로 사용하는 언어에resConfigs를 설정합니다. 기본적으로 Gradle에는 Navigation SDK에서 지원하는 모든 언어의 리소스 문자열이 포함됩니다.
다음은 애플리케이션의 Gradle 빌드 스크립트 예입니다. 사용 중인 Navigation 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 속성 파일을 참고하세요.
이 작업을 간소화하려면 Android용 Secrets Gradle 플러그인을 사용하는 것이 좋습니다.
Google 지도 프로젝트에 Android용 Secrets Gradle 플러그인을 설치하려면 다음 단계를 따르세요.
-
Android 스튜디오에서 최상위 수준
build.gradle.kts또는build.gradle파일을 열고 다음 코드를buildscript아래dependencies요소에 추가합니다.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
- 파일을 저장합니다.
-
최상위 수준 디렉터리에서
secrets.properties파일과 동일한 폴더에local.defaults.properties파일을 만든 후 다음 코드를 추가합니다.NAV_API_KEY=DEFAULT_API_KEY
이 파일의 목적은
secrets.properties파일이 없는 경우 빌드에 실패하지 않도록 API 키의 백업 위치를 제공하는 것입니다. 이는 버전 제어 시스템에서secrets.properties가 빠진 앱을 복제하거나 API 키를 제공하는secrets.properties파일을 아직 로컬에서 생성하지 않은 경우 발생할 수 있습니다. - 파일을 저장합니다.
-
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 키의 권장되는 메타데이터 이름입니다. 이 이름의 키는 Android 플랫폼에서 Android용 Navigation SDK를 비롯한 여러 Google 지도 기반 API를 인증하는 데 사용할 수 있습니다. 이전 버전과의 호환성을 위해 API에서는com.google.android.maps.v2.API_KEY이름도 지원합니다. 이 기존 이름을 사용하면 Android 지도 API v2만 인증할 수 있습니다. 애플리케이션은 API 키 메타데이터 이름 중 하나만 지정할 수 있습니다. 두 개가 모두 지정되면 API에서 예외가 발생합니다. -
Android 스튜디오에서 모듈 수준
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.*" }
앱에 필요한 저작자 표시 포함
앱에서 Android용 Navigation SDK를 사용하는 경우 앱의 법적 고지 섹션에 저작자 표시 문구와 오픈소스 라이선스를 포함해야 합니다.
Android용 Navigation SDK zip 파일에서 필요한 저작자 표시 텍스트와 오픈소스 라이선스를 확인할 수 있습니다.
NOTICE.txtLICENSES.txt