雷鳴 websocket.jsWebSocket 工具類

websocket.js 是 WEB 端 WebSocket 工具類

1. 功能介紹

1.1 斷線重連

• 正常掛著時，斷線自動重連
• 發(fā)送消息時，斷線自動重連，并將之前的消息在連接成功后發(fā)送

1.2 心跳內(nèi)置

• 自動發(fā)送心跳消息
• 用 onmessage 接收消息時會自動過濾掉心跳消息，也就是服務(wù)端的心跳消息不會進(jìn)入到重寫的 onmessage 方法

2. 代碼使用

2.1 引入js

<script src="https://gitee.com/mail_osc/websocket.js/raw/master/websocket.js"></script>

2.2 代碼

websocket.connect({
	url:'wss://api.kefu.leimingyun.com/websocket', //服務(wù)端的WebSocket地址
	onopen:function(){ //如果不需要，此不傳即可。
		websocket.send({"type":"CONNECT","token":"123456"}); //當(dāng)WebSocket通道連接成功后，自動給服務(wù)器發(fā)送一條json格式的消息
	},
	onmessage:function(message){ //如果不需要，此不傳即可
		console.log(message); //服務(wù)端發(fā)送來的消息會在這里接收到
	}
});

3.流程圖示

4. 接口說明

4.1 websocket.send(...) 向服務(wù)端發(fā)消息

其中的參數(shù)可以是string格式，也可以是json格式，自動識別。建議json格式

4.2 websocket.heartBeat.text 心跳消息內(nèi)容

可自定義向服務(wù)端發(fā)送心跳消息的內(nèi)容。默認(rèn)值為： {"type":"HEARTBEAT","text":"AreYouThere"}
設(shè)置方式如：

websocket.heartBeat.text = '{"type":"HEARTBEAT","text":"AreYouThere"}';

4.3 websocket.heartBeat.time 心跳消息間隔時間

可自定義向服務(wù)端發(fā)送心跳消息的間隔時間，單位是秒，每間隔多少秒自動給服務(wù)端發(fā)送一條心跳消息。默認(rèn)值是40，也就是40秒。
設(shè)置方式如：

websocket.heartBeat.time = 40;

4.4 websocket.ws JS本身的WebSocket對象

可直接使用 websocket.ws 來獲取其JS本身的WebSocket對象來進(jìn)行更多使用

5. 關(guān)于我們

作者：管雷鳴