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

Для клиентских приложений iOS вы можете получать уведомления и полезные данные размером до 4 КБ через интерфейс APN Firebase Cloud Messaging.

Чтобы написать клиентский код на Objective-C или Swift, мы рекомендуем вам использовать FIRMessaging API . Пример быстрого запуска предоставляет образец кода для обоих языков.

Использование методов в Firebase Cloud Messaging

FCM SDK выполняет смену методов в двух ключевых областях: сопоставление вашего токена APN с регистрационным токеном FCM и сбор аналитических данных во время обработки обратного вызова сообщения в нисходящем направлении . Разработчики, которые предпочитают не использовать swizzling, могут отключить его, добавив флаг FirebaseAppDelegateProxyEnabled в файл Info.plist приложения и установив для него значение NO (логическое значение). В соответствующих разделах руководств представлены примеры кода, как с включенным переключением методов, так и без него.

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

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

Предпосылки

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

  • Xcode 12.2 или новее
  • CocoaPods 1.10.0 или новее

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

  • Ваш проект должен быть нацелен на iOS 10 или новее.

• Настройте физическое устройство iOS для запуска вашего приложения и выполните следующие задачи:

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

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

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

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

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

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

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

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

1. Зайдите в консоль Firebase .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Мы рекомендуем использовать CocoaPods для установки библиотек Firebase. Однако, если вы не хотите использовать CocoaPods, вы можете напрямую интегрировать фреймворки SDK или использовать бета-версию Swift Package Manager .

Вы используете один из примеров быстрого запуска ? Проект Xcode и Podfile (с модулями) уже присутствуют, но вам все равно нужно добавить файл конфигурации Firebase и установить модули.

1. Создайте подфайл, если у вас его еще нет:

   cd your-project-directory

   pod init

2. В свой Podfile добавьте модули Firebase, которые вы хотите использовать в своем приложении.

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

   Для оптимальной работы с Firebase Cloud Messaging мы рекомендуем включить Google Analytics в вашем проекте. Кроме того, в рамках настройки Analytics вам необходимо добавить в приложение Firebase SDK для Analytics.

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

   # Add the Firebase pod for Google Analytics
   pod 'Firebase/Analytics'
   
   # Add the pod for Firebase Cloud Messaging
   pod 'Firebase/Messaging'

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

   # Add the pod for Firebase Cloud Messaging
   pod 'Firebase/Messaging'

3. Установите .xcworkspace , затем откройте файл .xcworkspace чтобы увидеть проект в Xcode:

   pod install

   open your-project.xcworkspace

Загрузите ключ аутентификации APNs

Загрузите ключ аутентификации APN в Firebase. Если у вас еще нет ключа аутентификации APN, см. Раздел Настройка APN с помощью FCM .

1. Внутри своего проекта в консоли Firebase щелкните значок шестеренки, выберите « Настройки проекта» , а затем выберите вкладку « Облачные сообщения ».

2. В ключе аутентификации APN в конфигурации приложения iOS нажмите кнопку « Загрузить» .

3. Перейдите в папку, в которой вы сохранили ключ, выберите его и нажмите « Открыть» . Добавьте идентификатор ключа (доступен в разделе « Сертификаты, идентификаторы и профили» Центра разработчиков Apple ) и нажмите « Загрузить» .

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

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

1. Импортируйте модуль Firebase в свой UIApplicationDelegate :

   Быстрый

   import Firebase

   Цель-C

   @import Firebase;

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

   Быстрый

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

   Цель-C

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

Зарегистрируйтесь для удаленных уведомлений

if #available(iOS 10.0, *) {
  // For iOS 10 display notification (sent via APNS)
  UNUserNotificationCenter.current().delegate = self

  let authOptions: UNAuthorizationOptions = [.alert, .badge, .sound]
  UNUserNotificationCenter.current().requestAuthorization(
    options: authOptions,
    completionHandler: {_, _ in })
} else {
  let settings: UIUserNotificationSettings =
  UIUserNotificationSettings(types: [.alert, .badge, .sound], categories: nil)
  application.registerUserNotificationSettings(settings)
}

application.registerForRemoteNotifications()
AppDelegate.swift

if ([UNUserNotificationCenter class] != nil) {
  // iOS 10 or later
  // For iOS 10 display notification (sent via APNS)
  [UNUserNotificationCenter currentNotificationCenter].delegate = self;
  UNAuthorizationOptions authOptions = UNAuthorizationOptionAlert |
      UNAuthorizationOptionSound | UNAuthorizationOptionBadge;
  [[UNUserNotificationCenter currentNotificationCenter]
      requestAuthorizationWithOptions:authOptions
      completionHandler:^(BOOL granted, NSError * _Nullable error) {
        // ...
      }];
} else {
  // iOS 10 notifications aren't available; fall back to iOS 8-9 notifications.
  UIUserNotificationType allNotificationTypes =
  (UIUserNotificationTypeSound | UIUserNotificationTypeAlert | UIUserNotificationTypeBadge);
  UIUserNotificationSettings *settings =
  [UIUserNotificationSettings settingsForTypes:allNotificationTypes categories:nil];
  [application registerUserNotificationSettings:settings];
}

[application registerForRemoteNotifications];
AppDelegate.m

Доступ к токену регистрации

По умолчанию FCM SDK генерирует регистрационный токен для экземпляра клиентского приложения при запуске приложения. Подобно токену устройства APN, этот токен позволяет отправлять целевые уведомления любому конкретному экземпляру вашего приложения.

Точно так же, как iOS обычно доставляет токен устройства APN при запуске приложения, FCM предоставляет регистрационный токен через FIRMessagingDelegate messaging:didReceiveRegistrationToken: FCM SDK извлекает новый или существующий токен во время первоначального запуска приложения, а также всякий раз, когда токен обновляется или становится недействительным. Во всех случаях FCM SDK вызывает messaging:didReceiveRegistrationToken: с действительным токеном.

Токен регистрации может измениться, когда:

• Приложение восстановлено на новом устройстве
• Пользователь удаляет / переустанавливает приложение
• Пользователь очищает данные приложения.

Установите делегата обмена сообщениями

Чтобы получить токены регистрации, реализуйте протокол делегата обмена сообщениями и установите FIRMessaging delegate [FIRApp configure] после вызова [FIRApp configure] . Например, если делегат вашего приложения соответствует протоколу делегата обмена сообщениями, вы можете установить делегат в application:didFinishLaunchingWithOptions: самому себе.

Messaging.messaging().delegate = self

[FIRMessaging messaging].delegate = self;

Получение текущего регистрационного токена

Жетоны регистрации доставляются с помощью метода messaging:didReceiveRegistrationToken: Этот метод обычно вызывается один раз на запуск приложения с токеном регистрации. Когда вызывается этот метод, это идеальное время для:

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

Вы можете получить токен напрямую, используя токен (завершение :) . Если получение токена не удалось каким-либо образом, выдается ошибка, отличная от NULL.

Messaging.messaging().token { token, error in
  if let error = error {
    print("Error fetching FCM registration token: \(error)")
  } else if let token = token {
    print("FCM registration token: \(token)")
    self.fcmRegTokenMessage.text  = "Remote FCM registration token: \(token)"
  }
}

[[FIRMessaging messaging] tokenWithCompletion:^(NSString *token, NSError *error) {
  if (error != nil) {
    NSLog(@"Error getting FCM registration token: %@", error);
  } else {
    NSLog(@"FCM registration token: %@", token);
    self.fcmRegTokenMessage.text = token;
  }
}];

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

Мониторинг обновления токена

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

func messaging(_ messaging: Messaging, didReceiveRegistrationToken fcmToken: String?) {
  print("Firebase registration token: \(String(describing: fcmToken))")

  let dataDict:[String: String] = ["token": fcmToken ?? ""]
  NotificationCenter.default.post(name: Notification.Name("FCMToken"), object: nil, userInfo: dataDict)
  // TODO: If necessary send token to application server.
  // Note: This callback is fired at each app startup and whenever a new token is generated.
}
AppDelegate.swift

- (void)messaging:(FIRMessaging *)messaging didReceiveRegistrationToken:(NSString *)fcmToken {
    NSLog(@"FCM registration token: %@", fcmToken);
    // Notify about received token.
    NSDictionary *dataDict = [NSDictionary dictionaryWithObject:fcmToken forKey:@"token"];
    [[NSNotificationCenter defaultCenter] postNotificationName:
     @"FCMToken" object:nil userInfo:dataDict];
    // TODO: If necessary send token to application server.
    // Note: This callback is fired at each app startup and whenever a new token is generated.
}
AppDelegate.m

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

Swizzling отключен: сопоставление вашего токена APN и токена регистрации

Если вы отключили переключение методов, вам необходимо явно сопоставить свой токен APN с токеном регистрации FCM. Переопределите методы didRegisterForRemoteNotificationsWithDeviceToken для получения токена FIRMessaging , а затем установите FIRMessaging для APNSToken :

func application(application: UIApplication,
                 didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
  Messaging.messaging().apnsToken = deviceToken
}

// With "FirebaseAppDelegateProxyEnabled": NO
- (void)application:(UIApplication *)application
    didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
    [FIRMessaging messaging].APNSToken = deviceToken;
}

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

Запретить автоматическую инициализацию

Когда генерируется регистрационный токен FCM, библиотека загружает идентификатор и данные конфигурации в Firebase. Если вы хотите сначала получить явное согласие от пользователей, вы можете предотвратить генерацию токенов во время настройки, отключив FCM. Для этого добавьте значение метаданных в свой Info.plist (а не в свой GoogleService-Info.plist ):

FirebaseMessagingAutoInitEnabled = NO

Чтобы снова включить FCM, вы можете выполнить вызов во время выполнения:

Messaging.messaging().autoInitEnabled = true

[FIRMessaging messaging].autoInitEnabled = YES;

Это значение сохраняется после перезапуска приложения.

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

После того, как вы настроили свой клиент iOS, вы готовы добавить в свое приложение обработку сообщений и другое, более продвинутое поведение. См. Эти руководства для получения дополнительной информации:

• Получать сообщения в приложении для iOS
• Отправить сообщения темы
• Отправить в группы устройств