Konfigurowanie projektu na Androida Studio

UWAGA: pakiet SDK Miejsc na Androida w wersji 2.0.0 i nowszej jest zależny od AndroidX. Od tej wersji nie będzie już obsługiwana stara biblioteka pomocy. Aby zachować zgodność, musisz przenieść swoje projekty na AndroidX.

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

Krok 1. Skonfiguruj Android Studio

Ten dokument opisuje środowisko programistyczne korzystające z Android Studio Hedgehog i wtyczki Androida do obsługi Gradle w wersji 8.2.

Uwaga: jeśli Twoje środowisko programistyczne korzysta z innej wersji Android Studio lub Gradle, być może będziesz musiał(-a) zmodyfikować te czynności. Więcej informacji o wersjach Android Studio i Gradle znajdziesz w artykule Zgodność wtyczki Androida do obsługi Gradle i Android Studio.

Krok 2. Konfigurowanie pakietu SDK

Biblioteka pakietu SDK Miejsc na Androida jest dostępna w repozytorium Maven Google. Aby dodać pakiet SDK do aplikacji:

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

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

2. W pliku settings.gradle.kts najwyższego poziomu dodaj repozytorium Maven firmy Google i centralne repozytorium Maven w bloku dependencyResolutionManagement:

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

3. W sekcji dependencies build.gradle.ktspliku na poziomie modułu dodaj zależność od pakietu SDK Miejsc na Androida:

   Uwaga: pakiet SDK Miejsc na Androida w wersji 3.5.0 wymaga kotlin-bom w wersji 1.8.0 lub nowszej. Więcej informacji o zależności kotlin-bom znajdziesz w artykule Korzystanie z najnowszej wersji kotlin-stdlib w zależnościach przechodnich.

   Groovy

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

   Kotlin

             dependencies {
   
       // Places and Maps SDKs
       implementation("com.google.android.libraries.places:places:6.0.2")
   }

4. W pliku build.gradle.kts na poziomie modułu ustaw compileSdk i minSdk na te wartości:
   Uwaga: upewnij się, że compileSdk jest ustawiony na 34 lub wyższy, a minSdk jest ustawiony na 23 lub wyższy.

   Groovy

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

   Kotlin

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

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

   Groovy

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

   Kotlin

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

Krok 3. Dodaj klucz interfejsu API do projektu

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

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

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

1. W Android Studio otwórz plik build.gradle.kts lub build.gradle najwyższego poziomu i dodaj ten kod do bloku plugins.

   Kotlin

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

   Groovy

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

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.android.application")
       // ...
       id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
   }

   Groovy

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

3. Jeśli używasz Android Studio, zsynchronizuj swój projekt z Gradle.
4. Otwórz plik secrets.properties w katalogu najwyższego poziomu, a następnie dodaj ten kod. Zastąp YOUR_API_KEY swoim kluczem interfejsu API. Pamiętaj, aby dodać secrets.properties do swojego .gitignore pliku (lub w inny sposób wykluczyć go z systemu kontroli wersji), aby nie dodawać klucza interfejsu API do kontroli wersji.
   Uwaga: jeśli plik secrets.properties nie istnieje, utwórz go w tym samym folderze co plik local.properties.

   PLACES_API_KEY=YOUR_API_KEY

5. Utwórz plik local.defaults.properties w katalogu najwyższego poziomu, w tym samym folderze co plik secrets.properties, a następnie dodaj ten kod.

   Uwaga: wpisz kod tak, jak pokazano. Nie zastępuj DEFAULT_API_KEY swoim kluczem interfejsu API.

   PLACES_API_KEY=DEFAULT_API_KEY

   Ten plik ma na celu zapewnienie lokalizacji kopii zapasowej klucza interfejsu API jeśli plik secrets.properties nie zostanie znaleziony, aby kompilacje nie kończyły się niepowodzeniem. Może się to zdarzyć, jeśli sklonujesz aplikację z systemu kontroli wersji , który pomija secrets.properties i nie masz jeszcze lokalnie utworzonego pliku secrets.properties, aby podać klucz interfejsu API.

6. W Android Studio otwórz plik build.gradle.kts lub build.gradle na poziomie modułu 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 inne 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 root directory (the same folder as the root 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"
   }

   Groovy

   secrets {
       // To add your Maps API key to this project:
       // 1. If the secrets.properties file does not exist, create it in the root directory (the same folder as the root 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"
   }

Krok 4. Inicjowanie klienta interfejsu Places API

Aby zainicjować pakiet SDK Miejsc na Androida w aktywności lub fragmencie, 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);
    

WAŻNE: nigdy nie dodawaj kluczy interfejsu API bezpośrednio do kodu aplikacji. W środowiskach produkcyjnych zalecamy stosowanie a bezpiecznego mechanizmu zarządzania kluczami interfejsu API.

Możesz już zacząć korzystać z pakietu SDK Miejsc na Androida.

Krok 5. Skonfiguruj urządzenie z Androidem

Aby uruchomić aplikację korzystającą z pakietu SDK Miejsc na Androida, musisz wdrożyć ją na urządzeniu z Androidem lub emulatorze Androida, który jest oparty na Androidzie 6.0 lub nowszym i zawiera interfejsy API Google.

• Aby używać urządzenia z Androidem, postępuj zgodnie z instrukcjami w artykule Uruchamianie aplikacji na urządzeniu fizycznym.
• Aby używać Android Emulator, możesz utworzyć urządzenie wirtualne i zainstalować emulator za pomocą Menedżera urządzeń, który jest częścią Android Studio.
  Uwaga: jeśli zdecydujesz się używać emulatora Androida, wybierz profil urządzenia z ikoną Play,, wyświetlaną w kolumnie Sklep Play. Ta ikona oznacza że te profile są w pełni CTS i mogą używać obrazów systemu, które zawierają aplikację Sklep Play.

Dalsze kroki

Po skonfigurowaniu projektu możesz zapoznać się z przykładowymi aplikacjami.