socket.io-push-redis

redis operation for socket.io-push, include adapter, emitter, read/write


Keywords
redis, socket.io-push, android, apn, apns, huawei, notifications, push, push-notifications, xiaomi
License
ISC
Install
npm install socket.io-push-redis@1.0.6

Documentation

socket.io-push Build Status Coverage Status

整合了小米,华为,友盟,苹果推送的统一解决方案

更有应用内超低延迟顺序(生产环境平均200MS以下)透传功能,支持websocket

白板

广播可支持同频道10w以上在线,每台前端(proxy)可支持5W以上长连接(取决于你的推送量)

notification

16年1月上线运行,目前已经非常稳定,功能完善,我司有数款APP在使用,其中一个日活在500W以上

视频介绍

NPM

为什么做这个东西?

我们Java后端开发,以提供HTTP API的方式,做了几个简单的增删改查式的APP,但是在开发一款直播类APP的时候遇到了问题

  • 直播间内的公屏,礼物广播,如何以最低延迟发给直播间内的用户?
  • 频道里都有谁在线? 都是哪些人?
  • 主播断线,或者与主播连麦的人断线了,如何知晓?
  • 如何推送离线系统通知(IOS,Android,小米,华为)?

参考其他一些团队的解决方案,大多是用c++写长连接服务器,甚至用Java的netty。开发维护成本太高,所以就有了这套推送系统,我们服务器依旧使用HTTP提供服务,下行推送,也只需要调用一个简单的HTTP接口,如 http://localhost:11001/api/push?topic=abc&json=hello 向abc这个直播间发送一条透传。

特点

  • 厂商通道: 透明集成了小米, 华为push,第三方推送由于政策问题,无法做到
  • 非厂商通道: 友盟推送 + socket.io 双通道客户端sdk去重, 可以享受友盟号称上万APP互相拉起, 大概可以增加非厂商通道50%以上送达率
  • IOS推送实现了可以部署代理节点, 可以通过国内专线->香港->苹果服务器, 极大提升成功率和吞吐能力
  • 支持浏览器, 微信小程序, Unity3D (完成度很低)
  • 与业务服务同机房部署,第三方服务无法比拟

性能

  • 目前使用的最高日活的一款APP有350W日活, 评估目前架构至少可以支持千万日活APP
  • 可以部署70台(实测)或者更多机器, 支持百万以上同时在线
  • 单机广播速度可以达到10W条/秒,如果只使用系统通知功能,单机支撑一个10W左右日活的APP,平均1W以上同时在线,几乎不占机器负载
  • 从推送接口调用,到客户端收到回包给服务器,RTT只有280m(线上平均延迟)

更新日志

  • 0.9.14 api增加删除设备的接口
  • 0.9.13 支持按uid,pushId查询推送送达率
  • 0.9.12 支持谷歌的fcm推送
  • 0.9.11 去掉apiRouter中的buffer机制,避免拥堵延迟
  • 0.9.10 更新调用华为新版接口(华为开发者后台需要配置apk的sha256指纹)
  • 0.9.9 修复自动重启进程的问题,更新node-apn版本
  • 0.9.7 修正小米notify_foreground配置未生效
  • 0.9.6 修正 push uid ttl未生效
  • 0.9.5 修正notificationBuffer删错方向bug
  • 0.9.4 修正demo后台bug
  • 0.9.3 notfication加个type用于统计
  • 0.9.3 删除redis-adapter一个指数级的调用
  • 0.9.1 重构redis-adapter,优化批量推送大量uid的性能
  • 0.8.97 接口支持post100mb以上数据

基本功能和实现原理

1. push (在线透传)

目标:
  • pushId: 对某个设备

  • topic: 已经订阅了某topic的设备列表,订阅关系在redis和socket.io实例里保存,如socket.io服务重启,会丢失,客户端重连上来会自动重新订阅建立关系

  • uid: 已绑定的设备列表,设备连接后读一次数据库,然后此关系以topic的方式实现

    实现原理:
      使用socket.io通道,只针对当时在线,也可以通过制定timeToLive参数实现重传, 无论push给任何目标,只有一次redis pub操作,不走数据库,可靠性,速度非常高
    

2. notification(手机系统通知栏)

目标:
  • pushId: 对某个设备
  • uid: 已绑定的设备列表
  • tags: 绑定了某tag的设备列表,存储在数据库持久化
  • pushAll: 推送所有设备
实现原理:

无论给哪个目标发,都要查一次mongodb,用于确定目标设备的类型和token。

  • ios设备,走苹果apn推送。
  • 小米和华为,走该厂商通道。
  • 其它设备(安卓或者浏览器等),走socket.io push通道。 如有上报umeng token,会调用友盟推送再发一次。安卓客户端有可能收到两次,SDK层做去重保证手机只弹出一次。

Quick Start

高级功能文档

相关文章

Q&A

  • 相比第三方推送有什么优劣?

优势:

  1. 同机房调用, 成功率100% vs 第三方 99.2%(我们调用小米接口成功率) 99.6%(我们调用华为接口成功率)
  2. 测试,正式环境,可以分开部署, 完全隔离
  3. 支持苹果推送多bundleId, 开发,发布,马甲版, 都可以自动匹配推送
  4. 苹果推送进程可以独立部署在香港/国外

劣势

  1. 需要自己运维部署服务器
  2. 如果需要扩容, 需要自己来评估, 第三方推送通常是给钱就可以了 =======

名词

  • push-server 推送服务器, 提供客户端长连接, http api接口
  • 业务服务器 push-server api的调用方
  • 客户端 业务app服务器
  • 长连接 客户端到push-server之间的socket.io连接
  • notification 发送通知栏消息, ios走apns通道, 华为,小米走厂商通道(如配置开启), 浏览器/android手机走长连接
  • push 协议透传, 走长连接通道. app主进程存活的时候才能收到.主要应用场景如直播间聊天,送礼物,股价实时推送
  • topic 服务器push广播的对象,类似于直播间/频道的概念, 客户端进入某直播间(id=001)后(topic="room001"),业务服务器可以向此topic发聊天push,subscribe了这个topic的客户端即可收到push
  • pushId 某个设备的唯一标识, app安装后生成的随机字符串, 用于服务器单播
  • uid 业务服务器用于标识某个用户的id,字符串类型.可以通过push-server的接口进行绑定,通过客户端SDK解除绑定
  • timeToLive 过期时间