Добавьте 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 для подключения к нему. Подробнее о проектах Firebase можно узнать в разделе «Понимание проектов Firebase».

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

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

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

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

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

   Что такое имя пакета и где его можно найти?

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

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

   • Найдите имя пакета вашего приложения в файле 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 вашего приложения ( google-services.json ) в вашу кодовую базу:

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

   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.3" 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.3' 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:34.0.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.

   Analytics не включена

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

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

   Возникает ошибка сборки при использовании поддержки invoke-custom и включении десахаринга? Вот как это исправить.

   Сборки Gradle, использующие плагин Android Gradle (AGP) версии 4.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 Assistant: Инструменты > Firebase .

3. На панели «Помощник» выберите продукт Firebase для добавления в приложение. Разверните его раздел и нажмите на ссылку с руководством (например, 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 | Java )

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

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

^{1 Firebase AI Logic ранее назывался « Vertex AI in Firebase » с пакетом com.google.firebase:firebase-vertexai .}

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

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

• Создавайте генеративные функции ИИ с помощью моделей Gemini и Imagen , используя Firebase AI Logic .

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

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

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

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

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

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

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

Узнайте о Firebase:

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

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

• Изучите примеры приложений Firebase .

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

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

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

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

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