quickstart.md 6.9 KB

普通业务推送:原生通道部署与回退

状态(2026-09-29):服务端具备 FCM/APNs 路由能力,默认 uni,尚未启用原生推送。本功能不处理音视频通话,也不包含 App 端 token 获取、上报和展示改造;未完成真机验证前不要切换生产环境。

配置与凭据

三端真实凭据已按用户明确要求提交在 ruoyi-admin/src/main/resources/business-push/,并随 JAR 打包;每端只保留一份普通 APNs .p12,开发/正式只切换网关。任何能读取 Git 历史、JAR 或包含资源的镜像的人都能取得服务账号私钥与证书密码。须限制仓库及构建产物访问,不把密钥内容写入日志或公开分发;如发生泄露,应轮换 Firebase 服务账号与 APNs 证书,并重新构建发布。

接收端 FCM 服务账号 APNs 普通证书 APNs topic/密码配置
用户 user-fcm-service-account.json user-apns.p12 user-apns-config.json
商家(含夜市及分管账号) merchant-fcm-service-account.json merchant-apns.p12 merchant-apns-config.json
骑手 rider-fcm-service-account.json rider-apns.p12 rider-apns-config.json

APNs配置JSON原文件的packetName/pwd分别提供topic和证书密码;2026-10-26按用户要求已将这些既有值直接固定到application.yml,各端路径也固定为自身classpath资源。不生成或重设证书密码。三端Firebase项目分别对应各自App,不共享server.json,不使用VoIP证书。

设置 本地配置项 当前值/要求
通道 business-push.mode 固定uni;如启用native直接改YAML并重启
APNs环境 business-push.apns-environment 固定production;TestFlight/App Store均用正式环境
三端FCM路径 apps.{user/merchant/rider}.fcm-credentials-path 固定各端classpath JSON
三端APNs路径 apps.{user/merchant/rider}.apns-certificate-path 固定各端classpath .p12
三端配套JSON路径 apps.{user/merchant/rider}.apns-config-path 固定各端classpath配套JSON
三端密码/topic apps.{user/merchant/rider}.apns-certificate-password/apns-topic YAML固定值来自各自JSON,非服务端自行生成

不再通过BUSINESS_PUSH系列环境变量修改配置;直接维护YAML。两项APNs值均固定后,发送器优先使用YAML,无需再从JSON补空值;未来更换证书时须同步更新YAML中的密码/topic,只改JSON不会覆盖这些固定值。uni模式不初始化业务原生凭据;native模式启动时校验三端并加载资源,缺失/不可读/无私钥/过期会失败。匿名测试仍按需初始化所选端。

development/production分别对应sandbox/正式网关,当前固定production;匿名测试始终走正式网关。已核对三端packetName与证书主题相符,但外部真实投递仍须真机验证。三端证书到期日为2027-07-30;改配置或资源后重新构建部署JAR并验证,不通过重新生成密码解决BadDeviceToken。

启用前条件

  1. App 端分别上报真实的 Android FCM token 或 iOS APNs device token 至 info_user.deviceToken,并把 cidType 设置为 android 或 ios;cid 只用于 uniPush,不能复制到 deviceToken。本次交付不实现 App 端上报。
  2. 确认新手机登录后旧手机会话失效,数据库中账号只保留当前设备 token;原生发送时服务端重新读取该账号的当前 cidType/deviceToken。
  3. 在非生产环境确认私有 JAR 包含九个按端命名的资源,设置对应 APNs 环境与 BUSINESS_PUSH_MODE=native 并重启。先检查服务启动,再用三端 Android/iOS 各一台真机触发订单、闪送和支付通知;核对通知栏、点击 payload、消息中心、语言与接收人。iOS 骑手使用 pushsound.caf;Android 骑手 FCM 带 qsRing 通知渠道标识,须由 App 创建并配置该渠道才能保证自定义铃声,本次不修改 App。门店订单有可用分管账号时只通知分管账号,没有时才回退主账号。
  4. 重点覆盖 CID 为空而原生 token 有效、token 缺失/失效、账号换机、预约闪送进入可抢单窗口,以及发送失败但业务操作成功。某条原生通知失败时不会自动回退 uniPush;原路径已有的消息中心记录应保持一次。

切换与回退

生产切换须先完成 App 端配套和真机验收。使用包含上述资源的受控构建,将 BUSINESS_PUSH_MODE 设为 native,按实例逐一重启并检查启动及推送错误日志;一条通知只会选择当前实例的一个通道,滚动重启期间不同实例可能短暂处于不同模式。若原生投递异常,改回 BUSINESS_PUSH_MODE=uni 并逐一重启;之后的新通知重新使用 cid,已失败的通知不会由服务端自动补发。回退时确认 App 仍维护有效的 uniPush CID。

自动化测试验证三端 classpath 凭据可加载、路由、请求构造和错误隔离;真实设备 token、FCM/APNs 外部投递、通知展示与回退操作仍需部署环境验证。

ApiPost 原生推送测试(业务模式无需切换)

常驻接口 POST /system/push/testNative 允许匿名访问,Content-Type: application/json,无需账号 ID 或后台 token。即使 BUSINESS_PUSH_MODE 保持默认 uni,该接口仍直接调用原生通道;Android 使用所选端的 FCM 项目,iOS 固定走 APNs 正式网关。请求示例:

{
  "appType": "rider",
  "platform": "android",
  "deviceToken": "手机取得的原生 FCM 或 APNs Token",
  "title": "原生推送测试",
  "content": "请检查手机通知栏",
  "payload": "{}"
}

appType 可填 user、merchant、rider;platform 可填 android、ios。测试 iOS 时改为 ios 并传正式包取得的 64 位十六进制 APNs token;开发包的 sandbox token 不能用于这个正式网关。payload 可省略。响应 code=200 只表示 FCM/APNs 接受发送请求,不证明手机通知栏已显示;失败时 code=500 和 msg 返回不含 token 的错误类别。需在真机核对通知权限、前台展示与通知栏,不调用业务订单流程,也不写入 push_message。

该接口按需求长期匿名开放,公网部署后任何知道地址的人都可以使用服务端凭据向其掌握的设备 Token 发送消息,可能造成滥用和推送配额消耗;如不接受此风险,应在网关限制可访问来源或后续改为鉴权接口。

外卖和闪送新单通知附近最多 20 名骑手时,native 模式会按骑手当前设备类型分流:Android 骑手按相同语言文案和订单 payload 使用骑手端 FCM multicast,逐 token 处理返回结果;iOS 骑手继续逐设备走 APNs。每位骑手的消息中心事件保持独立,批量失败不回退 uniPush。默认 uni 模式及其逐骑手新单通知完全不变,旧的 uni 批量方法未接入此流程。