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

Предпосылки

• Установите следующее:

  • Xcode 13.3.1 или новее

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

  • Ваш проект должен быть ориентирован на эти версии платформы или более поздние версии:
    • iOS 11
    • макОС 10.13
    • твОС 12
    • смотретьОС 6

• Настройте физическое устройство Apple или используйте симулятор для запуска своего приложения.

  Вы хотите использовать облачный обмен сообщениями?

  Предварительные требования для Cloud Messaging на платформах Apple:

  • Настройте физическое устройство Apple .
  • Получите ключ аутентификации Apple Push Notification для своей учетной записи Apple Developer .
  • Включите push-уведомления в Xcode в разделе « Приложение» > «Возможности» .

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

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

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

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

Создайте проект Firebase

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

   • Чтобы добавить ресурсы Firebase в существующий проект Google Cloud, введите имя проекта или выберите его в раскрывающемся меню.

   • Чтобы создать новый проект, введите желаемое имя проекта. Вы также можете дополнительно отредактировать идентификатор проекта, отображаемый под названием проекта.

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

2. При появлении запроса прочтите и примите условия Firebase .

3. Нажмите Продолжить .

4. (Необязательно) Настройте Google Analytics для своего проекта, что позволит вам оптимально использовать любой из следующих продуктов Firebase:

   Firebase Crashlytics Облачные сообщения Firebase

   Обмен сообщениями в приложении Firebase Удаленная конфигурация Firebase

   Персонализация удаленной конфигурации A/B-тестирование Firebase

   Либо выберите существующую учетную запись Google Analytics, либо создайте новую учетную запись.

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

   Вы всегда можете настроить Google Analytics позже на вкладке Интеграции в проекта .

5. Нажмите « Создать проект» (или « Добавить Firebase », если вы используете существующий проект Google Cloud).

Firebase автоматически выделяет ресурсы для вашего проекта Firebase. Когда процесс завершится, вы попадете на страницу обзора вашего проекта Firebase в консоли Firebase.

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

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

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

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

2. В центре страницы обзора проекта щелкните значок iOS+ , чтобы запустить рабочий процесс установки.

   Если вы уже добавили приложение в свой проект Firebase, нажмите « Добавить приложение », чтобы отобразить параметры платформы.

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

   Что такое идентификатор пакета и где его найти?

   • Идентификатор пакета однозначно идентифицирует приложение в экосистеме Apple.

   • Найдите свой идентификатор пакета: откройте свой проект в Xcode, выберите приложение верхнего уровня в навигаторе проекта, затем выберите вкладку « Общие ».

     Значением поля Bundle Identifier является идентификатор пакета (например, com.yourcompany.yourproject ).

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

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

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

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

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

   • Идентификатор App Store : используется Firebase Dynamic Links для перенаправления пользователей на вашу страницу в App Store и Google Analytics для импорта событий конверсии в Google Ads . Если у вашего приложения еще нет идентификатора App Store, вы можете добавить его позже в настройках проекта .

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

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

1. Нажмите «Загрузить GoogleService-Info.plist» , чтобы получить файл конфигурации Firebase для платформ Apple ( GoogleService-Info.plist ).

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

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

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

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

2. Переместите файл конфигурации в корень вашего проекта Xcode. При появлении запроса выберите, чтобы добавить файл конфигурации ко всем целям.

Если в вашем проекте есть несколько идентификаторов пакетов, вы должны связать каждый идентификатор пакета с зарегистрированным приложением в консоли Firebase, чтобы каждое приложение могло иметь свой собственный GoogleService-Info.plist .

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

Используйте Swift Package Manager для установки и управления зависимостями Firebase.

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

1. В Xcode при открытом проекте приложения перейдите в File > Add Packages .
2. При появлении запроса добавьте репозиторий SDK Firebase для платформ Apple:

  https://github.com/firebase/firebase-ios-sdk

3. Выберите версию SDK, которую вы хотите использовать.
   Примечание. Мы рекомендуем использовать стандартную (последнюю) версию SDK, но при необходимости вы можете выбрать более старую версию.

4. Выберите библиотеки Firebase, которые вы хотите использовать.

   Если в вашем проекте Firebase включен Google Analytics, обязательно добавьте FirebaseAnalytics . Для Analytics без возможности сбора IDFA вместо этого добавьте FirebaseAnalyticsWithoutAdId .

Когда закончите, Xcode автоматически начнет разрешать и загружать ваши зависимости в фоновом режиме.

Шаг 5. Инициализируйте Firebase в своем приложении.

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

1. Импортируйте модуль FirebaseCore в свой UIApplicationDelegate , а также любые другие модули Firebase, которые использует ваш делегат приложения. Например, чтобы использовать Cloud Firestore и аутентификацию:

   SwiftUI

   import SwiftUI
   import FirebaseCore
   import FirebaseFirestore
   import FirebaseAuth
   // ...
         

   Быстрый

   import FirebaseCore
   import FirebaseFirestore
   import FirebaseAuth
   // ...
         

   Цель-C

   @import FirebaseCore;
   @import FirebaseFirestore;
   @import FirebaseAuth;
   // ...
         

2. Настройте общий экземпляр FirebaseApp в методе application(_:didFinishLaunchingWithOptions:) вашего делегата приложения:

   SwiftUI

   // Use Firebase library to configure APIs
   FirebaseApp.configure()

   Быстрый

   // Use Firebase library to configure APIs
   FirebaseApp.configure()

   Цель-C

   // Use Firebase library to configure APIs
   [FIRApp configure];

3. Если вы используете SwiftUI, вы должны создать делегат приложения и прикрепить его к своей структуре App через UIApplicationDelegateAdaptor или NSApplicationDelegateAdaptor . Вы также должны отключить swizzling делегата приложения. Дополнительные сведения см. в инструкциях SwiftUI .

   SwiftUI

   @main
   struct YourApp: App {
     // register app delegate for Firebase setup
     @UIApplicationDelegateAdaptor(AppDelegate.self) var delegate
   
     var body: some Scene {
       WindowGroup {
         NavigationView {
           ContentView()
         }
       }
     }
   }
         

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

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

Однако, если у вас возникли проблемы с настройкой, посетите страницу устранения неполадок платформ Apple и часто задаваемые вопросы .

Примечание. Если вы ориентируетесь на macOS или macOS Catalyst, вы должны добавить к своей цели возможность общего доступа к цепочке ключей . В Xcode перейдите на вкладку « Подписание и возможности » вашей цели, а затем нажмите + «Возможности », чтобы добавить новую возможность.

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

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

• Справочная документация ( Swift | Obj-C )

• Репозиторий SDK Firebase для платформ Apple на GitHub

Для приложений, использующих CocoaPods, модуль Firebase устарел в версии 9.0 и выше. Вместо этого вам нужно ссылаться на модули продуктов непосредственно в вашем подфайле (например, FirebaseCore вместо Firebase/Core и FirebaseFirestore вместо Firebase/Firestore ).

Услуга или продукт	стручки	Библиотеки SwiftPM	Добавить аналитику?
AdMob	pod 'Google-Mobile-Ads-SDK'	Н/Д
Аналитика	pod 'FirebaseAnalytics'	FirebaseAnalytics
Проверка приложения	pod 'FirebaseAppCheck'	FirebaseAppCheck
Распространение приложений	pod 'FirebaseAppDistribution'	FirebaseAppDistribution
Аутентификация	pod 'FirebaseAuth'	FirebaseAuth
Облако Firestore	pod 'FirebaseFirestore'	FirebaseFirestore
Облачные функции для Firebase Client SDK	pod 'FirebaseFunctions'	FirebaseFunctions
Облачный обмен сообщениями	pod 'FirebaseMessaging'	FirebaseMessaging
Облачное хранилище	pod 'FirebaseStorage'	FirebaseStorage
Crashlytics	pod 'FirebaseCrashlytics'	FirebaseCrashlytics
Динамические ссылки	pod 'FirebaseDynamicLinks'	FirebaseDynamicLinks
Обмен сообщениями в приложении	pod 'FirebaseInAppMessaging'	FirebaseInAppMessaging	(обязательный)
Установки Firebase	pod 'FirebaseInstallations'	FirebaseInstallations
API пользовательских моделей Firebase ML	pod 'FirebaseMLModelDownloader'	FirebaseMLModelDownloader
Мониторинг производительности	pod 'FirebasePerformance'	FirebasePerformance
База данных реального времени	pod 'FirebaseDatabase'	FirebaseDatabase
Удаленная конфигурация	pod 'FirebaseRemoteConfig'	FirebaseRemoteConfig

Интеграция без использования Swift Package Manager

Если вы не хотите использовать Swift Package Manager, вы все равно можете воспользоваться преимуществами Firebase SDK, используя CocoaPods или напрямую импортировав фреймворки.

CocoaPods

Узнайте больше об интеграции CocoaPods в нашем руководстве .

Фреймворки

Помимо поддержки платформы iOS, архив теперь включает файлы .xcframework . Подробнее см. в файле README SDK Firebase для платформ Apple на GitHub .

1. Скачайте фреймворк SDK в формате zip . Это файл размером ~ 200 МБ, и его загрузка может занять некоторое время.

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

3. Добавьте флаг компоновщика -ObjC в Other Linker Settings сборки вашей цели.

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

Узнайте о Firebase:

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

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

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

• Исследуйте открытый исходный код на GitHub .

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

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

• Возникли проблемы с Firebase и вашим проектом Apple? Посетите страницу устранения неполадок платформ Apple и часто задаваемые вопросы .

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

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

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

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

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

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

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

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