Добавьте push-уведомления в приложение iOS

1. Введение

Последнее обновление: 6 января 2020 г.

Firebase Cloud Messaging (FCM) — это кроссплатформенное решение для обмена сообщениями, которое позволяет надежно отправлять сообщения бесплатно.

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

Как это работает?

Реализация FCM включает в себя два основных компонента для отправки и получения:

1. Доверенная среда, такая как облачные функции для Firebase или сервер приложений, на которой можно создавать, нацеливать и отправлять сообщения.
2. Клиентское приложение iOS, Android или веб-приложение (JavaScript), которое получает сообщения через соответствующую транспортную службу для конкретной платформы.

Обзор архитектуры FCM

FCM использует следующий набор компонентов, которые создают, транспортируют и получают сообщения:

1. Инструменты для составления или построения запросов сообщений. Компоновщик уведомлений предоставляет возможность создания запросов на уведомления на основе графического интерфейса. Для полной автоматизации и поддержки всех типов сообщений вам необходимо создавать запросы сообщений в среде доверенного сервера, поддерживающей Firebase Admin SDK или протоколы сервера FCM. Этой средой могут быть облачные функции для Firebase, Google App Engine или ваш собственный сервер приложений.
2. Серверная часть FCM, которая (помимо других функций) принимает запросы сообщений, выполняет разветвление сообщений по темам и генерирует метаданные сообщения, такие как идентификатор сообщения.
3. Транспортный уровень уровня платформы, который направляет сообщение на целевое устройство, обрабатывает доставку сообщения и при необходимости применяет конфигурацию, специфичную для платформы. Этот транспортный уровень включает в себя:

• Транспортный уровень Android (ATL) для устройств Android с сервисами Google Play
• Служба push-уведомлений Apple (APN) для устройств iOS
• Протокол Web push для веб-приложений

Примечание. Транспортные уровни уровня платформы находятся за пределами службы FCM. Сообщения FCM, направляемые на транспортный уровень уровня платформы, могут регулироваться условиями, специфичными для этой платформы, а не условиями обслуживания FCM. Маршрутизация сообщений Android через ATL подпадает под условия обслуживания Google API.

4. FCM SDK на устройстве пользователя, где отображается уведомление или обрабатывается сообщение в соответствии с приоритетным/фоновым состоянием приложения и любой соответствующей логикой приложения.

Что ты построишь

В этой лаборатории кода вы собираетесь добавить push-уведомление в пример приложения iOS с помощью FCM.

Что вы узнаете

• Как подписаться и отписаться пользователя на push-рассылку
• Как обрабатывать входящие push-сообщения
• Как отобразить уведомление
• Как реагировать на клики по уведомлениям

Что вам понадобится

• Xcode 11.0 или новее
• CocoaPods 1.9.0 или новее
• Учетная запись разработчика Apple
• Физическое устройство iOS для запуска вашего приложения.
• Базовые знания Swift

2. Приступаем к настройке

Загрузите пример кода

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

Получить образец можно двумя способами:

• Клонируйте репозиторий Git:

$ git clone https://github.com/firebase/quickstart-ios.git

• Загрузите ZIP-файл:

Если вы загрузите исходный код в виде ZIP-файла, при его распаковке вы получите корневую папку quickstart-ios .

Скачать исходный код

Создать новое приложение

Создайте собственное тестовое приложение, выполнив следующие шаги (описанные ниже шаги описаны в XCode 12.3):

1. Откройте XCode и выберите «Создать новый проект Xcode» .
2. Выберите «Приложение» и нажмите «Далее» .

3. Введите название продукта (например, MessagingExample)
4. Выберите команду (если вы еще не создали команду, настройте ее в учетной записи разработчика Apple).
5. Введите идентификатор организации (например, com. your-name )
6. Входной идентификатор пакета (например, com. your-name .MessagingExample , он должен быть уникальным среди всех приложений iOS).
7. Выберите «Раскадровка» в раскрывающемся меню «Интерфейс» .
8. Выберите «Делегат приложения UIKit» в раскрывающемся списке «Жизненный цикл» .
9. Выберите Swift в разделе «Язык» .
10. Нажмите Далее .

Идентификатор пакета понадобится вам, когда вы создадите ключ APN и зарегистрируете свое приложение в проекте Firebase.

3. Настройка APN

Создайте ключ аутентификации

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

Чтобы создать ключ аутентификации:

1. В своей учетной записи разработчика перейдите в раздел «Сертификаты, идентификаторы и профили» и выберите «Ключи» .

2. Нажмите кнопку «Добавить» (+) в правом верхнем углу.

3. Введите описание ключа аутентификации APN.
4. В разделе «Службы ключей» установите флажок «APN» и нажмите « Продолжить» .

5. Нажмите «Зарегистрироваться» , а затем «Загрузить» . Сохраните ключ в надежном месте. Это одноразовая загрузка, и ключ нельзя получить позже.

Создайте идентификатор приложения

Идентификатор приложения — это идентификатор, который однозначно идентифицирует приложение. Условно он представлен перевернутым доменом.

1. Перейдите в Центр разработчиков Apple и войдите в систему.
2. Перейдите к Сертификаты, идентификаторы и профили .
3. Перейдите к Идентификаторам .
4. Нажмите кнопку + , чтобы создать новый идентификатор приложения.
5. Выберите переключатель «Идентификаторы приложений» и нажмите « Продолжить» .

6. Выберите «Приложение» и нажмите « Продолжить» .

7. Чтобы создать новый идентификатор приложения:
8. Введите имя для вашего идентификатора приложения.
9. Введите идентификатор команды . Это значение должно совпадать с идентификатором команды на вкладке «Членство».
10. В разделе «Суффикс идентификатора приложения» выберите «Явный идентификатор приложения» , затем введите идентификатор пакета .
11. В разделе «Службы приложений» убедитесь, что установлен флажок «Push-уведомления» .
12. Нажмите «Продолжить» и проверьте правильность введенных данных:
13. Значение идентификатора должно соответствовать объединению значений идентификатора команды и идентификатора пакета.
14. Push-уведомления должны быть настраиваемыми
15. Нажмите «Зарегистрировать» , чтобы создать идентификатор приложения.

Создать профиль

Чтобы протестировать приложение, пока оно находится в стадии разработки, вам понадобится профиль для разработки, который позволит вашим устройствам запускать приложение, которое еще не опубликовано в App Store.

1. Перейдите в Центр разработчиков Apple и войдите в систему.
2. Перейдите к Сертификаты, идентификаторы и профили .
3. В раскрывающемся меню в левом верхнем углу выберите iOS, tvOS, watchOS, если он еще не выбран, затем перейдите к «Профили» .
4. Нажмите кнопку + , чтобы создать новый профиль.
5. Выберите «Разработка приложений iOS» в качестве типа профиля подготовки, затем нажмите «Продолжить» .

6. В раскрывающемся меню выберите идентификатор приложения, которое вы хотите использовать, затем нажмите «Продолжить» .
7. Выберите сертификат разработки iOS для идентификатора приложения, выбранного на предыдущем шаге, затем нажмите «Продолжить» .
8. Выберите устройства iOS, которые вы хотите включить в профиль обеспечения, затем нажмите «Продолжить» . Обязательно выберите все устройства, которые вы хотите использовать для тестирования.
9. Введите имя для этого профиля обеспечения (например, MessagingExampleProfile ), затем нажмите «Создать» .

10. Нажмите «Загрузить» , чтобы сохранить профиль обеспечения на своем Mac.

11. Дважды щелкните файл профиля обеспечения, чтобы установить его.

4. Добавление Firebase в ваш проект iOS

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

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

1. В консоли Firebase нажмите «Добавить проект» , затем выберите или введите имя проекта .

Если у вас есть существующий проект Google Cloud Platform (GCP), вы можете выбрать проект из раскрывающегося меню, чтобы добавить ресурсы Firebase в этот проект.

2. (Необязательно) Если вы создаете новый проект, вы можете изменить его идентификатор .

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

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

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

• Firebase Крашлитикс
• Прогнозы Firebase
• Облачный обмен сообщениями Firebase
• Обмен сообщениями Firebase внутри приложения
• Удаленная конфигурация Firebase
• A/B-тестирование Firebase

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

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

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

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

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

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

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

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

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

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

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

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

Закройте Хкод.

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

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

1. Создайте подфайл, если у вас его еще нет. Если вы используете пример быстрого запуска, проект Xcode и Podfile (с модулями) уже присутствуют.

$ cd MessagingExample
$ pod init

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

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

В пример быстрого запуска были добавлены SDK Google Analytics и Firebase Cloud Messaging.

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

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

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

$ pod install

4. Откройте MessagingExample.xcworkspace и нажмите «Далее» в консоли Firebase.

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

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

Импортируйте модуль Firebase и настройте общий экземпляр (в примере быстрого запуска модуль Firebase уже импортирован).

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

AppDelegate.swift

import UIKit
import Firebase // Add this line

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

AppDelegate.swift

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
  FirebaseApp.configure() // Add this line
  return true
}

3. Нажмите «Далее» в консоли Firebase.
4. Firebase SDK добавляются в ваше приложение. Нажмите «Продолжить работу с консолью» .

5. Настройка клиента FCM

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

Загрузите ключ аутентификации APN в Firebase.

1. Внутри вашего проекта в консоли Firebase выберите значок шестеренки, выберите «Настройки проекта» , а затем выберите вкладку «Облачные сообщения» .
2. В разделе «Ключ аутентификации APN» в разделе «Конфигурация приложения iOS» нажмите кнопку «Загрузить» .
3. Перейдите в папку, в которой вы сохранили ключ, выберите его и нажмите «Открыть» . Добавьте идентификатор ключа (доступен в разделе «Сертификаты, идентификаторы и профили» Центра разработчиков Apple) и нажмите « Загрузить» .

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

Либо при запуске, либо в нужном месте потока приложения зарегистрируйте приложение для удаленных уведомлений.

В примере быстрого запуска registerForRemoteNotifications уже добавлен.

AppDelegate.swift

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
  FirebaseApp.configure()
  // [START register for remote notifications]
  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()
  // [END register for remote notifications]
  return true
}

Назначьте свойство делегата UNUserNotificationCenter , добавив эти строки в конец AppDelegate.swift.

AppDelegate.swift

@available(iOS 10, *)
extension AppDelegate : UNUserNotificationCenterDelegate {

  // Receive displayed notifications for iOS 10 devices.
  func userNotificationCenter(_ center: UNUserNotificationCenter,
                              willPresent notification: UNNotification,
    withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void) {
    let userInfo = notification.request.content.userInfo

    // Print full message.
    print(userInfo)

    // Change this to your preferred presentation option
    completionHandler([[.alert, .sound]])
  }

  func userNotificationCenter(_ center: UNUserNotificationCenter,
                              didReceive response: UNNotificationResponse,
                              withCompletionHandler completionHandler: @escaping () -> Void) {
    let userInfo = response.notification.request.content.userInfo

    // Print full message.
    print(userInfo)

    completionHandler()
  }
}

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

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

AppDelegate.swift

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
  FirebaseApp.configure()
  Messaging.messaging().delegate = self // Add this line
  // [START register for remote notifications]
  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()
  // [END register for remote notifications]
  return true
}

Назначьте свойство делегата FIRMessaging , добавив эти строки в конец AppDelegate.swift.

AppDelegate.swift

extension AppDelegate : MessagingDelegate {
  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)
  }
}

Добавить возможности

Вы добавили возможность push-уведомлений в раздел «Создать идентификатор приложения», но вам также необходимо добавить эту возможность в XCode, выполнив следующие действия (шаги ниже приведены в XCode 12.3):

1. Щелкните имя проекта в области навигатора.
2. Нажмите «Подписание и возможности» .
3. Нажмите + Возможность .

4. Дважды щелкните «Фоновые режимы» .
5. Нажмите + Возможность еще раз.
6. Дважды щелкните Push-уведомления .
7. Проверьте удаленные уведомления в разделах «Фоновые режимы» .

6. Отправьте уведомление.

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

1. Установите и запустите приложение на целевом устройстве. Вам нужно будет принять запрос на разрешение получать удаленные уведомления.
2. Получите регистрационный токен в журнале XCode.

3. Убедитесь, что приложение работает на устройстве в фоновом режиме.
4. Откройте композитор уведомлений и выберите «Новое уведомление» .
5. Введите текст сообщения.
6. Выберите Отправить тестовое сообщение .
7. В поле « Добавить регистрационный токен FCM» введите регистрационный токен, полученный на шаге 2.
8. Нажмите «Тест» .

После того, как вы нажмете «Тест» , целевое клиентское устройство (с приложением в фоновом режиме) должно получить уведомление в центре уведомлений.

Подробнее о доставке сообщений в ваше приложение можно узнать на панели отчетов FCM , которая записывает количество сообщений, отправленных и открытых на устройствах iOS и Android.

7. Поздравления

Поздравляем, вы успешно отправили тестовое сообщение!

В FCM есть еще много функций и конфигураций, таких как подписка на темы.

Если они вам интересны, ознакомьтесь с официальным документом разработчика .

Что дальше?

Ознакомьтесь с некоторыми из этих лабораторий кода.

• Продвинутый Android в Kotlin 01.2: Облачный обмен сообщениями Android Firebase

Дальнейшее чтение

• Официальный документ Firebase Cloud Messaging