深入解析argon/node-apn中的Notification类：构建iOS推送通知-优快云博客

深入解析argon/node-apn中的Notification类：构建iOS推送通知

node-apn 项目地址: https://gitcode.com/gh_mirrors/nod/node-apn

概述

在iOS应用开发中，推送通知是与用户保持联系的重要方式。argon/node-apn项目提供了一个强大的Node.js模块，用于向苹果设备发送推送通知。本文将重点介绍其中的核心组件——apn.Notification类，它负责封装要发送到设备的数据并处理JSON编码。

Notification类基础

apn.Notification类是构建推送通知的核心，它封装了所有必要的数据和配置选项。通过这个类，开发者可以轻松创建符合苹果推送通知服务(APNS)规范的推送内容。

初始化Notification

创建Notification实例时，可以选择传入一个配置对象来预填充属性：

let notification = new apn.Notification({
  alert: "您好，世界！",
  sound: "chime.caf",
  mutableContent: 1,
  payload: {
    "sender": "node-apn",
  },
});

这种方式可以一次性设置多个属性，代码更加简洁。

有效载荷(Payload)详解

推送通知的核心是有效载荷，它决定了通知在设备上的表现形式和行为。

标准payload属性

notification.payload属性是一个对象，会被JSON编码并作为通知的有效载荷发送。当设置了notification.aps属性后，这些值会在发送前被添加到payload中：

let notification = new apn.Notification();
notification.payload = {
  from: "node-apn",
  source: "web",
};
notification.body = "您好，世界！";

输出结果：

{
  "from":"node-apn",
  "source":"web",
  "aps":{
    "alert":"您好，世界！"
  }
}

rawPayload属性

如果需要完全控制有效载荷，可以使用rawPayload属性。设置此属性后，便利设置器将不会影响最终的JSON输出：

let notification = new apn.Notification();
notification.rawPayload = {
  from: "node-apn",
  source: "web",
  aps: {
    "content-available": 1
  }
};

便利设置器(Convenience Setters)

Notification类提供了一系列便利设置器，简化了APNS标准属性的设置。这些设置器实际上是在操作aps对象下的各个属性。

常用设置器示例

let notification = new apn.Notification();

// 设置通知正文
notification.body = "您好，世界！";

// 设置通知标题
notification.title = "node-apn";

// 设置应用角标
notification.badge = 10;

// 使用链式调用
notification.setAction("查看详情")
          .setMutableContent(1);

完整设置器对照表

| 设置器名称 | 目标属性 | 类型 | 说明 | |-------------------|---------------------|---------------------|-------------------------| | alert | aps.alert | 字符串或对象 | 通知内容 | | body | aps.alert.body | 字符串 | 通知正文 | | title | aps.alert.title | 字符串 | 通知标题 | | badge | aps.badge | 数字 | 应用角标数字 | | sound | aps.sound | 字符串 | 播放的声音文件 | | contentAvailable| aps.content-available | 1 | 静默通知标志 | | mutableContent | aps.mutable-content | 1 | 允许通知修改标志 |