Konfigurowanie projektu na Androida Studio

POWIADOMIENIE: Pakiet SDK Miejsc dla systemu Android w wersji 2.0.0 i nowszych zależy od AndroidX. Począwszy od tej wersji, stara biblioteka pomocy nie będzie już obsługiwane. Aby zachować zgodność, musisz przenieść projekty do używa AndroidaX.

Aby skonfigurować aplikację do korzystania z pakietu SDK Miejsc na Androida, wykonaj te czynności kroków. Są one wymagane w przypadku wszystkich aplikacji korzystających z pakietu SDK Miejsc na Androida.

Krok 1. Skonfiguruj Android Studio

W tym dokumencie opisujemy środowisko programistyczne, w którym Android Studio Hedgehog oraz Wtyczka Androida do obsługi Gradle wersji 8.2.

Uwaga: jeśli w środowisku programistycznym używana jest inna wersja Androida Studio lub Gradle, może być konieczne zmodyfikowanie kroków w tych wersjach systemu. Więcej informacji na temat wersji Android Studio i Gradle znajdziesz w Wtyczka Android do obsługi Gradle i zgodność z Androidem Studio.

Krok 2. Konfigurowanie pakietu SDK

Biblioteka Places SDK dla Androida jest dostępna repozytorium Google Maven. Do Dodaj pakiet SDK do swojej aplikacji, wykonaj te czynności:

1. W pliku settings.gradle.kts najwyższego poziomu umieść w nim portal wtyczek Gradle, repozytorium Google Maven, i centralne repozytorium Maven. w ramach bloku pluginManagement. Blok pluginManagement musi występować przed innymi stwierdzeniami w skrypcie.

   pluginManagement {
       repositories {
           gradlePluginPortal()
           google()
           mavenCentral()
       }
   } 

2. W pliku settings.gradle.kts najwyższego poziomu umieść w nim Repozytorium Google Maven i centralne repozytorium Maven. w bloku dependencyResolutionManagement:

   dependencyResolutionManagement {
       repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
       repositories {
           google()
           mavenCentral()
       }
   } 

3. W: dependencies w pliku build.gradle na poziomie modułu dodaj zależność do pakietu SDK Miejsc na Androida:

   Uwaga: pakiet SDK Miejsc na Androida 3.5.0 wymaga kotlin-bom w wersji 1.8.0 lub nowszej. Dla: więcej informacji o zależności kotlin-bom znajdziesz tutaj Wykorzystanie najnowszej wersji kotlin-stdlib w zależnościach pośrednich.

   Zakręcony

   dependencies {
       // If updating kotlin-bom version number above, also edit project-level build.gradle definition of $kotlin_version variable
       implementation(platform("org.jetbrains.kotlin:kotlin-bom:$kotlin_version"))
       implementation 'com.google.android.libraries.places:places:3.3.0'
   }

   Kotlin

   dependencies {
       implementation(platform("org.jetbrains.kotlin:kotlin-bom:$kotlin_version"))
       implementation("com.google.android.libraries.places:places:3.5.0")
   }

4. W pliku build.gradle na poziomie modułu ustaw compileSdk i minSdk na te wartości:
   Uwaga: sprawdź, czy pole compileSdk jest ustawiono na 34 lub więcej oraz minSdk jest ustawiona na 21 lub więcej.

   Zakręcony

   android {
       compileSdk 34
   
       defaultConfig {
           minSdk 21
           // ...
       }
   }

   Kotlin

   android {
       compileSdk = 34
   
       defaultConfig {
           minSdk = 21
           // ...
       }
   }

5. W sekcji buildFeatures pliku build.gradle na poziomie modułu dodaj klasę BuildConfig, która służy do uzyskiwania dostępu do wartości metadanych zdefiniowanych później w ramach tej procedury:

   Zakręcony

   android {
     // ...
     buildFeatures {
       buildConfig true
       // ...
     }
   }

   Kotlin

   android {
     // ...
     buildFeatures {
       buildConfig = true
       // ...
     }
   }

Krok 3. Dodaj klucz interfejsu API do projektu

W tej sekcji opisano, jak zapisać klucz interfejsu API, aby umożliwić bezpieczne korzystanie z niego do aplikacji. Nie sprawdzaj klucza interfejsu API w systemie kontroli wersji, dlatego zalecamy i przechowywanie go w pliku secrets.properties, który znajduje się w katalogu głównym instancji w projektach AI. Więcej informacji o pliku secrets.properties znajdziesz tutaj: Pliki właściwości Gradle.

Aby usprawnić to zadanie, zalecamy skorzystanie z Wtyczka Gradle obiektów tajnych na Androida.

Uwaga: zapoznaj się z Wtyczka Gradle obiektów tajnych dla Androida dokumentacji w serwisie GitHub zawierającej najnowsze wymagania systemowe i instrukcje instalacji.

Aby zainstalować wtyczkę Gradle obiektów tajnych na Androida w projekcie Map Google:

1. W Android Studio otwórz build.gradle.kts lub build.gradle najwyższego poziomu. i dodaj ten kod do elementu dependencies pod buildscript

   Kotlin

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

   Zakręcony

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

2. Otwórz plik build.gradle.kts lub build.gradle na poziomie modułu i dodaj ten kod do elementu plugins.

   Kotlin

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

   Zakręcony

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

3. W pliku build.gradle.kts lub build.gradle na poziomie modułu sprawdź, że wartości targetSdk i compileSdk są ustawione do 34.
4. Zapisz plik i zsynchronizować projekt z Gradle.
5. Otwórz plik secrets.properties w katalogu najwyższego poziomu, a następnie dodaj tego kodu. Zastąp YOUR_API_KEY swoim kluczem interfejsu API. Przechowuj klucz w tym pliku ponieważ secrets.properties nie jest sprawdzany w kontroli wersji systemu.
   Uwaga: jeśli plik secrets.properties nie utwórz w tym samym folderze co plik local.properties.

   PLACES_API_KEY=YOUR_API_KEY

6. Zapisz plik.

7. Utwórz plik local.defaults.properties w katalogu najwyższego poziomu, tak samo jako plik secrets.properties, a potem dodaj podany niżej kod.

   Uwaga: wpisz kod, który wyświetla się poniżej. Nie zastępuj DEFAULT_API_KEY za pomocą klucza interfejsu API.

   PLACES_API_KEY=DEFAULT_API_KEY

   Ten plik ma na celu udostępnienie zapasowej lokalizacji klucza interfejsu API, jeśli plik Nie znaleziono pliku secrets.properties, więc kompilacje nie zawierają błędów. Może się tak zdarzyć, jeśli sklonujesz aplikację z systemu kontroli wersji, który pomija secrets.properties oraz nie utworzyłeś jeszcze lokalnie pliku secrets.properties, który umożliwi przesyłanie klucz interfejsu API.

8. Zapisz plik.

9. W Android Studio otwórz build.gradle.kts na poziomie modułu lub build.gradle i edytuj właściwość secrets. Jeśli Właściwość secrets nie istnieje. Dodaj ją.

   Edytuj właściwości wtyczki, aby ustawić propertiesFileName na secrets.properties, ustaw defaultPropertiesFileName na local.defaults.properties i ustaw pozostałe właściwości.

   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.*"
   }
           

   Zakręcony

   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.*"
   }
           

Krok 4. Inicjowanie klienta interfejsu Places API

Zainicjuj pakiet Places SDK dla Androida w aktywności lub fragmencie. Najpierw musisz wybierz wersję pakietu SDK, której chcesz użyć: Places SDK dla Androida lub Pakiet SDK Miejsc na Androida (nowość). Aby uzyskać więcej informacji o wersjach usługi, Więcej informacji znajdziesz w artykule Wybieranie wersji pakietu SDK.

Z przykładu poniżej dowiesz się, jak zainicjować pakiet SDK w obu wersjach.

Pakiet SDK Miejsc na Androida (nowość)

Przekaż klucz interfejsu API podczas wywoływania Places.initializeWithNewPlacesApiEnabled():

Kotlin

    // Define a variable to hold the Places API key.
    val apiKey = BuildConfig.PLACES_API_KEY

    // Log an error if apiKey is not set.
    if (apiKey.isEmpty() || apiKey == "DEFAULT_API_KEY") {
        Log.e("Places test", "No api key")
        finish()
        return
    }

    // Initialize the SDK
    Places.initializeWithNewPlacesApiEnabled(applicationContext, apiKey)

    // Create a new PlacesClient instance
    val placesClient = Places.createClient(this)
    

Java

    // Define a variable to hold the Places API key.
    String apiKey = BuildConfig.PLACES_API_KEY;

    // Log an error if apiKey is not set.
    if (TextUtils.isEmpty(apiKey) || apiKey.equals("DEFAULT_API_KEY")) {
      Log.e("Places test", "No api key");
      finish();
      return;
    }

    // Initialize the SDK
    Places.initializeWithNewPlacesApiEnabled(getApplicationContext(), apiKey);

    // Create a new PlacesClient instance
    PlacesClient placesClient = Places.createClient(this);
    

Pakiet SDK Miejsc na Androida

Przekaż klucz interfejsu API podczas wywoływania Places.initialize():

Kotlin

    // Define a variable to hold the Places API key.
    val apiKey = BuildConfig.PLACES_API_KEY

    // Log an error if apiKey is not set.
    if (apiKey.isEmpty() || apiKey == "DEFAULT_API_KEY") {
        Log.e("Places test", "No api key")
        finish()
        return
    }

    // Initialize the SDK
    Places.initialize(applicationContext, apiKey)

    // Create a new PlacesClient instance
    val placesClient = Places.createClient(this)
    

Java

    // Define a variable to hold the Places API key.
    String apiKey = BuildConfig.PLACES_API_KEY;

    // Log an error if apiKey is not set.
    if (TextUtils.isEmpty(apiKey) || apiKey.equals("DEFAULT_API_KEY")) {
      Log.e("Places test", "No api key");
      finish();
      return;
    }

    // Initialize the SDK
    Places.initialize(getApplicationContext(), apiKey);

    // Create a new PlacesClient instance
    PlacesClient placesClient = Places.createClient(this);
    

.

.

WAŻNE: nigdy nie dodawaj kluczy interfejsu API bezpośrednio do kodu aplikacji. W środowiskach produkcyjnych zalecamy korzystanie z interfejsu mechanizm zabezpieczony do zarządzania kluczami interfejsu API.

Możesz już zacząć korzystać z pakietu SDK Miejsc dla systemu Android.

Krok 5. Skonfiguruj urządzenie z Androidem

Aby uruchomić aplikację, która korzysta z pakietu SDK Miejsc dla Androida, należy wdrożyć ją na urządzeniu z Androidem lub na urządzeniu z Androidem emulator oparty na Androidzie 5.0 lub nowszym i obejmuje interfejsów API Google.

• Aby użyć urządzenia z Androidem, postępuj zgodnie z instrukcjami na stronie Uruchamianie aplikacji na urządzeniu
• Aby użyć emulatora Androida, możesz utworzyć urządzenie wirtualne i zainstalować emulator za pomocą: Menedżer urządzeń wirtualnych z Androidem (AVD), dostępne w Android Studio.
  Uwaga: jeśli zdecydujesz się użyć emulatora Androida, upewnij się, że wybierzesz urządzenie z ikoną Play, , widoczną w kolumnie Sklep Play. Ta ikona oznacza, że te profile są w pełni wyposażone w CTS. zgodne z zasadami i mogą używać obrazów systemu zawierających aplikację Sklep Play:

  

Dalsze kroki

Po skonfigurowaniu projektu możesz zobaczyć przykładowych aplikacji.