Добавьте Firebase в свой проект Android

Предварительные условия

• Установите или обновите Android Studio до последней версии.

• Убедитесь, что ваш проект соответствует этим требованиям (обратите внимание, что к некоторым продуктам могут предъявляться более строгие требования):

  • Целевой уровень API 21 (Lollipop) или выше.
  • Использует Android 5.0 или выше.
  • Использует Jetpack (AndroidX) , что включает в себя соблюдение следующих требований к версии:
    • com.android.tools.build:gradle v7.3.0 или новее
    • compileSdkVersion 28 или новее

• Настройте физическое устройство или используйте эмулятор для запуска приложения.
  Обратите внимание, что для Firebase SDK, зависящих от сервисов Google Play, на устройстве или эмуляторе должны быть установлены сервисы Google Play.

• Войдите в Firebase, используя свою учетную запись Google.

Если у вас еще нет проекта Android и вы просто хотите опробовать продукт Firebase, вы можете загрузить один из наших примеров быстрого запуска .

Вы можете подключить свое Android-приложение к Firebase, используя один из следующих вариантов:

• Вариант 1 : (рекомендуется) Используйте рабочий процесс настройки консоли Firebase .
• Вариант 2. Используйте Android Studio Firebase Assistant (может потребоваться дополнительная настройка).

Вариант 1. Добавьте Firebase с помощью консоли Firebase

Добавление Firebase в ваше приложение включает в себя задачи как в консоли Firebase , так и в вашем открытом проекте Android (например, вы загружаете файлы конфигурации Firebase из консоли, а затем перемещаете их в свой проект Android).

Шаг 1. Создайте проект Firebase.

Прежде чем вы сможете добавить Firebase в свое приложение Android, вам необходимо создать проект Firebase для подключения к вашему приложению Android. Посетите раздел «Понимание проектов Firebase», чтобы узнать больше о проектах Firebase.

Шаг 2. Зарегистрируйте свое приложение в Firebase.

Чтобы использовать Firebase в своем приложении для Android, вам необходимо зарегистрировать свое приложение в проекте Firebase. Регистрация вашего приложения часто называется «добавлением» вашего приложения в проект.

1. Перейдите в консоль Firebase .

2. В центре страницы обзора проекта щелкните значок Android ( plat_android ) или «Добавить приложение» , чтобы запустить рабочий процесс установки.

3. Введите имя пакета вашего приложения в поле имени пакета Android .

   Как называется пакет и где его найти?

   • Имя пакета уникально идентифицирует ваше приложение на устройстве и в Google Play Store.

   • Имя пакета часто называют идентификатором приложения .

   • Найдите имя пакета вашего приложения в файле Gradle вашего модуля (на уровне приложения), обычно app/build.gradle (пример имени пакета: com.yourcompany.yourproject ).

   • Имейте в виду, что значение имени пакета чувствительно к регистру, и его нельзя изменить для этого приложения Firebase Android после его регистрации в вашем проекте Firebase.

4. (Необязательно) Введите другую информацию о приложении: псевдоним приложения и сертификат подписи отладки SHA-1 .

   Как псевдоним приложения и сертификат подписи отладки SHA-1 используются в Firebase?

   • Псевдоним приложения : внутренний удобный идентификатор, который виден только вам в консоли Firebase .

   • Сертификат подписи отладки SHA-1 : хэш SHA-1 требуется для Firebase Authentication (при использовании входа в Google или входа по номеру телефона ) и Firebase Dynamic Links .

5. Нажмите Зарегистрировать приложение .

Шаг 3. Добавьте файл конфигурации Firebase.

1. Загрузите и добавьте файл конфигурации Firebase Android ( google-services.json ) в свое приложение:

   1. Нажмите «Загрузить google-services.json» , чтобы получить файл конфигурации Firebase Android.

   2. Переместите файл конфигурации в корневой каталог модуля (на уровне приложения) вашего приложения.

   Что вам нужно знать об этом конфигурационном файле?

   • Файл конфигурации Firebase содержит уникальные, но несекретные идентификаторы вашего проекта. Чтобы узнать больше об этом файле конфигурации, посетите раздел «Понимание проектов Firebase» .

   • Вы можете снова загрузить файл конфигурации Firebase в любое время.

   • Убедитесь, что к имени файла конфигурации не добавлены дополнительные символы, например (2) .

2. Чтобы сделать значения в вашем файле конфигурации google-services.json доступными для Firebase SDK, вам понадобится плагин Gradle сервисов Google ( google-services ).

   1. В файле Gradle корневого уровня (уровня проекта) ( <project>/build.gradle.kts или <project>/build.gradle ) добавьте плагин служб Google в качестве зависимости:

      Kotlin

      plugins {
        id("com.android.application") version "7.3.0" apply false
        // ...
      
        // Add the dependency for the Google services Gradle plugin
        id("com.google.gms.google-services") version "4.4.2" apply false
      }

      Groovy

      plugins {
        id 'com.android.application' version '7.3.0' apply false
        // ...
      
        // Add the dependency for the Google services Gradle plugin
        id 'com.google.gms.google-services' version '4.4.2' apply false
      }

   2. В файле Gradle вашего модуля (на уровне приложения) (обычно <project>/<app-module>/build.gradle.kts или <project>/<app-module>/build.gradle ) добавьте плагин сервисов Google:

      Kotlin

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

      Groovy

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

Шаг 4. Добавьте Firebase SDK в свое приложение.

1. В файле Gradle вашего модуля (на уровне приложения) (обычно <project>/<app-module>/build.gradle.kts или <project>/<app-module>/build.gradle ) добавьте зависимости для продуктов Firebase . который вы хотите использовать в своем приложении. Мы рекомендуем использовать Firebase Android BoM для управления версиями библиотеки.

   Analytics включена

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation(platform("com.google.firebase:firebase-bom:33.4.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")
   }

   Используя Firebase Android BoM , ваше приложение всегда будет использовать совместимые версии библиотек Firebase Android.

   Ищете библиотечный модуль, специфичный для Kotlin? Начиная с октября 2023 года ( Firebase BoM 32.5.0) от основного модуля библиотеки могут зависеть как разработчики Kotlin, так и Java (подробнее см. FAQ по этой инициативе ).

   Analytics не включена

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation(platform("com.google.firebase:firebase-bom:33.4.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")
   }

   Используя Firebase Android BoM , ваше приложение всегда будет использовать совместимые версии библиотек Firebase Android.

   Ищете библиотечный модуль, специфичный для Kotlin? Начиная с октября 2023 года ( Firebase BoM 32.5.0) от основного модуля библиотеки могут зависеть как разработчики Kotlin, так и Java (подробнее см. FAQ по этой инициативе ).

2. После добавления зависимостей для продуктов, которые вы хотите использовать, синхронизируйте проект Android с файлами Gradle.

   Вы получаете ошибку сборки, связанную с поддержкой пользовательского вызова и включением обессеривания? Вот как это исправить.

   Сборки Gradle, использующие плагин Android Gradle (AGP) v4.2 или более ранней версии, должны включить поддержку Java 8. В противном случае при добавлении Firebase SDK в этих проектах Android произойдет сбой сборки.

   Чтобы исправить этот сбой сборки, вы можете воспользоваться одним из двух вариантов:

   • Добавьте перечисленные compileOptions из сообщения об ошибке в файл build.gradle.kts или build.gradle уровня приложения .
   • Увеличьте minSdk для вашего проекта Android до 26 или выше.

   Узнайте больше об этом сбое сборки в этом FAQ .

Вот и все! Вы можете пропустить этот шаг и ознакомиться с рекомендуемыми дальнейшими действиями .

Если у вас возникли проблемы с настройкой, посетите раздел «Устранение неполадок и часто задаваемые вопросы Android» .

Вариант 2. Добавьте Firebase с помощью Firebase Assistant.

Помощник Firebase регистрирует ваше приложение в проекте Firebase и добавляет необходимые файлы, плагины и зависимости Firebase в ваш проект Android — и все это из Android Studio!

1. Откройте свой проект Android в Android Studio, затем убедитесь, что вы используете последние версии Android Studio и Firebase Assistant:

   • Windows/Linux: Справка > Проверить наличие обновлений.
   • macOS: Android Studio > Проверить наличие обновлений

2. Откройте Помощник Firebase: Инструменты > Firebase .

3. На панели «Ассистент» выберите продукт Firebase, который хотите добавить в свое приложение. Разверните его раздел, затем нажмите ссылку на руководство (например, Analytics > Зарегистрировать событие Analytics ).

   1. Нажмите «Подключиться к Firebase» , чтобы подключить проект Android к Firebase.

      Что делает этот рабочий процесс?

      • Этот рабочий процесс автоматически создает новое приложение Firebase для Android, используя имя пакета вашего приложения. Вы можете создать это новое приложение Firebase для Android либо в существующем проекте Firebase, либо в новом проекте.

        Вот несколько советов по настройке проекта Firebase:

        • Ознакомьтесь с нашими рекомендациями по добавлению приложений в проект Firebase, в том числе о том, как обрабатывать несколько вариантов.

        • Если вы создаете новый проект, мы настоятельно рекомендуем вам настроить Google Analytics для вашего проекта, что позволит вам оптимально использовать многие продукты Firebase.

      • Этот рабочий процесс также добавляет файл конфигурации Android вашего проекта Firebase ( google-services.json ) в каталог модуля (на уровне приложения) вашего приложения.

   2. Нажмите кнопку, чтобы добавить нужный продукт Firebase (например, «Добавить Analytics в свое приложение »).

4. Синхронизируйте приложение, чтобы убедиться, что все зависимости имеют необходимые версии.

5. На панели «Ассистент» следуйте остальным инструкциям по настройке для выбранного вами продукта Firebase.

6. Добавьте столько других продуктов Firebase, сколько захотите, с помощью Firebase Assistant!

Вот и все! Обязательно ознакомьтесь с рекомендуемыми дальнейшими действиями .

Если у вас возникли проблемы с настройкой, посетите раздел «Устранение неполадок и часто задаваемые вопросы Android» .

Доступные библиотеки

В этом разделе перечислены продукты Firebase, поддерживаемые для Android, и их зависимости Gradle. Узнайте больше об этих библиотеках Firebase для Android:

• Справочная документация ( Kotlin+KTX | Java )

• Репозиторий Firebase Android SDK на GitHub

Обратите внимание: при использовании Firebase Android BoM вы не указываете отдельные версии библиотеки при объявлении зависимостей библиотеки Firebase в файле конфигурации сборки Gradle.

Следующие шаги

Добавьте сервисы Firebase в свое приложение:

• Получите представление о поведении пользователей с помощью Analytics .

• Настройте поток аутентификации пользователя с помощью Authentication .

• Храните данные, например информацию о пользователях, с помощью Cloud Firestore или Realtime Database .

• Храните файлы, например фотографии и видео, с помощью Cloud Storage .

• Запускайте серверный код триггера, который работает в безопасной среде с помощью Cloud Functions .

• Отправляйте уведомления с помощью Cloud Messaging .

• Узнайте, когда и почему ваше приложение выходит из строя, с помощью Crashlytics .

Узнайте больше о Firebase:

• Посетите раздел «Понимание проектов Firebase» , чтобы узнать больше о проектах Firebase и лучших практиках для проектов.

• Посетите раздел «Узнайте больше об Android и Firebase», если у вас есть вопросы о концепциях, которые незнакомы или специфичны для разработки Firebase и Android.

• Ознакомьтесь с примерами приложений Firebase .

• Получите практический опыт работы с Firebase Android Codelab .

• Узнайте больше с помощью курса Firebase на выходных .

• Подготовьтесь к запуску приложения:

  • Настройте оповещения о бюджете для своего проекта в консоли Google Cloud .
  • Отслеживайте панель «Использование и выставление счетов» в консоли Firebase , чтобы получить общую картину использования вашего проекта в нескольких сервисах Firebase.
  • Ознакомьтесь с контрольным списком запуска Firebase .

• Возникли проблемы с Firebase и вашим проектом Android? Посетите раздел «Устранение неполадок Android и часто задаваемые вопросы» .