小程序websocket心跳库(websocket-heartbeat-miniprogram)


Posted in Javascript onFebruary 23, 2020

前言

在16年的时候因为项目接触到websocket,而后对心跳重连做了一次总结,写了篇博客,而后18年对之前github上的demo代码进行了再次开发和开源,最终封装成库。如下:

github: https://github.com/zimv/websocket-heartbeat-js
npm: https://www.npmjs.com/package/websocket-heartbeat-js

在2020年也就是今年初,同事建议说可以考虑兼容一下小程序,心想也挺好的。便有了今天的 websocket-heartbeat-miniprogram,这次基于以前的代码新建了一个项目,只做小程序的版本,因为涉及到各种小程序以及相关框架的兼容,觉得还是单独出一个包,更专注一点。

介绍

websocket-heartbeat-miniprogram基于小程序的websocket相关API进行封装,主要目的是保障客户端websocket与服务端连接状态。该程序有心跳检测及自动重连机制,当网络断开或者后端服务问题造成客户端websocket断开,程序会自动尝试重新连接直到再次连接成功。兼容市面上大部分小程序微信,百度,支付宝等,只要都是统一的小程序weboscket-API规范。也支持小程序框架比如Taro等。无论如何,业务是需要一层心跳机制的,否则一些情况下会丢失连接导致功能无法使用。

用法

安装

npm install --save websocket-heartbeat-miniprogram

引入使用

import WebsocketHeartbeat from 'websocket-heartbeat-miniprogram';
WebsocketHeartbeat({
  miniprogram: wx,
  connectSocketParams: {
    url: 'ws://xxx'
  }
})
  .then(task => {
    task.onOpen = () => {//钩子函数
      console.log('open');
    };
    task.onClose = () => {//钩子函数
      console.log('close');
    };
    task.onError = e => {//钩子函数
      console.log('onError:', e);
    };
    task.onMessage = data => {//钩子函数
      console.log('onMessage', data);
    };
    task.onReconnect = () => {//钩子函数
      console.log('reconnect...');
    };
    task.socketTask.onOpen(data => {//原生实例注册函数,重连后丢失
      console.log('socketTask open');
    });
    task.socketTask.onMessage(data => {//原生实例注册函数,重连后丢失
      console.log('socketTask data');
    });
  })

本程序内部总是使用小程序connectSocket方法进行socket连接,如果socket断开,本程序内部会再次执行小程序的connectSocket方法,以此来重新建立连接,重连都会建立新的小程序socket实例。

WebsocketHeartbeat方法返回一个promise,返回的task对象是本程序的一个实例,提供了onOpen,onClose,onError,onMessage,onReconnect等钩子函数。也暴露了小程序本身的实例(socketTask),task.socketTask就是小程序connectSocket返回的实例,而task.socketTask是小程序的原生实例,它们通过onXXX方法传递函数进行监听注册,在socket重连以后,内部重新通过connectSocket新建实例,将会返回新的小程序原生实例,因此之前通过socketTask.onXXX注册的这些函数将会丢失。而本程序内部提供的钩子函数重连上以后依然有效。大部分情况下推荐就使用本程序的钩子函数。

支付宝小程序差异

支付宝小程序只允许同时存在一个socket连接,原生的API也和其他小程序有一点小差异,本程序已经做了兼容,但是还是要注意支付宝只允许建立一个socket,如果建立多个socket,前面的socket都会被系统关闭,一定要通过本程序实例的task.close关闭旧的socket,否则程序会一直重连,导致所有socket相互冲突无法使用。

约定

1.只能通过前端主动关闭socket连接

如果需要断开socket,应该执行task.close()方法。如果后端想要关闭socket,应该下发一个消息,前端判断此消息,前端再调用task.close()方法关闭。因为无论是后端调用close还是因为其他原因造成的socket关闭,前端的socket都会触发onClose事件,程序无法判断是什么原因导致的关闭。因此本程序会默认尝试重连。

import WebsocketHeartbeat from 'websocket-heartbeat-miniprogram';
WebsocketHeartbeat({
  miniprogram: wx,
  connectSocketParams: {
    url: 'ws://xxxx'
  }
})
  .then(task => {
    task.onMessage = data => {
      if(data.data == 'close') task.close();//关闭socket并且,不再重连
    };
  })

2.后端对前端心跳的反馈

前端发送心跳消息,后端收到后,需要立刻返回响应消息,后端响应的消息可以是任何值,因为本程序并不处理和判断响应的心跳消息,而只是在收到任何消息后,重置心跳,因为收到任何消息就说明连接是正常的。因此本程序收到任何后端返回的消息都会重置心跳倒计时,以此来减少不必要的请求,减少服务器压力。

API

详情参考: https://github.com/zimv/websocket-heartbeat-miniprogram

结语

程序已经经过单元测试,也在百度,支付宝,微信等小程序之中实际测试和基于Taro测试。程序长期维护,发现兼容问题或者程序问题,希望得到issue反馈!

到此这篇关于小程序websocket心跳库(websocket-heartbeat-miniprogram)的文章就介绍到这了,更多相关小程序websocket心跳库内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!

Javascript 相关文章推荐
jQuery学习笔记 操作jQuery对象 属性处理
Sep 19 Javascript
node.js中的fs.writeFile方法使用说明
Dec 14 Javascript
javascript定时器完整实例
Feb 10 Javascript
js计算系统当前日期是星期几的方法
Jul 14 Javascript
JavaScript实现简易的天数计算器实例【附demo源码下载】
Jan 18 Javascript
JavaScript作用域、闭包、对象与原型链概念及用法实例总结
Aug 20 Javascript
微信小程序实现form表单本地储存数据
Jun 27 Javascript
Vue + Element UI图片上传控件使用详解
Aug 20 Javascript
用jQuery实现抽奖程序
Apr 12 jQuery
JS简易计算器实例讲解
Jun 30 Javascript
JavaScript中CreateTextFile函数
Aug 30 Javascript
微信小程序中使用vant框架的具体步骤
Feb 18 Javascript
webpack.DefinePlugin与cross-env区别详解
Feb 23 #Javascript
深入理解webpack process.env.NODE_ENV配置
Feb 23 #Javascript
微信小程序实现限制用户转发功能的实例代码
Feb 22 #Javascript
vue.js实现简单的计算器功能
Feb 22 #Javascript
Vue.js实现立体计算器
Feb 22 #Javascript
vue实现计算器功能
Feb 22 #Javascript
js实现网页版贪吃蛇游戏
Feb 22 #Javascript
You might like
法兰绒滤网冲泡
2021/03/03 冲泡冲煮
php下通过POST还是GET来传值
2008/06/05 PHP
如何阻止网站被恶意反向代理访问(防网站镜像)
2014/03/18 PHP
PHP实现将HTML5中Canvas图像保存到服务器的方法
2014/11/28 PHP
php语言中使用json的技巧及json的实现代码详解
2015/10/27 PHP
PHP购物车类Cart.class.php定义与用法示例
2016/07/20 PHP
PHP获取当前文件的父目录方法汇总
2016/07/21 PHP
YII框架批量插入数据的方法
2017/03/18 PHP
PHP7扩展开发之基于函数方式使用lib库的方法详解
2018/01/15 PHP
CentOS7.0下安装PHP5.6.30服务的教程详解
2018/09/29 PHP
Code:findPosX 和 findPosY
2006/12/20 Javascript
JavaScript中链式调用之研习
2011/04/07 Javascript
JS.elementGetStyle(element, style)应用示例
2013/09/24 Javascript
基于JQuery实现的Select级联
2014/01/27 Javascript
Node.js中使用计时器定时执行函数详解
2014/08/15 Javascript
基于JS实现弹出一个隐藏的div窗口body页面变成灰色并且不可被编辑
2016/12/14 Javascript
JS实现的五级联动菜单效果完整实例
2017/02/23 Javascript
javascript中的面向对象
2017/03/30 Javascript
详解AngularJS1.6版本中ui-router路由中/#!/的解决方法
2017/05/22 Javascript
JS非空验证及邮箱验证的实例
2017/08/11 Javascript
Node批量爬取头条视频并保存方法
2018/09/20 Javascript
小程序实现可拖动的悬浮按钮
2020/09/07 Javascript
JQuery Ajax如何实现注册检测用户名
2020/09/25 jQuery
[05:08]第一届“网鱼杯”DOTA2比赛精彩集锦
2014/09/05 DOTA
tensorflow输出权重值和偏差的方法
2018/02/10 Python
Python单元和文档测试实例详解
2019/04/11 Python
scrapy-redis源码分析之发送POST请求详解
2019/05/15 Python
python selenium实现发送带附件的邮件代码实例
2019/12/10 Python
Python Tkinter Entry和Text的添加与使用详解
2020/03/04 Python
Monnier Freres中文官网:法国领先的奢侈品配饰在线零售商
2017/11/01 全球购物
运动会稿件300字
2014/02/14 职场文书
医学生就业推荐表自我鉴定
2014/03/26 职场文书
校园主题婚礼活动策划方案
2014/09/15 职场文书
银行自荐信怎么写
2015/03/05 职场文书
小学运动会报道稿
2015/07/22 职场文书
MySQL性能指标TPS+QPS+IOPS压测
2022/08/05 MySQL