Интеграция push-библиотек в iOS-приложение
В этой статье описана пошаговая интеграция библиотек EDNAPushLite и EDNAPushNE в iOS-приложение.
EDNAPushLite интегрируется в основное приложение и обеспечивает регистрацию устройства, получение и обработку push-уведомлений и push-сообщений. EDNAPushNE интегрируется в расширение Notification Service Extension и используется для обработки push-уведомлений перед их отображением пользователю.
Для совместной работы библиотек передавайте deviceAddress из основного приложения в Notification Service Extension. Для этого рекомендуется использовать App Group, который позволяет автоматически обмениваться deviceAddress между приложением и расширением.
Перед началом
Перед началом интеграции убедитесь, что у вас есть:
- iOS-приложение, в которое необходимо интегрировать push-сервис edna;
- проект приложения в Xcode;
- доступ к Apple Developer Account;
Apple Developer Account - возможность создавать и настраивать App ID, App Group и Notification Service Extension;
- библиотеки
EDNAPushLiteиEDNAPushNE.
Шаг 1. Создайте App Group
App Group используется для обмена данными между основным приложением и Notification Service Extension. В рамках интеграции push-библиотек группа позволяет автоматически передавать значение deviceAddress из EDNAPushLite в EDNAPushNE.
-
В Apple Developer Account перейдите в раздел Certificates, Identifiers & Profiles → Identifiers → App Groups.
Apple Developer Account -
Создайте новую группу.
-
Укажите идентификатор группы в поле Identifier. Рекомендуется использовать в качестве идентификатора группы Bundle ID приложения, например:
group.com.mycompany.myapp -
Сохраните идентификатор группы — он потребуется далее при настройке проекта, Notification Service Extension и библиотек.
Шаг 2. Создайте Notification Service Extension в Xcode
Notification Service Extension запускается при получении push-уведомления и позволяет обрабатывать его до отображения пользователю, не запуская основное приложение.
- Добавьте новый Target в проект: File → New → Target.
- Выберите тип расширения Notification Service Extension.
- В окне Choose options for your new target укажите
notificationServiceв поле Product Name. - В окне Activate “notificationService” scheme? нажмите Activate, чтобы активировать схему расширения.
Шаг 3. Подключите EDNAPushLite
Библиотеку EDNAPushLite можно подключить к проекту одним из следующих способов:
- Swift Package Manager
- CocoaPods
- Ручное подключение
Для подключения библиотеки через Swift Package Manager укажите адрес репозитория:
https://github.com/edna-ru/push-lite-ios
Для подключения библиотеки через CocoaPods добавьте в Podfile проекта следующую запись:
pod 'EDNAPushLite', :podspec => 'https://maven-pub.edna.ru/repository/maven-public/com/edna/ios/push-lite/3.3.0/EDNAPushLite.podspec'
- Распакуйте файлы библиотеки в любой каталог проекта.
- На вкладке General в разделе Frameworks, Libraries and Embedded Content добавьте библиотеку.
- Добавьте следующие системные фреймворки:
UserNotifications.framework;UIKit.framework;Foundation.framework.
- На вкладке Capabilities:
- добавьте Push Notifications;
- в разделе App Groups выберите ранее созданную группу;
- в разделе Background Modes включите Background fetch и Remote notifications.
- На вкладке Build Settings в разделе Build Options установите для параметра Always Embed Swift Standard Libraries значение Yes.
Начиная с версии 3.1.1, для Xcode ниже версии 16 на вкладке Build Settings в разделе User-Defined установите для параметра ENABLE_BITCODE значение NO.
Шаг 4. Подключите EDNAPushNE
Библиотеку EDNAPushNE можно подключить к проекту одним из следующих способов:
- Swift Package Manager
- CocoaPods
- Ручное подключение
Для подключения библиотеки через Swift Package Manager укажите адрес репозитория:
https://github.com/edna-ru/push-ne-ios
Для подключения библиотеки через CocoaPods добавьте в Podfile проекта следующую запись:
pod 'EDNAPushNE', :podspec => 'https://maven-pub.edna.ru/repository/maven-public/com/edna/ios/push-ne/3.3.0/EDNAPushNE.podspec'
- Распакуйте файлы библиотеки в любой каталог проекта.
- На вкладке General в разделе Linked Frameworks and Libraries добавьте
EDNAPushNE.xcframework. - В разделе Identity измените значение Bundle Identifier, чтобы расширение могло использовать App Group и получать значение
deviceAddress. - На вкладке Capabilities:
- добавьте Push Notifications;
- в разделе App Groups выберите ранее созданную группу.
Начиная с версии 3.1.1, для Xcode ниже версии 16 на вкладке Build Settings в разделе User-Defined установите для параметра ENABLE_BITCODE значение NO.
Настройка Info.plist
-
Для обмена данными между основным приложением и Notification Service Extension добавьте в файлы
Info.plistприложения и расширения строковый параметрedna_app_group.подсказкаПо умолчанию библиотеки получают идентификатор App Group из параметра
edna_app_group. При необходимости его можно задать программно с помощью свойстваappGroupпри инициализации библиотеки.Пример настройки:
<key>edna_app_group</key><string>group.com.mycompany.myapp</string> -
В файл
Info.plistрасширения Notification Service Extension также добавьте логический параметрedna_use_test_mode.false— использование боевого сервера (значение по умолчанию);true— использование тестового сервера.
Пример настройки:
<key>edna_use_test_mode</key><true/>
Шаг 5. Интегрируйте EDNAPushLite
На этом этапе необходимо настроить библиотеку EDNAPushLite в основном приложении. Для этого внесите изменения в файл AppDelegate.swift.