概述
iOS 推送通知对于在您的 iOS 应用中推动持续的用户参与度和留存率至关重要。它们使您能够直接向用户提供实时更新、提醒和个性化消息,从而改善整体用户体验和应用的粘性。通过将 OneSignal 的 SDK 与您的应用集成,您可以利用 Apple 推送通知服务 (APNS) 确保您的通知在 iOS 设备上无缝传递。本指南将指导您将我们的 SDK 集成到您的 iOS 应用中。要求
- 带有 Xcode 14+ 的 macOS(设置说明使用 Xcode 16.2)
- 带有 iOS 12+、iPadOS 12+ 的设备,或运行 iOS 16.2+ 的 Xcode 模拟器
- 配置好的 OneSignal 应用和平台
配置您的 OneSignal 应用和平台
使用您支持的平台配置您的 OneSignal 应用——Apple (APNs)、Google (FCM)、华为 (HMS) 和/或 Amazon (ADM)。分步设置说明
分步设置说明
1
创建或选择您的应用
点击 新应用/网站 创建新应用,或在 设置 > 推送和应用内 中向现有应用添加平台。选择您要配置的平台,然后点击 下一步:配置您的平台。

2
配置平台凭据
为您的平台输入凭据:
- Android:设置 Firebase 凭据
- iOS:p8 令牌(推荐) 或 p12 证书
- Amazon:生成 API 密钥
- 华为:授权 OneSignal
3
保存您的应用 ID 并安装 SDK
您的 应用 ID 显示在最终屏幕上。复制并保存它——初始化 SDK 时需要使用它。选择您的 SDK 平台,然后按照设置指南操作。

iOS 设置
按照以下步骤向您的 iOS 应用添加推送通知,包括支持徽章、确认送达和图像。1. 向应用目标添加推送通知功能
推送通知功能允许您的应用注册推送令牌并接收通知。- 在 Xcode 中打开您应用的
.xcworkspace文件。 - 选择您的应用目标 > 签名和功能
- 点击 + 功能并添加推送通知功能

2. 向应用目标添加后台模式功能
这使您的应用能够在推送通知到达时在后台唤醒。- 添加后台模式功能
- 启用远程通知

3. 将应用目标添加到应用组
应用组允许在您的应用和通知服务扩展之间共享数据。确认送达和徽章功能所必需。- 如果您没有配置应用组
- 如果您已有应用组
- 添加应用组功能
- 在应用组功能中点击 +
- 按以下格式添加新的容器 ID:
group.your_bundle_id.onesignal
- 保持 group. 和 .onesignal 前缀和后缀。用您应用的包标识符替换
your_bundle_id。 - 例如,包标识符
com.onesignal.MyApp将具有容器名称group.com.onesignal.MyApp.onesignal。

4. 添加通知服务扩展
Notification Service Extension (NSE) 允许丰富的通知和确认送达分析。- 在 Xcode 中:File > New > Target…
- 选择 Notification Service Extension,然后 Next。
- 将产品名称设置为
OneSignalNotificationServiceExtension并按 Finish。 - 在 Activate scheme 提示上按 Don’t Activate。



如果您使用 CocoaPods,请也在您的 Podfile 中设置部署版本。

5. 将 NSE 目标添加到应用组
使用您在步骤 3 中添加的相同应用组 ID。- 转到 OneSignalNotificationServiceExtension > Signing & Capabilities
- 添加 App Groups
- 添加完全相同的组 ID

6. 更新 NSE 代码
- 导航到 OneSignalNotificationServiceExtension 文件夹
- 使用以下内容替换
NotificationService.swift或NotificationService.m文件的内容:


SDK设置
本部分将指导您集成 OneSignal 的核心功能。在本部分结束时,您将拥有与我们 SDK 的基本集成,使您能够触发应用内消息并接收推送通知。1. 添加 SDK
使用 Xcode Package Dependencies Manager (Swift Package Manager) 或 CocoaPods 添加我们的 SDK。有 4 个可用的库。如果您不需要应用内消息和/或位置追踪,您可以省略这些包。- Xcode 包依赖
- CocoaPods
导航到 File > Add Package Dependencies… 并输入 OneSignal SDK 仓库的 URL:
有关更多详情,请参阅 Apple 的添加包依赖文档。
https://github.com/OneSignal/OneSignal-XCFramework选择 onesignal-xcframework 包并点击 Add Package。为 OneSignal-XCFramework 选择包产品。- 重要:将 OneSignalExtension 添加到 OneSignalNotificationServiceExtension Target。
- 将 OneSignalFramework 添加到您的 App Target。
- 如果您计划使用应用内消息(推荐)和/或位置追踪,那么也请将这些包添加到您的 App Target。

2. 初始化 SDK
根据您的 Xcode 界面设置,按照以下选项初始化 OneSignal。- SwiftUI
- Storyboard
如果使用 SwiftUI 界面,请导航到您的
<APP_NAME>App.swift 文件并使用提供的方法初始化 OneSignal。将 YOUR_APP_ID 替换为您在 OneSignal 仪表板 Settings > Keys & IDs 中找到的 OneSignal App ID。如果您无法访问 OneSignal 应用,请要求您的团队成员邀请您。禁用方法 swizzling(可选)
默认情况下,OneSignal SDK 使用方法 swizzling 自动处理推送通知委托方法。如果您的应用需要禁用 swizzling(例如,为了避免与其他 SDK 冲突或保持对通知委托方法的完全控制),您可以通过Info.plist 选择退出。
禁用 swizzling 后,您必须手动将通知委托方法转发到 OneSignal SDK。所有其他 SDK 功能(监听器、观察者、应用内消息、结果等)继续正常工作。
步骤 1. 添加 Info.plist 标志
将以下内容添加到您应用的Info.plist:
步骤 2. 设置 UNUserNotificationCenter 委托
在调用OneSignal.initialize 之前,将您的 AppDelegate 设置为 UNUserNotificationCenter 委托。否则,前台通知显示和通知点击处理将无法正常工作。
步骤 3. 转发通知委托方法
在您的AppDelegate 中实现以下方法。所有方法通过 OneSignal.Notifications 调用。
令牌注册:
OSNotification 对象调用您的完成块。如果非 nil,SDK 希望显示通知——传递您首选的展示选项。如果为 nil(例如,IAM 预览),则不传递任何展示选项。
onWillDisplayNotification 生命周期监听器和 preventDefault / display API 继续支持手动转发。SDK 从 handleWillPresentNotificationInForegroundWithPayload 内部调用您的监听器。可选:设置角标数量
禁用 swizzling 后,SDK 无法拦截角标变化。使用此方法设置角标数量并与 OneSignal 的内部角标缓存保持同步:SwiftUI 应用
SwiftUI 应用默认没有AppDelegate。使用 @UIApplicationDelegateAdaptor 添加一个,然后实现上面所示的所有转发方法:
Swift
API 参考
测试 OneSignal SDK 集成
本指南帮助您通过测试推送通知、订阅注册和应用内消息来验证 OneSignal SDK 集成是否正常工作。检查移动端订阅
1
在测试设备上启动您的应用。
如果您在初始化时添加了 
requestPermission 方法,原生推送权限提示应该会自动出现。
2
检查您的 OneSignal 控制台
在接受提示之前,请检查 OneSignal 控制台:
- 转到 受众 > 订阅。
- 您应该看到一个状态为”从未订阅”的新条目。

3
返回应用并在提示中点击允许。
4
刷新 OneSignal 控制台的订阅页面。
设置测试订阅
测试订阅有助于在发送消息之前测试推送通知。1
添加到测试订阅。
在控制台中,在订阅旁边,点击选项(三个点)按钮并选择添加到测试订阅。

2
为您的订阅命名。
为订阅命名,以便您稍后能够在测试订阅标签中轻松识别您的设备。
3
创建测试用户分组。
转到 受众 > 分组 > 新建分组。
4
为分组命名。
将分组命名为
Test Users(名称很重要,因为稍后会使用到)。5
添加测试用户过滤器并点击创建分组。

您已成功创建了测试用户分组。
现在我们可以测试向这个单独的设备和测试用户组发送消息。
通过 API 发送测试推送
1
获取您的应用 API 密钥和应用 ID。
在您的 OneSignal 控制台中,转到 设置 > 密钥和 ID。
2
更新提供的代码。
将下面代码中的
YOUR_APP_API_KEY 和 YOUR_APP_ID 替换为您的实际密钥。此代码使用我们之前创建的 Test Users 分组。3
运行代码。
在您的终端中运行代码。
4
检查图片和确认送达。
如果所有设置步骤都成功完成,测试订阅应该会收到包含图片的通知:

图片在折叠的通知视图中会显得很小。展开通知以查看完整图片。
5
检查确认送达。
在您的控制台中,转到 送达 > 已发送消息,然后点击消息查看统计数据。您应该会看到已确认统计,表示设备收到了推送。
您已成功通过我们的 API 向分组发送了通知。
发送应用内消息
应用内消息让您可以在用户使用您的应用时与他们进行沟通。1
在设备上关闭或将您的应用切换到后台。
这是因为用户必须在新会话开始_之前_满足应用内受众条件。在 OneSignal 中,当用户在应用处于后台或关闭至少 30 秒后重新打开应用时,会开始一个新会话。更多详情,请参阅我们的应用内消息如何显示指南。
2
创建应用内消息。
- 在您的 OneSignal 控制台中,导航到 消息 > 应用内 > 新建应用内消息。
- 找到并选择欢迎消息。
- 将您的受众设置为我们之前使用的 Test Users 分组。

3
如需要,请自定义消息内容。

4
将触发器设置为 '应用打开时'。
5
安排频率。
在 安排 > 您希望多久显示一次此消息? 下选择 每次触发条件满足时。

6
使消息生效。
点击 使消息生效,这样每次测试用户打开应用时都可以使用该消息。
7
打开应用并查看消息。
应用内消息生效后,打开您的应用。您应该会看到它显示:

用户识别
之前,我们演示了如何创建移动端订阅。现在我们将扩展到使用 OneSignal SDK 在所有订阅(包括推送、电子邮件和短信)中识别用户。我们将涵盖外部 ID、标签、多渠道订阅、隐私和事件跟踪,以帮助您统一用户并跨平台与他们互动。分配外部 ID
使用外部 ID 通过您后端的用户标识符在设备、电子邮件地址和电话号码之间一致地识别用户。这确保您的消息传递在各个渠道和第三方系统中保持统一(对集成特别重要)。 每次您的应用识别用户时,使用我们 SDK 的login 方法设置外部 ID。
OneSignal 为订阅(订阅 ID)和用户(OneSignal ID)生成唯一的只读 ID。当用户在不同设备上下载您的应用、订阅您的网站,和/或在您的应用之外提供电子邮件地址和电话号码时,将创建新的订阅。强烈建议通过我们的 SDK 设置外部 ID,以在用户的所有订阅中识别用户,无论订阅是如何创建的。
添加数据标签
标签是字符串数据的键值对,您可以使用它们来存储用户属性(如username、role 或偏好)和事件(如 purchase_date、game_level 或用户交互)。标签支持高级消息个性化和分组,允许更高级的用例。
在您的应用中发生事件时,使用我们 SDK 的addTag 和 addTags 方法设置标签。
在这个示例中,用户达到了第 6 级,可以通过名为 current_level 的标签识别,其值设置为 6。




添加电子邮件和/或短信订阅
之前我们了解了我们的 SDK 如何创建移动端订阅来发送推送和应用内消息。您还可以通过创建相应的订阅,通过电子邮件和短信渠道联系用户。- 使用
addEmail方法创建电子邮件订阅。 - 使用
addSms方法创建短信订阅。

多渠道沟通的最佳实践
- 在添加电子邮件或短信订阅之前获得明确同意。
- 向用户解释每个沟通渠道的好处。
- 提供渠道偏好,让用户可以选择他们偏好的渠道。
隐私和用户同意
要控制 OneSignal 何时收集用户数据,请使用 SDK 的同意管控方法:setConsentRequired(true):阻止数据收集直到获得同意。setConsentGiven(true):一旦获得同意即启用数据收集。
提示推送权限
不要在应用打开时立即调用requestPermission(),而是采取更策略性的方法。在请求权限之前,使用应用内消息解释推送通知的价值。
有关最佳实践和实现细节,请参阅我们的提示推送权限指南。
监听推送、用户和应用内事件
使用 SDK 监听器来响应用户操作和状态变化。 SDK 提供了几个事件监听器供您使用。更多详情请参阅我们的SDK 参考指南。推送通知事件
addClickListener():检测通知被点击时。对深度链接有帮助。addForegroundLifecycleListener():控制通知在前台的行为方式。
用户状态变化
addObserver()用于用户状态:检测外部 ID 设置时。addPermissionObserver():跟踪用户与原生推送权限提示的特定交互。addObserver()用于推送订阅:跟踪推送订阅状态变化时。
应用内消息事件
addClickListener():处理应用内点击操作。适用于深度链接或跟踪事件。addLifecycleListener():跟踪应用内消息的完整生命周期(显示、点击、关闭等)。
高级设置和功能
探索更多功能以增强您的集成:移动端 SDK 设置和参考
通过查看移动端推送设置指南,确保您已启用所有关键功能。 有关可用方法和配置选项的完整详细信息,请访问移动端 SDK 参考。恭喜!您已成功完成移动端 SDK 设置指南。
需要帮助?与我们的支持团队聊天或发送邮件至
support@onesignal.com请包含以下信息:- 您遇到的问题详情以及复现步骤(如有)
- 您的 OneSignal 应用 ID
- 外部 ID 或订阅 ID(如适用)
- 您在 OneSignal 控制台中测试的消息 URL(如适用)
- 任何相关的日志或错误信息

