ReconnectingWebSocket 技术文档

ReconnectingWebSocket 技术文档

reconnecting-websocket A small decorator for the JavaScript WebSocket API that automatically reconnects 项目地址: https://gitcode.com/gh_mirrors/re/reconnecting-websocket

ReconnectingWebSocket 是一个轻量级的 JavaScript 库，它为标准的 WebSocket API 添加了自动重连的功能，确保网络波动时连接不会永久中断。当 WebSocket 连接断开时，这个库会自动尝试重新建立连接，直到成功为止。

安装指南

ReconnectingWebSocket 的使用非常简单，无需复杂的安装步骤。你可以通过以下几种方式获取库文件：

1. 直接下载: 访问项目仓库 GitHub 页面，找到 Release 区域，下载最新版本的压缩文件。

2. npm 安装（如果你的项目支持 npm）:

   npm install reconnecting-websocket
   

   或者，对于 Yarn 用户：

   yarn add reconnecting-websocket
   

   然后，在你的代码中通过模块导入使用：

   import ReconnectingWebSocket from 'reconnecting-websocket';
   

3. CDN: 在浏览器环境中，可以通过 CDN 直接引入：

   <script src="https://cdn.jsdelivr.net/npm/reconnecting-websocket@latest/dist/reconnecting-websocket.min.js"></script>
   

项目使用说明

基本使用

替换标准 WebSocket 的实例化，使用 ReconnectingWebSocket 如下：

var ws = new ReconnectingWebSocket('ws://your-websocket-url');

监听事件

如同普通的 WebSocket，你可以监听 onopen, onmessage, onerror, 和 onclose 事件，但不必担心手动处理重连逻辑。

参数传递

在创建 ReconnectingWebSocket 实例时，可以指定协议、URL，以及一系列可选的配置选项：

var ws = new ReconnectingWebSocket('ws://your-websocket-endpoint', ['your-protocol'], {
  debug: true,
  reconnectInterval: 3000,
});

项目API使用文档

属性与选项

• debug: 设置为 true 可开启调试信息打印至 console.debug()，默认为 false。
• automaticOpen: 默认 true，控制实例是否立即尝试连接。
• reconnectInterval: 初始重连间隔时间，默认为 1000 毫秒。
• maxReconnectInterval: 重连间隔的最大值，默认 30000 毫秒。
• reconnectDecay: 重连间隔增长比率，默认为 1.5。
• timeoutInterval: 超时时长，超过该时间未成功建立连接则重试，默认为 2000 毫秒。
• maxReconnectAttempts: 最大重连次数，设为 null 表示无限次重连。
• binaryType: 控制接收数据类型，默认为 'blob'，可选 'arraybuffer'。

方法

• ws.open(): 显式打开连接。
• ws.close([code], [reason]): 关闭连接，code 和 reason 分别是关闭码和原因，按需提供。
• ws.refresh(): 若连接已打开，则先关闭再重新建立连接。
• ws.send(data): 发送数据到服务器，支持字符串、ArrayBuffer 或 Blob 类型的数据。

总结

ReconnectingWebSocket 提供了一个简单且强大的方案来增强 WebSocket 的可用性，特别是在不可预测的网络环境下。遵循上述指南，你可以轻松集成并优化你的实时应用，确保用户体验的连续性和稳定性。

reconnecting-websocket A small decorator for the JavaScript WebSocket API that automatically reconnects 项目地址: https://gitcode.com/gh_mirrors/re/reconnecting-websocket