Dodaj Firebase do swojego projektu na Androida

Wymagania wstępne

• Zainstaluj lub zaktualizuj Android Studio do najnowszej wersji.

• Upewnij się, że Twój projekt spełnia te wymagania:

  • Celuje w interfejs API poziomu 19 (KitKat) lub wyższy
  • Używa Androida 4.4 lub nowszego
  • Używa Jetpack (AndroidX) , co obejmuje spełnienie następujących wymagań dotyczących wersji:
    • com.android.tools.build:gradle w wersji 3.2.1 lub nowszej
    • compileSdkVersion 28 lub nowszy

• Skonfiguruj urządzenie fizyczne lub użyj emulatora , aby uruchomić aplikację.
  Pamiętaj, że zestawy SDK Firebase zależne od usług Google Play wymagają, aby urządzenie lub emulator miały zainstalowane usługi Google Play.

• Zaloguj się do Firebase przy użyciu swojego konta Google.

Jeśli nie masz jeszcze projektu na Androida i chcesz tylko wypróbować produkt Firebase, możesz pobrać jedną z naszych szybkich próbek .

Możesz połączyć swoją aplikację na Androida z Firebase, korzystając z jednej z następujących opcji:

• Opcja 1 : (zalecane) Skorzystaj z procedury konfiguracji konsoli Firebase.
• Opcja 2 : użyj Asystenta Firebase Android Studio (może wymagać dodatkowej konfiguracji).

Opcja 1 : Dodaj Firebase za pomocą konsoli Firebase

Dodanie Firebase do aplikacji obejmuje zadania zarówno w konsoli Firebase , jak i w otwartym projekcie na Androida (na przykład pobierasz pliki konfiguracyjne Firebase z konsoli, a następnie przenosisz je do swojego projektu na Androida).

Krok 1 : Utwórz projekt Firebase

Zanim dodasz Firebase do swojej aplikacji na Androida, musisz utworzyć projekt Firebase, aby połączyć się z aplikacją na Androida. Odwiedź stronę Projekty Firebase , aby dowiedzieć się więcej o projektach Firebase.

Krok 2 : Zarejestruj swoją aplikację w Firebase

Aby korzystać z Firebase w aplikacji na Androida, musisz zarejestrować swoją aplikację w projekcie Firebase. Rejestracja aplikacji jest często nazywana „dodawaniem” aplikacji do projektu.

1. Przejdź do konsoli Firebase .

2. Na środku strony przeglądu projektu kliknij ikonę Androida ( plat_android ) lub Dodaj aplikację , aby uruchomić proces konfiguracji.

3. Wpisz nazwę pakietu swojej aplikacji w polu Nazwa pakietu Androida .

   Co to jest nazwa pakietu i gdzie ją znaleźć?

   • Nazwa pakietu jednoznacznie identyfikuje Twoją aplikację na urządzeniu i w Sklepie Google Play.

   • Nazwa pakietu jest często określana jako identyfikator aplikacji .

   • Znajdź nazwę pakietu swojej aplikacji w pliku Gradle modułu (na poziomie aplikacji), zwykle app/build.gradle (przykładowa nazwa pakietu: com.yourcompany.yourproject ).

   • Pamiętaj, że w nazwie pakietu rozróżniana jest wielkość liter i nie można jej zmienić w tej aplikacji Firebase na Androida po jej zarejestrowaniu w projekcie Firebase.

4. (Opcjonalnie) Wprowadź inne informacje o aplikacji: pseudonim aplikacji i certyfikat podpisywania debugowania SHA-1 .

   W jaki sposób pseudonim aplikacji i certyfikat podpisywania debugowania SHA-1 są używane w Firebase?

   • Pseudonim aplikacji : wewnętrzny, wygodny identyfikator widoczny tylko dla Ciebie w konsoli Firebase

   • Certyfikat podpisywania debugowania SHA-1 : hash SHA-1 jest wymagany przez uwierzytelnianie Firebase (podczas korzystania z logowania przez Google lub logowania za pomocą numeru telefonu ) i łączy dynamicznych Firebase .

5. Kliknij Zarejestruj aplikację .

Krok 3 : Dodaj plik konfiguracyjny Firebase

1. Pobierz, a następnie dodaj plik konfiguracyjny Firebase Android ( google-services.json ) do swojej aplikacji:

   1. Kliknij Pobierz google-services.json, aby uzyskać plik konfiguracyjny Firebase Android.

   2. Przenieś plik konfiguracyjny do katalogu głównego modułu (na poziomie aplikacji) swojej aplikacji.

   Co musisz wiedzieć o tym pliku konfiguracyjnym?

   • Plik konfiguracyjny Firebase zawiera unikalne, ale nietajne identyfikatory Twojego projektu. Aby dowiedzieć się więcej o tym pliku konfiguracyjnym, odwiedź stronę Zrozumienie projektów Firebase .

   • W dowolnym momencie możesz ponownie pobrać plik konfiguracyjny Firebase .

   • Upewnij się, że nazwa pliku konfiguracyjnego nie zawiera dodatkowych znaków, takich jak (2) .

2. Aby wartości w pliku konfiguracyjnym google-services.json były dostępne dla zestawów SDK Firebase, potrzebujesz wtyczki Google Services Gradle ( google-services ).

   1. W pliku Gradle na poziomie głównym (na poziomie projektu) ( <project>/build.gradle ) dodaj wtyczkę usług Google jako zależność buildscript:

      buildscript {
      
          repositories {
            // Make sure that you have the following two repositories
            google()  // Google's Maven repository
            mavenCentral()  // Maven Central repository
          }
      
          dependencies {
            ...
      
            // Add the dependency for the Google services Gradle plugin
            classpath 'com.google.gms:google-services:4.3.15'
          }
      }
      
      allprojects {
        ...
      
        repositories {
          // Make sure that you have the following two repositories
          google()  // Google's Maven repository
          mavenCentral()  // Maven Central repository
        }
      }
      

   2. W pliku Gradle modułu (na poziomie aplikacji) (zwykle <project>/<app-module>/build.gradle ) dodaj wtyczkę usług Google:

      plugins {
          id 'com.android.application'
      
          // Add the Google services Gradle plugin
          id 'com.google.gms.google-services'
          ...
      }
      

Krok 4 : dodaj zestawy SDK Firebase do swojej aplikacji

1. W pliku Gradle modułu (na poziomie aplikacji) (zwykle <project>/<app-module>/build.gradle ) dodaj zależności dla produktów Firebase , których chcesz używać w swojej aplikacji. Zalecamy używanie Firebase Android BoM do kontrolowania wersji bibliotek.

   Analityka włączona

   Kotlin+KTX

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation platform('com.google.firebase:firebase-bom:31.2.0')
   
     // When using the BoM, you don't specify versions in Firebase library dependencies
   
     // Add the dependency for the Firebase SDK for Google Analytics
     implementation 'com.google.firebase:firebase-analytics-ktx'
   
     // TODO: Add the dependencies for any other Firebase products you want to use
     // See https://firebase.google.com/docs/android/setup#available-libraries
     // For example, add the dependencies for Firebase Authentication and Cloud Firestore
     implementation 'com.google.firebase:firebase-auth-ktx'
     implementation 'com.google.firebase:firebase-firestore-ktx'
   }
   

   Java

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation platform('com.google.firebase:firebase-bom:31.2.0')
   
     // When using the BoM, you don't specify versions in Firebase library dependencies
   
     // Add the dependency for the Firebase SDK for Google Analytics
     implementation 'com.google.firebase:firebase-analytics'
   
     // TODO: Add the dependencies for any other Firebase products you want to use
     // See https://firebase.google.com/docs/android/setup#available-libraries
     // For example, add the dependencies for Firebase Authentication and Cloud Firestore
     implementation 'com.google.firebase:firebase-auth'
     implementation 'com.google.firebase:firebase-firestore'
   }
   

   Korzystając z Firebase Android BoM , Twoja aplikacja będzie zawsze korzystać ze zgodnych wersji bibliotek Firebase Android.

   Analityka nie jest włączona

   Kotlin+KTX

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation platform('com.google.firebase:firebase-bom:31.2.0')
   
     // When using the BoM, you don't specify versions in Firebase library dependencies
   
     // TODO: Add the dependencies for Firebase products you want to use
     // See https://firebase.google.com/docs/android/setup#available-libraries
     // For example, add the dependencies for Firebase Authentication and Cloud Firestore
     implementation 'com.google.firebase:firebase-auth-ktx'
     implementation 'com.google.firebase:firebase-firestore-ktx'
   }
   

   Java

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation platform('com.google.firebase:firebase-bom:31.2.0')
   
     // When using the BoM, you don't specify versions in Firebase library dependencies
   
     // TODO: Add the dependencies for Firebase products you want to use
     // See https://firebase.google.com/docs/android/setup#available-libraries
     // For example, add the dependencies for Firebase Authentication and Cloud Firestore
     implementation 'com.google.firebase:firebase-auth'
     implementation 'com.google.firebase:firebase-firestore'
   }
   

   Korzystając z Firebase Android BoM , Twoja aplikacja będzie zawsze korzystać ze zgodnych wersji bibliotek Firebase Android.

2. Po dodaniu zależności dla produktów, których chcesz użyć, zsynchronizuj swój projekt Androida z plikami Gradle.

   Czy otrzymujesz błąd kompilacji dotyczący obsługi niestandardowego wywołania i włączenia odcukrzania? Oto jak to naprawić.

   Kompilacje Gradle korzystające z wtyczki Android Gradle (AGP) w wersji 4.2 lub starszej muszą włączyć obsługę języka Java 8. W przeciwnym razie te projekty na Androida dostaną błąd kompilacji podczas dodawania pakietu Firebase SDK.

   Aby naprawić ten błąd kompilacji, możesz skorzystać z jednej z dwóch opcji:

   • Dodaj wymienione compileOptions z komunikatu o błędzie do pliku build.gradle na poziomie aplikacji.
   • Zwiększ minSdkVersion dla swojego projektu Android do 26 lub więcej.

   Dowiedz się więcej o tym niepowodzeniu kompilacji w tym FAQ .

Otóż ​​to! Możesz przejść dalej, aby zapoznać się z zalecanymi następnymi krokami .

Jeśli jednak masz problemy z konfiguracją, odwiedź stronę Rozwiązywanie problemów z Androidem i często zadawane pytania .

Opcja 2 : Dodaj Firebase za pomocą Asystenta Firebase

Asystent Firebase rejestruje Twoją aplikację w projekcie Firebase i dodaje niezbędne pliki Firebase, wtyczki i zależności do Twojego projektu Android — wszystko z poziomu Android Studio!

1. Otwórz swój projekt na Androida w Android Studio, a następnie upewnij się, że używasz najnowszych wersji Android Studio i Asystenta Firebase:

   • Windows / Linux: Pomoc > Sprawdź dostępność aktualizacji
   • macOS: Android Studio > Sprawdź dostępność aktualizacji

2. Otwórz Asystenta Firebase: Narzędzia > Firebase .

3. W okienku Asystenta wybierz produkt Firebase, który chcesz dodać do swojej aplikacji. Rozwiń jego sekcję, a następnie kliknij link samouczka (na przykład Analytics > Rejestruj zdarzenie Analytics ).

   1. Kliknij Połącz z Firebase , aby połączyć projekt Androida z Firebase.

      Co robi ten przepływ pracy?

      • Ten przepływ pracy automatycznie tworzy nową aplikację Firebase na Androida przy użyciu nazwy pakietu Twojej aplikacji . Nową aplikację Firebase na Androida możesz utworzyć w istniejącym lub nowym projekcie Firebase.

        Oto kilka wskazówek dotyczących konfigurowania projektu Firebase:

        • Sprawdź nasze sprawdzone metody dodawania aplikacji do projektu Firebase, w tym sposoby obsługi wielu wariantów.

        • Jeśli tworzysz nowy projekt, zdecydowanie zalecamy skonfigurowanie Google Analytics dla swojego projektu, co zapewni Ci optymalne korzystanie z wielu produktów Firebase.

      • Ten przepływ pracy dodaje również plik konfiguracyjny Androida projektu Firebase ( google-services.json ) do katalogu modułu (na poziomie aplikacji) Twojej aplikacji.

   2. Kliknij przycisk, aby dodać żądany produkt Firebase (np. Dodaj Analytics do swojej aplikacji ).

4. Zsynchronizuj swoją aplikację, aby upewnić się, że wszystkie zależności mają niezbędne wersje.

5. W okienku Asystenta postępuj zgodnie z pozostałymi instrukcjami dotyczącymi konfiguracji wybranego produktu Firebase.

6. Dodaj dowolną liczbę innych produktów Firebase za pomocą Asystenta Firebase!

Otóż ​​to! Zapoznaj się z zalecanymi kolejnymi krokami .

Jeśli jednak masz problemy z konfiguracją, odwiedź stronę Rozwiązywanie problemów z Androidem i często zadawane pytania .

Dostępne biblioteki

Ta sekcja zawiera listę produktów Firebase obsługiwanych na Androida i ich zależności Gradle. Dowiedz się więcej o tych bibliotekach Firebase na Androida:

• Dokumentacja referencyjna ( Kotlin+KTX | Java )

• Firebase Android SDK repozytorium GitHub

Pamiętaj, że podczas korzystania z Firebase Android BoM , nie określasz poszczególnych wersji bibliotek podczas deklarowania zależności bibliotek Firebase w build.gradle .

Następne kroki

Dodaj usługi Firebase do swojej aplikacji:

• Uzyskaj wgląd w zachowania użytkowników dzięki Analytics .

• Skonfiguruj przepływ uwierzytelniania użytkownika za pomocą Authentication .

• Przechowuj dane, takie jak informacje o użytkownikach, za pomocą Cloud Firestore lub Realtime Database .

• Przechowuj pliki, takie jak zdjęcia i filmy, dzięki Cloud Storage .

• Wyzwalaj kod zaplecza, który działa w bezpiecznym środowisku dzięki Cloud Functions .

• Wysyłaj powiadomienia za pomocą Cloud Messaging .

• Dowiedz się, kiedy i dlaczego Twoja aplikacja ulega awarii dzięki Crashlytics .

Dowiedz się więcej o Firebase:

• Odwiedź stronę Projekty Firebase , aby dowiedzieć się więcej o projektach Firebase i sprawdzonych metodach dotyczących projektów.

• Odwiedź stronę Dowiedz się więcej o Androidzie i Firebase , jeśli masz pytania dotyczące nieznanych lub specyficznych pojęć związanych z programowaniem Firebase i Androida.

• Poznaj przykładowe aplikacje Firebase .

• Zdobądź praktyczne doświadczenie z Firebase Android Codelab .

• Dowiedz się więcej o Firebase podczas kursu weekendowego .

• Przygotuj się do uruchomienia aplikacji:

  • Skonfiguruj alerty budżetowe dla swojego projektu w Google Cloud Console.
  • Monitoruj pulpit nawigacyjny Wykorzystanie i rozliczenia w konsoli Firebase, aby uzyskać ogólny obraz wykorzystania projektu w wielu usługach Firebase.
  • Przejrzyj listę kontrolną uruchamiania Firebase .

• Masz problem z Firebase i swoim projektem na Androida? Odwiedź rozwiązywanie problemów z Androidem i często zadawane pytania .