Wtyczka Gradle usług Google

Wprowadzenie

W ramach włączania interfejsów API Google lub usług Firebase w aplikacji na Androida konieczne może być dodanie wtyczki google-services do pliku build.gradle:

dependencies {
    classpath 'com.google.gms:google-services:4.3.15'
    // ...
}

Wtyczka google-services ma 2 główne funkcje:

1. Przetwarzanie pliku google-services.json i tworzenie zasobów Androida, których można użyć w kodzie aplikacji. Więcej informacji znajdziesz w sekcji Dodawanie pliku JSON.

2. Dodaj zależności dla podstawowych bibliotek wymaganych dla włączonych usług. Ten krok wymaga zastosowania wtyczki Gradle Usług Google w pliku app/build.gradle, na przykład:
   apply plugin: 'com.google.gms.google-services'

   Wynik tego kroku możesz zobaczyć, uruchamiając ./gradlew :app:dependencies.

Dodawanie pliku JSON

Plik google-services.json znajduje się zazwyczaj w katalogu app/ (w katalogu głównym modułu aplikacji na Androida Studio). Od wersji 2.2.0 wtyczka obsługuje pliki JSON związane z typem i smakiem produktu. Wszystkie prawidłowe struktury katalogów są prawidłowe:

// dogfood and release are build types.
app/
    google-services.json
    src/dogfood/google-services.json
    src/release/google-services.json
    ...

Uwaga: udostępnienie pliku google-services.json w katalogu wersji umożliwia obsługę osobnego projektu Firebase dla produkcyjnych plików APK.

W przypadku stosowania smaków produktów bardziej złożone są także bardziej złożone struktury katalogów.

// free and paid are product flavors.
app/
    google-services.json
    src/dogfood/paid/google-services.json
    src/release/free/google-services.json
    ...

Przetwarzanie pliku JSON

Plik google-services.json ma taką podstawową strukturę:

{
  "project_info": {...},
  "client": [...],
}

Obiekt project_info zawiera ogólne informacje o Twoim projekcie, natomiast każdy element tablicy client zawiera informacje o klientach (aplikacjach na Androida) dodanych do projektu.

Podczas przetwarzania pliku JSON aplikacji na Androida wtyczka używa tylko obiektu client zgodnego z nazwą pakietu (dla bieżącego typu kompilacji) na podstawie tej logiki:

• Dla każdego użytkownika tablicy client:
  • Sprawdź wartość client_info/android_client_info/package_name
  • Jeśli nazwa pakietu odpowiada tej wartości, zwróć obiekt członkowski.
• Jeśli żaden z członków grupy client nie pasuje do nazwy pakietu, zostanie zgłoszony wyjątek.

W pozostałej części dokumentu użyjemy {YOUR_CLIENT}, aby odwołać się do użytkownika tablicy client zgodnie z powyższą procedurą.

Głównym wynikiem przetwarzania JSON jest utworzenie dwóch plików XML, które możesz umieścić w kodzie Java jako zasoby Androida. Oto przykład każdego pliku:

app/build/generate/res/google-services/{build_type}/values/values.xml

<?xml version="1.0" encoding="utf-8"?>
<resources>

    <! -- Present in all applications -->
    <string name="google_app_id" translatable="false">1:1035469437089:android:73a4fb8297b2cd4f</string>

    <! -- Present in applications with the appropriate services configured -->
    <string name="gcm_defaultSenderId" translatable="false">1035469437089</string>
    <string name="default_web_client_id" translatable="false">337894902146-e4uksm38sne0bqrj6uvkbo4oiu4hvigl.apps.googleusercontent.com</string>
    <string name="ga_trackingId" translatable="false">UA-65557217-3</string>
    <string name="firebase_database_url" translatable="false">https://example-url.firebaseio.com</string>
    <string name="google_api_key" translatable="false">AIzbSyCILMsOuUKwN3qhtxrPq7FFemDJUAXTyZ8</string>
    <string name="google_crash_reporting_api_key" translatable="false">AIzbSyCILMsOuUKwN3qhtxrPq7FFemDJUAXTyZ8</string>
    <string name="project_id" translatable="false">mydemoapp</string>

</resources>

app/build/generate/res/google-services/{flavor}/{build_type}/xml/global_tracker.xml

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <string name="ga_trackingId" translatable="false">UA-65557218-3</string>
</resources>

Każda wartość w plikach XML znajduje się w pliku google-services.json w poniższych lokalizacjach. Jeśli Twój projekt na Androida ma konfigurację, która uniemożliwia korzystanie z wtyczki google-services, możesz bezpiecznie odtworzyć pliki XML ręcznie, używając tych wartości:

google_app_id:

{YOUR_CLIENT}/client_info/mobilesdk_app_id

gcm_defaultSenderId:

project_info/project_number

default_web_client_id:

{YOUR_CLIENT}/oauth_client/client_id (client_type == 3)

ga_trackingId:

{YOUR_CLIENT}/services/analytics-service/analytics_property/tracking_id

firebase_database_url:

project_info/firebase_url

google_api_key:

{YOUR_CLIENT}/api_key/current_key

google_crash_reporting_api_key:

{YOUR_CLIENT}/api_key/current_key

project_id:

project_info/project_id

Rozwiązywanie problemów

P: Podczas tworzenia pliku pojawia się następujący komunikat o błędzie: „Plik: plik google-services.json” nie znajduje się w folderze głównym. Bez tej wtyczki wtyczka Usługi Google nie będzie działać”.

Odp.: Konsola Firebase pomoże Ci pobrać google-services.json. Ponadto krótkie przewodniki dotyczące większości interfejsów API zawierają instrukcje dotyczące generowania tego pliku. Po pobraniu pliku google-services.json skopiuj go do folderu app/ projektu Android Studio lub do folderu app/src/{build_type}, jeśli używasz wielu typów kompilacji.

P: Nie mogę znaleźć symbolu „R.string.gcm_defaultSenderId”, „R.xml.global_tracker” itp.

O: Upewnij się, że nazwa pakietu w pliku build.gradle jest zgodna z nazwą pakietu podaną podczas tworzenia pliku google-services.json. Jeśli nie masz pewności, ponownie uruchom proces rozpoczynania i pobierz nowy plik json.