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

1. Введение

Последнее обновление: 06.01.2020

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

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

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

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

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

Архитектурный обзор FCM

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

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

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

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

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. Нажмите «Далее» .

Идентификатор пакета (Bundle Identifier) ​​понадобится вам при создании ключа APN и регистрации вашего приложения в проекте Firebase.

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

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

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

Для создания ключа аутентификации:

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

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

3. Введите описание для ключа авторизации APNs.
4. В разделе «Ключевые услуги» установите флажок «APNs» и нажмите «Продолжить» .

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

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

Идентификатор приложения (App ID) — это уникальный идентификатор, позволяющий однозначно определить приложение. По общепринятой практике он представляется в виде перевернутого домена.

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

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

7. Чтобы создать новый идентификатор приложения:
8. Введите имя для идентификатора вашего приложения.
9. Введите идентификатор команды . Это значение должно совпадать с идентификатором команды на вкладке «Участие».
10. В разделе «Суффикс идентификатора приложения» выберите «Явный идентификатор приложения» , а затем введите идентификатор пакета .
11. В разделе «Службы приложений» убедитесь, что установлен флажок «Push-уведомления» .
12. Нажмите «Продолжить» и убедитесь, что введенные данные верны:
13. Значение поля Identifier должно совпадать с результатом объединения значений Team ID и Bundle ID.
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 Crashlytics
• Прогнозы Firebase
• Firebase Cloud Messaging
• Firebase In-App Messaging
• Firebase Remote Config
• 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. При появлении запроса выберите этот вариант, чтобы добавить файл конфигурации ко всем целям.

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

Закройте Xcode.

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

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

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

$ cd MessagingExample
$ pod init

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

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

В пример быстрого запуска добавлены 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 application:didFinishLaunchingWithOptions: ` вашего приложения.

AppDelegate.swift

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

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

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

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

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

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

2. В разделе «Ключ аутентификации APNs» в настройках приложения Apple нажмите кнопку «Загрузить» , чтобы загрузить ключ аутентификации для разработки, ключ аутентификации для производственной среды или оба ключа. Требуется как минимум один ключ.

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
}

Для назначения свойства delegate классу 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
}

Для назначения свойства delegate объекта 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. Click + Возможность .

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 Cloud Messaging

Дополнительная информация

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