实现 APNs 离线推送 - IM 即时通讯

开发者中心

IM 即时通讯

集成开发

实现 APNs 离线推送

更新时间： 2024/03/07 13:23:44

NIM SDK 支持 APNs 离线推送功能。

当您的程序在后台被挂起、被系统/用户杀死，或网络异常，NIM SDK 与云信服务端的长连接会因为超时而断开，此时云信服务端会通过 APNs 通道为目标用户发送离线推送的消息。

如果您需要通过云信向 App 发送离线推送，需要先向云信提供 APNs 信息（App ID、证书等），授权云信服务端与 APNs 通信，从而实现离线推送功能。

技术原理

云信 IM 实现离线推送的技术原理如下：

前提条件

已在云信控制台创建应用，获取 App Key。
已注册云信 IM 账号，获取 accid 和 token。
开发环境满足如下要求：
- Flutter-dart 2.17.0 及以上版本
- Xcode 11.0 及以上版本
- iOS 11.0 及以上版本设备
- 项目已设置有效的开发者签名

实现流程

步骤 1：集成 APNs 推送服务

请参考集成 APNs 推送服务，实现云信服务端与 APNs 通信。

步骤 2：集成 NIM SDK

请参考集成 SDK 将 NIM SDK 集成至您的项目。

步骤 3：初始化 NIM SDK

调用 initialize 初始化 NIM SDK。在初始化参数 NIMIOSSDKOptions 中传入推送证书名称（对应云信控制台配置的推送证书）。

final options = Platform.isAndroid
    ? NIMAndroidSDKOptions(
        appKey: 'appkey',
        /// 其他 通用/Android 配置
    )
    : NIMIOSSDKOptions(
        appKey: 'appkey',
        apnsCername: 'apnsCername', //推送证书名
        /// 其他通用配置/iOS 配置
    );
NimCore.instance.initialize(options)
    .then((result){
        if (result.isSuccess) {
            /// 初始化成功
        } else {
            /// 初始化失败
        }
    });

推送证书名称，不超过 32 个字符，否则登录时会报 500 错误。

步骤 4：上传 devicetoken 至云信服务端

在原生层获取 deviceToken，并将 deviceToken 上传到 dart 层。

在 Runner 工程下的 AppDelegate.swift 文件中添加如下代码：

override func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
    
    let flutterData = FlutterStandardTypedData.init(bytes: deviceToken)
    let controller : FlutterViewController = window?.rootViewController as! FlutterViewController
    let methodChannel = FlutterMethodChannel(name: "com.netease.NIM.demo/settings",
                                              binaryMessenger: controller.binaryMessenger)
    methodChannel.invokeMethod("updateAPNsToken", arguments: flutterData)
}

其中 com.netease.NIM.demo/settings 为 methodChannel 名字，客户自己定义即可，但需要同 dart 层保持一致。

在 dart 层注册 methodChannel，并接收原生层上传的 deviceToken。

MethodChannel('com.netease.NIM.demo/settings')
        .setMethodCallHandler((call) async {
    if (call.method == 'updateAPNsToken') {
        print('update APNs token');
        _deviceToken = call.arguments as Uint8List;
    }
    return null;
});

在 dart 层初始化 nim_core 成功之后，调用 updateAPNSToken 方法更新 deviceToken。
```
void updateAPNsToken() {
if (NimCore.instance.isInitialized &&
    Platform.isIOS &&
    _deviceToken != null) {
    NimCore.instance.settingsService.updateAPNSToken(_deviceToken!, null);
    }
}
```
如需设置自定义推送文案（customContentKey），需要提前在控制台开通自定义推送文案功能，并提前添加好自定义的推送文案。具体如何实现，请参见推送文案。

步骤 5：测试离线推送

消息发送方：

发送消息或自定义系统通知给接收方（离线），具体的收发流程可参见消息收发和自定义系统通知。

这里以发送文本消息为例，通过调用 createTextMessage + sendMessage 实现。发送的消息默认需要推送，如需设置推送文案，推送角标，推送文案前缀等，请参见配置消息的推送属性。

MessageBuilder.createTextMessage(sessionId: 'sessionId', sessionType: NIMSessionType.p2p, text: 'text').then((value){
      if(value.isSuccess && value.data != null){
        var message = value.data!;
        message.pushPayload = {"sessionId":"sessionId","sessionType":"p2p"};
        NimCore.instance.messageService.sendMessage(message: message);
      }
    });