light-websocket-client-ts

轻量封装 Websocket 客户端 ts 版

简介

一个基于 Websocket 进行简单封装的轻量协议客户端，需配合 light-websocket-server 使用

1. 连接保活

由于 websocket 的 js API 无法发送 websocket 的 ping 帧，导致只能在应用层协议再实现一遍保活机制，所以在 Websocket 数据帧首部分出一个字节作为协议头，实现了相对 websocket 协议更上层，但是相对应用层更下层的保活机制

2. 自动重连

• 自动重连默认开启，可以通过 Options 来进一步控制
• 客户端主动调用 disconnect() 关闭连接会禁用自动重连，直到重新调用 connect()
• 自动重连采用退避超时策略，可以通过 Options 来进一步控制
• 收到来自服务端的 Kickoff 报文也会禁止重连

快速开始

浏览器

• 安装依赖

1$ npm install light-websocket-client-ts --saved

• 创建连接

1import {LightWebsocketClientImpl} from 'light-websocket-client-ts';
2
3const client = new LightWebsocketClientImpl('ws://xxx/xxx');
4client.onDisconnect(onDisconnect);
5client.onConnect(onConnect);
6client.onMessage(onMessage);
7
8client.connect();
9
10function onConnect() {
11}
12
13function onDisconnect() {
14    //每次连接丢失都会回调
15}
16
17function onMessage(message: string) {
18}

Node.js 端

• 安装依赖

1$ npm install light-websocket-client-ts --saved
2$ npm install ws --saved

• 创建 Node.js ws 实现

1import {LightWebsocketClientImpl} from 'light-websocket-client-ts';
2import * as Websocket from 'ws';
3
4export class LightWebsocketCLientNodeImpl extends LightWebsocketClientImpl {
5
6    createWebsocket(url: string, protocols?: string[] | undefined): any {
7        return new Websocket(url, protocols, {});
8    }
9}

• 使用 Node.js 实现创建连接

1const client = new LightWebsocketCLientNodeImpl('ws://xxx/xxx');
2client.onDisconnect(onDisconnect);
3client.onConnect(onConnect);
4client.onMessage(onMessage);
5
6client.connect();
7
8function onConnect() {
9}
10
11function onDisconnect() {
12    //每次连接丢失都会回调
13}
14
15function onMessage(message: string) {
16}