Понимание проектов Firebase

На этой странице представлен краткий обзор нескольких важных концепций, касающихся проектов Firebase. При наличии ссылок вы можете найти более подробную информацию о функциях, сервисах, инструментах и ​​передовых методах.

Взаимосвязь между проектами, приложениями и продуктами Firebase.

Проект Firebase — это сущность верхнего уровня для Firebase. В проекте вы можете зарегистрировать свои приложения для Apple, Android или веб-приложения. После регистрации приложений в Firebase вы можете добавить SDK Firebase для любого количества продуктов Firebase , таких как Analytics , Cloud Firestore , Performance Monitoring или Remote Config .

Более подробную информацию об этом процессе вы найдете в руководстве по началу работы для вашей платформы:
iOS+ | Android | web | Unity | C++ | Flutter .

Понимание иерархии проектов Firebase

На этой диаграмме показана базовая иерархия проекта Firebase. Вот основные взаимосвязи:

• Проект Firebase — это своего рода контейнер для всех ваших приложений, а также любых ресурсов и сервисов, выделенных для проекта.

• К проекту Firebase может быть зарегистрировано одно или несколько приложений Firebase (например, версии приложения для iOS и Android, или бесплатная и платная версии).

• Все приложения Firebase, зарегистрированные в одном проекте Firebase , совместно используют одни и те же ресурсы и сервисы, выделенные для проекта . Вот несколько примеров:

  • Все приложения Firebase, зарегистрированные в одном проекте Firebase, используют одни и те же бэкэнды, такие как Firebase Hosting , Authentication , Realtime Database , Cloud Firestore , Cloud Storage и Cloud Functions .

  • Все приложения Firebase, зарегистрированные в одном проекте Firebase, связаны с одним и тем же ресурсом Google Analytics, при этом каждое приложение Firebase представляет собой отдельный поток данных в этом ресурсе.

Взаимосвязь между проектами Firebase и Google Cloud

При создании нового проекта Firebase вы фактически создаете проект Google Cloud . Вы даже можете сначала создать проект Google Cloud , а затем добавить Firebase в этот проект. Проект Google Cloud можно рассматривать как виртуальный контейнер для данных, кода, конфигурации и сервисов.

Ключевой момент: проект Firebase — это, по сути, просто проект Google Cloud , для которого включены дополнительные конфигурации и сервисы , специфичные для Firebase .

Обратите внимание, что для всех проектов Firebase в консоли Google Cloud на странице «Метки» автоматически добавляется метка firebase:enabled . Подробнее об этой метке можно узнать в разделе часто задаваемых вопросов (FAQ) .

Поскольку проект Firebase — это проект Google Cloud :

• Вы можете получить доступ к проекту и взаимодействовать с ним в консоли Firebase , а также в консоли Google Cloud и консоли Google API .

• Взаимодействовать с проектом можно с помощью Firebase CLI , gcloud CLI и любых ресурсов Terraform от Google.

• В проекте можно использовать продукты и API как Firebase, так и Google Cloud .

• Права доступа и роли IAM для проекта используются совместно Firebase и Google Cloud . Любой доступ, который участник проекта (то есть субъект) имеет к вашему проекту Google Cloud также будет применяться к вашему проекту Firebase (и наоборот).

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

• Уникальные идентификаторы проекта (такие как номер проекта и идентификатор проекта ) используются совместно Firebase и Google Cloud .

• Любая иерархия ресурсов , применяемая к вашему проекту Google Cloud (например, организация, папки и т. д.), также будет применяться к вашему проекту Firebase.

• Удаление проекта приведет к его удалению во всех средах Firebase и Google Cloud .

• Удаление или изменение ресурсов или данных в рамках проекта применимо как к Firebase, так и Google Cloud .

Настройка проекта Firebase и регистрация приложений

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

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

Взаимодействие с проектом Firebase

Помимо SDK продукта, вы можете напрямую взаимодействовать с проектом Firebase, используя несколько различных инструментов и интерфейсов.

Консоль Firebase

Консоль Firebase предоставляет наиболее широкие возможности для управления продуктами Firebase, приложениями и настройками на уровне проектов.

В левой панели консоли отображается список продуктов Firebase, отсортированных по категориям верхнего уровня. В верхней части левой панели можно получить доступ к настройкам проекта, нажав . Настройки проекта включают интеграции , права доступа и выставление счетов .

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

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

Firebase CLI (инструмент командной строки)

Firebase также предлагает Firebase CLI для настройки и управления отдельными продуктами Firebase, такими как Firebase Hosting , Cloud Functions for Firebase и Firebase Extensions .

После установки CLI вы получаете доступ к глобальной команде firebase . Используйте CLI для привязки локального каталога вашего приложения к проекту Firebase , а затем развертывайте новые версии контента, размещенного в Firebase, или обновления функций.

Firebase Management REST API

Используя REST API управления Firebase , вы можете программно управлять проектом Firebase. Например, вы можете программно зарегистрировать приложение в проекте или вывести список уже зарегистрированных приложений ( iOS+ | Android | web ).

Идентификаторы проектов Firebase

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

Ключевой момент: номер проекта и идентификатор проекта являются действительно уникальными идентификаторами проекта во всех средах Firebase и Google Cloud .

Название проекта

При создании проекта вы указываете его имя . Этот идентификатор является внутренним именем проекта в консоли Firebase , консоли Google Cloud и Firebase CLI . Имя проекта не отображается ни в одном общедоступном продукте, сервисе или ресурсе Firebase или Google Cloud ; оно просто помогает вам легче различать несколько проектов.

Вы можете изменить название проекта в любое время в проекта в консоли Firebase . Название проекта отображается в верхней панели.

Номер проекта

Проект Firebase (и связанный с ним проект Google Cloud ) имеет номер проекта . Это присвоенный Google глобально уникальный канонический идентификатор проекта. Используйте этот идентификатор при настройке интеграций и/или выполнении вызовов API к Firebase, Google или сторонним сервисам.

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

Найдите номер проекта

Найдите номер проекта вашего Firebase, используя один из следующих способов:

• В консоли Firebase : нажмите «Настройки проекта» . Номер проекта отображается в верхней панели.

• При использовании Firebase CLI выполните команду firebase projects:list . Отобразится номер проекта, а также все проекты Firebase, связанные с вашей учетной записью.

• При использовании REST API Firebase Management : вызовите projects.list . Тело ответа будет содержать номер проекта из объекта FirebaseProject .

Вызовы API и номер проекта

Для многих вызовов API необходимо указывать уникальный идентификатор проекта. Хотя многие API принимают идентификатор проекта , рекомендуется использовать номер проекта для вызовов API к Firebase, Google или сторонним сервисам.

Подробнее об использовании идентификаторов проектов, особенно номера проекта, можно узнать в стандарте Google AIP 2510 .

Идентификатор проекта

Проект Firebase (и связанный с ним проект Google Cloud ) имеет идентификатор проекта . Это определяемый пользователем уникальный идентификатор проекта во всех средах Firebase и Google Cloud . При создании проекта Firebase автоматически присваивает ему уникальный идентификатор, но вы можете изменить его во время настройки проекта. Этот идентификатор, как правило, следует рассматривать как удобный псевдоним для ссылки на проект.

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

Найдите идентификатор проекта.

Найдите идентификатор проекта вашего Firebase, используя один из следующих способов:

• В консоли Firebase : нажмите «Настройки проекта» . Идентификатор проекта отображается в верхней панели.

• При использовании Firebase CLI выполните команду firebase projects:list . Отобразится идентификатор проекта, а также все проекты Firebase, связанные с вашей учетной записью.

• При использовании REST API Firebase Management : вызовите projects.list . Тело ответа будет содержать идентификатор проекта из объекта FirebaseProject .

Ресурсы Firebase и идентификатор проекта.

Идентификатор проекта отображается в общедоступных ресурсах Firebase, например:

• Поддомены Hosting по умолчанию — PROJECT_ID .web.app и PROJECT_ID .firebaseapp.com
• URL-адрес Realtime Database по умолчанию — PROJECT_ID -default-rtdb.firebaseio.com или PROJECT_ID -default-rtdb. REGION_CODE .firebasedatabase.app
• Имя сегмента Cloud Storage по умолчанию — PROJECT_ID .appspot.com

Для всех вышеперечисленных ресурсов можно создавать нестандартные экземпляры. Общедоступные имена нестандартных экземпляров полностью настраиваются. Вы можете подключать пользовательские домены к сайту, размещенному на Firebase, сегментировать Realtime Database и создавать несколько сегментов Cloud Storage (перейдите на страницу «Начало работы» для конкретной платформы).

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

Интерфейс командной строки Firebase и идентификатор проекта.

В некоторых случаях у вас может быть несколько проектов Firebase, связанных с одним и тем же локальным каталогом приложения. В таких ситуациях при использовании Firebase CLI вам необходимо передавать флаг --project вместе с командами firebase , чтобы указать, с каким проектом Firebase вы хотите взаимодействовать.

Вы также можете настроить псевдоним проекта для каждого проекта Firebase, чтобы вам не приходилось запоминать идентификаторы проектов.

Вызовы API и идентификатор проекта

Для многих вызовов API необходимо указывать уникальный идентификатор проекта. Хотя многие API принимают идентификатор проекта, рекомендуется использовать номер проекта для вызовов API к Firebase, Google или сторонним сервисам.

Подробнее об использовании идентификаторов проектов, особенно номера проекта, можно узнать в стандарте Google AIP 2510 .

Конфигурационные файлы и объекты Firebase

При регистрации приложения в проекте Firebase консоль Firebase предоставляет файл конфигурации Firebase (для приложений Apple/Android) или объект конфигурации (для веб-приложений), который вы добавляете непосредственно в локальный каталог вашего приложения.

• Для приложений Apple необходимо добавить конфигурационный файл GoogleService-Info.plist .
• Для приложений Android необходимо добавить конфигурационный файл google-services.json .
• Для веб-приложений необходимо добавить объект конфигурации Firebase.

В любой момент вы можете получить доступ к файлу конфигурации Firebase или его объекту .

Примечание: Для приложений Flutter у вас есть возможность использовать кроссплатформенный файл конфигурации Firebase под названием firebase_options.dart .
Если ваши Flutter-приложения используют этот файл, вы можете поддерживать его в актуальном состоянии, запустив flutterfire configure из каталога вашего Flutter-проекта.

Текущие значения конфигурации, которые Firebase использует для ваших зарегистрированных в Firebase приложений Flutter, можно получить, выполнив flutterfire configure --out=my_options.dart .

Конфигурационный файл или объект Firebase связывает приложение с конкретным проектом Firebase и его ресурсами (базами данных, хранилищами и т. д.). Конфигурация включает в себя «параметры Firebase», которые являются параметрами, необходимыми для взаимодействия Firebase и сервисов Google с API сервера Firebase и для связывания данных клиента с проектом Firebase и приложением Firebase. Вот минимальный необходимый набор «параметров Firebase»:

• Ключ API : простая зашифрованная строка, используемая при вызове определенных API, которым не требуется доступ к личным данным пользователя (пример значения: AIzaSyDOCAbC123dEf456GhI789jKl012-MnO ).

• Идентификатор проекта : определяемый пользователем уникальный идентификатор проекта во всех средах Firebase и Google Cloud . Этот идентификатор может отображаться в URL-адресах или именах некоторых ресурсов Firebase, но, как правило, его следует рассматривать как удобный псевдоним для ссылки на проект. (пример значения: myapp-project-123 )

• Идентификатор приложения ("AppID") : уникальный идентификатор приложения Firebase во всей системе Firebase, имеющий формат, специфичный для платформы:

  • Firebase Apple apps: GOOGLE_APP_ID (пример значения: 1:1234567890:ios:321abc456def7890 )
    Это не идентификатор пакета Apple.
  • Приложения Firebase для Android: mobilesdk_app_id (пример значения: 1:1234567890:android:321abc456def7890 )
    Это не имя пакета Android и не идентификатор приложения Android.
  • Firebase Web apps: appId (пример значения: 1:65211879909:web:3ae38ef1cdcb2e01fe5f0c )

Внимание: Мы не рекомендуем вручную изменять файл конфигурации Firebase или объект Firebase приложения. Если вы инициализируете приложение с недопустимыми или отсутствующими значениями для каких-либо из этих обязательных параметров Firebase, ваши конечные пользователи могут столкнуться с серьезными проблемами.

Содержимое файла конфигурации Firebase или объекта конфигурации считается общедоступным, включая идентификатор приложения, специфичный для платформы (идентификатор пакета Apple или имя пакета Android), и значения, специфичные для проекта Firebase, такие как ключ API, идентификатор проекта, URL-адрес Realtime Database и имя сегмента Cloud Storage . Учитывая это, используйте Firebase Security Rules для защиты ваших данных и файлов в Realtime Database , Cloud Firestore и Cloud Storage .

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

Общие ограничения для проектов, приложений и сайтов Firebase.

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

Вот некоторые общие ограничения для проектов, приложений и сайтов Firebase:

• Количество проектов на один аккаунт Google (адрес электронной почты)

  • Тарифный план Spark : квота на создание проектов ограничена небольшим количеством проектов (обычно около 5-10).
  • Тарифный план Blaze : Квота на создание проектов по-прежнему ограничена, но может быть увеличена при подключении действующей учетной записи Cloud Billing .

  Обратите внимание на следующее ограничение по квоте на создание проектов:

  • Это ограничение не является специфическим для Firebase. Ограничения Firebase на проектные квоты такие же, как и в Google Cloud .
  • В редких случаях, когда это необходимо, вы можете запросить увеличение квоты по проекту .
  • Полное удаление проекта занимает 30 дней и учитывается в рамках проектной квоты до тех пор, пока проект не будет полностью удален.

  Узнайте о рекомендуемых Firebase общих принципах настройки проектов Firebase .

• Количество приложений на проект

  Firebase ограничивает общее количество приложений Firebase в проекте Firebase до 30.

  Необходимо убедиться, что все приложения Firebase в рамках одного проекта Firebase являются вариантами одного и того же приложения с точки зрения конечного пользователя. Подробнее о многопользовательском режиме читайте в наших документах с рекомендациями.

  Подробнее об ограничении на количество приложений в одном проекте можно узнать в разделе часто задаваемых вопросов (FAQ).

• Количество Hosting сайтов на проект

  Функция мультисайтовой Firebase Hosting поддерживает максимум 36 сайтов на проект.

Запуск вашего приложения

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