Konfigurowanie projektu w Android Studio

Na tej stronie dowiesz się, jak zintegrować pakiet Navigation SDK z projektem deweloperskim.

Dodawanie pakietu Navigation SDK do projektu

Pakiet Navigation SDK jest dostępny w repozytorium Google Maven Repository. Możesz dodać pakiet SDK do projektu, korzystając z konfiguracji Gradle build.gradle lub Maven pom.xml.

1. Dodaj tę zależność do konfiguracji Gradle lub Maven, zastępując symbol zastępczy VERSION_NUMBER żądaną wersją pakietu Navigation SDK na Androida.

   Gradle

   Dodaj te informacje do pliku build.gradle na poziomie modułu:

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

   Maven

   Dodaj te informacje do pliku pom.xml:

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

   com.google.cloud.artifactregistry.gradle-plugin

2. Jeśli masz zależności, które korzystają z pakietu Maps SDK, musisz wykluczyć zależność w każdej zadeklarowanej zależności, która bazuje na pakiecie Maps SDK.

   Gradle

   Dodaj te informacje do pliku build.gradle na najwyższym poziomie:

   allprojects {
           ...
           // Required: you must exclude the Google Play service Maps SDK from
           // your transitive dependencies to make sure 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

   Dodaj te informacje do pliku 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>
   

Konfigurowanie kompilacji

Po utworzeniu projektu możesz skonfigurować ustawienia, aby kompilacja się powiodła i można było korzystać z pakietu Navigation SDK.

Aktualizowanie właściwości lokalnych

• W folderze skryptów Gradle otwórz plik local.properties i dodaj android.useDeprecatedNdk=true.

Aktualizowanie skryptu kompilacji Gradle

• Otwórz plik build.gradle (Module:app) i postępuj zgodnie z tymi wskazówkami, aby zaktualizować ustawienia zgodnie z wymaganiami pakietu Navigation SDK. Rozważ też ustawienie opcji optymalizacji.

  Ustawienia wymagane w przypadku pakietu Navigation SDK

  1. Ustaw minSdkVersion na 24 lub wyższą.
  2. Ustaw targetSdkVersion na 36 lub wyższą.
  3. Dodaj ustawienie dexOptions, które zwiększa javaMaxHeapSize.
  4. Ustaw lokalizację dodatkowych bibliotek.
  5. Dodaj repositories i dependencies dla pakietu Navigation SDK.
  6. Zastąp numery wersji w zależnościach najnowszymi dostępnymi wersjami.

  Opcjonalne ustawienia skracające czas kompilacji

  • Włącz zmniejszanie kodu i zasobów za pomocą R8/ProGuard, aby usunąć nieużywany kod i zasoby z zależności. Jeśli wykonanie kroku R8/ProGuard trwa zbyt długo, rozważ włączenie multidexu na potrzeby prac deweloperskich.
  • Zmniejsz liczbę tłumaczeń językowych uwzględnianych w kompilacji: podczas programowania ustaw resConfigs dla 1 języka. W przypadku kompilacji końcowej ustaw resConfigs dla języków, których faktycznie używasz. Domyślnie Gradle zawiera ciągi zasobów dla wszystkich języków obsługiwanych przez pakiet Navigation SDK.

  Dodawanie desugaryzacji na potrzeby obsługi języka Java 8

  • Jeśli kompilujesz aplikację za pomocą wtyczki Androida do obsługi Gradle w wersji 4.0.0 lub nowszej, wtyczka rozszerza obsługę korzystania z wielu interfejsów API języka Java 8. Więcej informacji znajdziesz w artykule Obsługa desugaryzacji języka Java 8. Sposób kompilowania i opcje zależności znajdziesz w przykładowym fragmencie skryptu kompilacji poniżej.
  • W przypadku Androida w wersji 7.3.0 i nowszej musisz używać Gradle 8.11.1, wtyczki Androida do obsługi Gradle w wersji 8.10.0 oraz biblioteki Desugar com.android.tools:desugar_jdk_libs_nio:2.0.3.
  • Biblioteka Desugar musi być włączona w przypadku modułu app i każdego modułu, który jest bezpośrednio zależny od pakietu Navigation SDK.

Poniżej znajdziesz przykład skryptu kompilacji Gradle dla aplikacji. Sprawdź przykładowe aplikacje, aby zobaczyć zaktualizowane zestawy zależności, ponieważ wersja pakietu Navigation SDK, której używasz, może być nieco nowsza lub starsza niż ta dokumentacja.

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

Dodawanie klucza interfejsu API do aplikacji

W tej sekcji opisujemy, jak przechowywać klucz interfejsu API, aby aplikacja mogła się do niego bezpiecznie odwoływać. Nie należy sprawdzać klucza interfejsu API w systemie kontroli wersji, dlatego zalecamy przechowywanie go w pliku secrets.properties, który znajduje się w katalogu głównym projektu. Więcej informacji o pliku secrets.properties znajdziesz w Pliki właściwości Gradle.

Aby uprościć to zadanie, zalecamy używanie wtyczki Gradle obiektów tajnych na Androida .

Aby zainstalować wtyczkę Gradle obiektów tajnych na Androida i zapisać klucz interfejsu API:

1. W Androidzie Studio otwórz plik build.gradle na poziomie głównym i dodaj ten kod do elementu dependencies w sekcji buildscript.

   Groovy

   buildscript {
       dependencies {
           // ...
           classpath "com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1"
       }
   }

   Kotlin

   buildscript {
       dependencies {
           // ...
           classpath("com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1")
       }
   }

2. Otwórz plik build.gradle na poziomie aplikacji i dodaj ten kod do elementu plugins.

   Groovy

   plugins {
       id 'com.android.application'
       // ...
       id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
   }

   Kotlin

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

3. Jeśli używasz Androida Studio, zsynchronizuj projekt z Gradle.
4. Otwórz plik local.properties w katalogu na poziomie projektu, a następnie dodaj ten kod. Zastąp YOUR_API_KEY swoim kluczem interfejsu API.

   MAPS_API_KEY=YOUR_API_KEY

5. Możesz dodać klucz interfejsu API do pliku AndroidManifest.xml lub podać go programowo.
   • Dodaj klucz interfejsu API do pliku AndroidManifest.xml:

     <meta-data
         android:name="com.google.android.geo.API_KEY"
         android:value="${MAPS_API_KEY}" />
             

     Uwaga: com.google.android.geo.API_KEY to zalecana nazwa metadanych klucza interfejsu API. Klucz o tej nazwie może służyć do uwierzytelniania w wielu interfejsach API Google Maps na platformie Android, w tym w pakiecie Navigation SDK na Androida. Aby zachować zgodność wsteczną, interfejs API obsługuje też nazwę com.google.android.maps.v2.API_KEY. Ta starsza nazwa umożliwia uwierzytelnianie tylko w interfejsie API Map Google na Androida w wersji 2. Aplikacja może określić tylko jedną z nazw metadanych klucza interfejsu API. Jeśli zostaną określone obie nazwy, interfejs API zgłosi wyjątek.

   • Podaj klucz interfejsu API programowo:

     Wtyczka Gradle obiektów tajnych udostępnia klucz w klasie BuildConfig. Podczas inicjowania aplikacji (np. w metodzie Application.onCreate()) wywołaj metodę w ten sposób:

     Kotlin

     1. Dodaj te instrukcje importu:

        import com.google.android.libraries.navigation.NavigationApi

     2. Dodaj te informacje do metody Application.onCreate():

        NavigationApi.setApiKey(BuildConfig.MAPS_API_KEY)

     Java

     1. Dodaj te instrukcje importu:

        import com.google.android.libraries.navigation.NavigationApi;

     2. Dodaj te informacje do metody Application.onCreate():

        NavigationApi.setApiKey(BuildConfig.MAPS_API_KEY);

     Uwaga: podczas korzystania z setApiKey() pamiętaj o tych kwestiach:

     • Podaj klucz interfejsu API, który nie jest pusty ani nie zawiera wartości null.
     • Wywołaj setApiKey() tylko raz w trakcie działania aplikacji. Jeśli metoda zostanie wywołana więcej niż raz, zgłosi wyjątek IllegalStateException.
     • Wywołaj setApiKey() przed zainicjowaniem innych komponentów pakietu Navigation SDK, takich jak Navigator.
     • Klucz podany w tej metodzie zastępuje każdy klucz interfejsu API w pliku AndroidManifest.xml.
     • Używaj pakietu Navigation SDK w wersji 7.6 lub nowszej.

Dodawanie wymaganych informacji o autorze w aplikacji

Jeśli używasz w aplikacji pakietu Navigation SDK na Androida, musisz dodać informację o pochodzeniu danych i licencje open source w sekcji informacji prawnych aplikacji.

Wymagana informacja o pochodzeniu danych i licencje open source znajdziesz w pliku ZIP pakietu Navigation SDK na Androida:

• NOTICE.txt
• LICENSES.txt