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

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

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

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

    • Целевой уровень API 19 (KitKat) или выше.
    • Использует Android 4.4 или выше.
    • Использует 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 ( ) или «Добавить приложение» , чтобы запустить рабочий процесс установки.

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

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

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

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

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

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

    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.0" 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.0' 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 для управления версиями библиотеки.

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

    dependencies {
      // ...
    
      // Import the Firebase BoM
      implementation(platform("com.google.firebase:firebase-bom:32.6.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 по этой инициативе ).

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

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

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

Если у вас возникли проблемы с настройкой, посетите раздел «Устранение неполадок и часто задаваемые вопросы 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» ).

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

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

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

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

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

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

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



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

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

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

Услуга или продукт Зависимость Gradle Последний
версия
Добавить аналитику?
Firebase Android BoM
(Спецификация материалов)
com.google.firebase:firebase-bom

Последняя версия Firebase BoM содержит последние версии каждой библиотеки Firebase Android. Чтобы узнать, какие версии библиотек сопоставлены с конкретной версией спецификации, просмотрите примечания к выпуску для этой версии спецификации.

32.6.0
Реклама в приложении com.google.android.gms:play-services-ads 22.5.0
Аналитика com.google.firebase:firebase-analytics 21.5.0
Пользовательский поставщик проверки приложений com.google.firebase:firebase-appcheck 17.1.1
Поставщик отладки проверки приложений com.google.firebase:firebase-appcheck-debug 17.1.1
Проверка приложения Поставщик целостности Play com.google.firebase:firebase-appcheck-playintegrity 17.1.1
Распространение приложений com.google.firebase:firebase-appdistribution 16.0.0-бета11
API распространения приложений com.google.firebase:firebase-appdistribution-api 16.0.0-бета11
Плагин распространения приложений com.google.firebase:firebase-appdistribution-gradle 4.0.1
Аутентификация com.google.firebase:firebase-аутентификация 22.3.0
Облачный пожарный магазин com.google.firebase:firebase-firestore 24.9.1
Облачные функции для клиентского SDK Firebase com.google.firebase:firebase-функции 20.4.0
Облачный обмен сообщениями com.google.firebase:firebase-messaging 23.3.1
Облачное хранилище com.google.firebase:firebase-хранилище 20.3.0
Крашлитикс com.google.firebase:firebase-crashlytics 18.6.0
Крашлитикс НДК com.google.firebase:firebase-crashlytics-ndk 18.6.0
Плагин Crashlytics com.google.firebase:firebase-crashlytics-gradle 2.9.9
Поддержка динамических функциональных модулей com.google.firebase:firebase-динамический-модуль-поддержка 16.0.0-бета03
Динамические ссылки com.google.firebase:firebase-dynamic-links 21.2.0
Обмен сообщениями в приложении com.google.firebase:firebase-inappmessaging 20.4.0
(необходимый)
Отображение сообщений в приложении com.google.firebase:firebase-inappmessaging-display 20.4.0
(необходимый)
Установки Firebase com.google.firebase:firebase-установки 17.2.0
API загрузки моделей Firebase ML com.google.firebase:firebase-ml-modeldownloader 24.2.1
Мониторинг производительности com.google.firebase:firebase-perf 20.5.1
Плагин мониторинга производительности com.google.firebase:perf-плагин 1.4.2
База данных реального времени com.google.firebase:firebase-база данных 20.3.0
Удаленная настройка com.google.firebase:firebase-config 21.6.0
Плагин сервисов Google Play com.google.gms:google-services 4.4.0
УСТАРЕВШИЕ БИБЛИОТЕКИ
Проверка приложения Поставщик SafetyNet com.google.firebase:firebase-appcheck-safetynet 16.1.2
Индексирование приложений com.google.firebase:firebase-appindexing 20.0.0

Модули Firebase KTX

Аналитика com.google.firebase:firebase-analytics-ktx 21.5.0
Пользовательский поставщик проверки приложений com.google.firebase:firebase-appcheck-ktx 17.1.1
API распространения приложений com.google.firebase:firebase-appdistribution-api-ktx 16.0.0-бета11
Аутентификация com.google.firebase:firebase-auth-ktx 22.3.0
Облачный пожарный магазин com.google.firebase:firebase-firestore-ktx 24.9.1
Облачные функции для клиентского SDK Firebase com.google.firebase:firebase-functions-ktx 20.4.0
Облачный обмен сообщениями com.google.firebase:firebase-messaging-ktx 23.3.1
Облачное хранилище com.google.firebase:firebase-storage-ktx 20.3.0
Крашлитикс com.google.firebase:firebase-crashlytics-ktx 18.6.0
Динамические ссылки com.google.firebase:firebase-dynamic-links-ktx 21.2.0
Обмен сообщениями в приложении com.google.firebase:firebase-inappmessaging-ktx 20.4.0
(необходимый)
Отображение сообщений в приложении com.google.firebase:firebase-inappmessaging-display-ktx 20.4.0
(необходимый)
Установки Firebase com.google.firebase:firebase-installations-ktx 17.2.0
API загрузки моделей Firebase ML com.google.firebase:firebase-ml-modeldownloader-ktx 24.2.1
Мониторинг производительности com.google.firebase:firebase-perf-ktx 20.5.1
База данных реального времени com.google.firebase:firebase-database-ktx 20.3.0
Удаленная настройка com.google.firebase:firebase-config-ktx 21.6.0

Библиотеки Firebase ML Kit

API пользовательских моделей Firebase ML com.google.firebase:firebase-ml-модель-интерпретатор 22.0.4
API-интерфейсы Firebase ML Vision com.google.firebase:firebase-ml-vision 24.1.0
Firebase ML: модель маркировки изображений com.google.firebase:firebase-ml-vision-image-label-model 20.0.2
Firebase ML: модель обнаружения и отслеживания объектов com.google.firebase:firebase-ml-vision-object-detection-model 19.0.6
Firebase ML: модель распознавания лиц com.google.firebase:firebase-ml-vision-face-model 20.0.2
Firebase ML: модель сканирования штрих-кода com.google.firebase:firebase-ml-vision-barcode-model 16.1.2
Firebase ML: API AutoML Vision Edge com.google.firebase:firebase-ml-vision-automl 18.0.6
Firebase ML: API естественного языка com.google.firebase:firebase-ml-естественный-язык 22.0.1
Firebase ML: модель идентификации языка com.google.firebase:firebase-ml-natural-language-language-id-model 20.0.8
Firebase ML: перевести модель com.google.firebase:firebase-ml-natural-language-translate-model 20.0.9
Firebase ML: модель умного ответа com.google.firebase:firebase-ml-natural-language-smart-reply-model 20.0.8



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

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

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

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

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

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

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

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

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

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