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

Предпосылки

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

• Убедитесь, что ваш проект соответствует следующим требованиям:

  • Ориентирован на уровень API 19 (KitKat) или выше.
  • Использует Android 4.4 или выше
  • Использует Jetpack (AndroidX) , который включает в себя выполнение следующих требований к версии:
    • com.android.tools.build:gradle v3.2.1 или новее
    • 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-приложению. Посетите страницу Understand Firebase Projects , чтобы узнать больше о проектах 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 (при использовании входа через Google или номера телефона ) и динамических ссылок Firebase .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

   Аналитика включена

   Kotlin+KTX

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

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation platform('com.google.firebase:firebase-bom:32.1.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:32.1.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. В противном случае эти проекты Android получат ошибку сборки при добавлении Firebase SDK.

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

   • Добавьте перечисленные compileOptions из сообщения об ошибке в файл build.gradle уровня приложения .
   • Увеличьте minSdkVersion для вашего проекта 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. На панели Assistant выберите продукт Firebase, который нужно добавить в приложение. Разверните его раздел, затем щелкните ссылку на руководство (например, Analytics > Зарегистрировать событие Analytics ).

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

• Храните файлы, например фотографии и видео, в облачном хранилище .

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

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

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

Узнайте о Firebase:

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

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

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

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

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

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

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

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