Wstęp
Podczas włączania interfejsów API Google lub usług Firebase w aplikacji na Androida może być konieczne dodanie wtyczki google-services
do pliku build.gradle
:
dependencies {
classpath 'com.google.gms:google-services:4.4.0'
// ...
}
Wtyczka google-services
ma 2 główne funkcje:
- Przetwórz plik
google-services.json
i utwórz zasoby Androida, które można wykorzystać w kodzie aplikacji. Więcej informacji znajdziesz w sekcji Dodawanie pliku JSON. Dodaj zależności podstawowych bibliotek wymaganych przez włączone usługi. Ten krok wymaga zastosowania wtyczki usług Google do Gradle w pliku
app/build.gradle
w następujący sposób:
apply plugin: 'com.google.gms.google-services'
Efekt tego kroku możesz sprawdzić, uruchamiając polecenie
./gradlew :app:dependencies
.
Dodawanie pliku JSON
Plik google-services.json
zazwyczaj znajduje się w katalogu app/
(w katalogu głównym modułu aplikacji w Android Studio). Od wersji 2.2.0
wtyczka obsługuje pliki JSON związane z typem kompilacji i smakiem produktu. Wszystkie poniższe 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: umieszczenie pliku google-services.json w katalogu wersji umożliwia utrzymanie osobnego projektu Firebase dla produkcyjnych pakietów APK.
W przypadku stosowania smaków produktów obowiązują też 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 projekcie, a 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 (w przypadku bieżącego typu kompilacji) zgodnie z tą logiką:
- Dla każdego elementu tablicy
client
:- Sprawdź wartość
client_info/android_client_info/package_name
- Jeśli nazwa pakietu pasuje do tej wartości, zwróć obiekt członkowski.
- Sprawdź wartość
- Jeśli żaden z członków grupy
client
nie pasuje do nazwy pakietu, zgłaszany jest wyjątek.
W pozostałej części tego dokumentu będziemy używać funkcji {YOUR_CLIENT}
odwoływania się do tablicy client
określonej w powyższej procedurze.
Głównym wynikiem przetwarzania JSON jest utworzenie 2 plików XML, do których można się odwoływać w kodzie Javy jako zasoby Androida. Oto przykład każdego pliku:
app/build/generated/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/generated/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>
Wszystkie wartości z plików XML znajdują się w pliku google-services.json
w poniższych lokalizacjach. Jeśli w Twoim projekcie na Androida występują konfiguracje, które uniemożliwiają korzystanie z wtyczki google-services
, możesz ręcznie odtworzyć pliki XML, 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
Pyt.: Podczas tworzenia pojawia się komunikat o błędzie: „W głównym folderze modułu brakuje pliku google-services.json. Bez niej wtyczka usług Google nie będzie działać”.
Odp.: Konsola Firebase pomoże Ci pobrać google-services.json
.
Ponadto w krótkich przewodnikach dotyczących większości interfejsów API znajdują się instrukcje generowania tego pliku.
Po pobraniu pliku google-services.json
skopiuj go do folderu app/
projektu w Android Studio lub do folderu app/src/{build_type}
, jeśli używasz kilku typów kompilacji.
Pyt.: Nie mogę znaleźć symbolu „R.string.gcm_defaultSenderId”, „R.xml.global_tracker” itp.
O: Upewnij się, że nazwa pakietu w pliku build.gradle
jest taka sama jak nazwa pakietu wpisanego podczas tworzenia pliku google-services.json
. Jeśli nie masz pewności, powtórz procedurę dla początkujących i pobierz nowy plik json.