-
Notifications
You must be signed in to change notification settings - Fork 0
/
VSocket.js
321 lines (287 loc) · 8.04 KB
/
VSocket.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
function VSocket() {
/**
* 连接实例
* @param {WebSocket}
*/
this._socket = undefined
/**
* 事件处理器,那一系列 on 和 off 方法最终都会在这个属性里体现
* @type {Object<string, Array>}
*/
this._events = {}
/**
* 断线重连次数
* @type {number}
*/
this._reconnectCount = 5
/**
* 是否已连接
* @type {boolean}
*/
this.connected = false
/**
* 心跳间隔,毫秒
* @type {number}
*/
this._heartbeatInterval = 10000
/**
* 获取连接配置的方法
* 通过外部赋值一个方法的方式,用于登录及断开连接重试
* 返回一个object {server, appid, password}
* 支持 async 方法
* @type {function}
*/
this.getConnectConfig = undefined
}
let reconnected = 0
let timeout = undefined
function reconnect(data, instance) {
// 如果获取配置的方法没有赋值就不需要重试了
if (typeof instance.getConnectConfig !== 'function') {
instance.connected = false
return
}
// 超时超过次数
if (reconnected >= instance._reconnectCount) {
instance.connected = false
return
}
const second = 3
clearTimeout(timeout)
console.warn(`连接断开,将在 ${second} 秒后重试`)
timeout = setTimeout(async () => {
await instance.login()
reconnected++
}, second * 1000)
}
/**
* 登录成功事件名
* @type {string}
*/
VSocket.EVENT_LOGIN_SUCCESS = 'LOGON'
/**
* 接收到新消息的事件名
* @type {string}
*/
VSocket.EVENT_RECEIVE = 'RECEIVED'
/**
* 连接断开的事件名
* @type {string}
*/
VSocket.EVENT_DISCONNECT = 'CLOSED'
/**
* 连接失败的事件名
* @type {string}
*/
VSocket.EVENT_CONNECT_FAIL = 'CONNECT_FAIL'
VSocket.prototype = {
constructor: VSocket,
/**
* 初始化
* @param {string} server 服务地址
* @returns {Promise}
*/
init(server) {
return new Promise(next => {
this.connected = false
this._socket = new WebSocket(server)
this._socket.onmessage = res => {
try {
let data = JSON.parse(res.data || '{}')
this._trigger(data.type, data.message)
} catch (e) {
console.error("错误的消息格式:")
console.error(res.data)
}
}
this._socket.onopen = () => {
this.connected = true
next()
}
this._socket.onclose = res => {
// 如果之前连接成功,则触发断开,否则触发连接失败
if (this.connected) {
this._trigger(this.constructor.EVENT_DISCONNECT, res)
} else {
this._trigger(this.constructor.EVENT_CONNECT_FAIL, res)
}
next()
}
this.offDisconnect(reconnect)
this.onDisconnect(reconnect)
})
},
/**
* 主动断开连接
* 断开成功会触发 EVENT_DISCONNECT 事件
*/
close() {
if (this.connected) {
this._socket.close()
}
},
/**
* 定时发送心跳包
*/
heartbeat() {
clearInterval(this.interval)
this.interval = setInterval(() => {
if (this.connected) {
this._socket.send(JSON.stringify({
action: "Heartbeat"
}))
}
}, this._heartbeatInterval)
},
/**
* 获取心跳包间隔时长,毫秒
* @returns {number}
*/
getHeartbeatInterval() {
return this._heartbeatInterval
},
/**
* 设置心跳包间隔时长,毫秒
* @param millisecond {number}
*/
setHeartbeatInterval(millisecond) {
this._heartbeatInterval = millisecond
},
/**
* 登录
* 该方法只能在 init 方法完成后调用,否则报错
* @param {string} server 服务地址
* @param {string} appid 应用ID
* @param {string} password 密码
*/
async login(server = "", appid= "", password= "") {
if (!server) {
let config = this.getConnectConfig()
if (config instanceof Promise) {
config = await config
}
if (typeof config === 'object' && config['server'] && config['appid'] && config['password']) {
server = config['server']
appid = config['appid']
password = config['password']
}
}
await this.init(server)
this._socket.send(JSON.stringify({
action: 'login',
data: {
appid,
password,
}
}))
},
/**
* 设置断线重连次数
* @param count
*/
setReconnectCount(count) {
this._reconnectCount = count
},
/**
* 获取断线重连次数
* @returns {number}
*/
getReconnectCount() {
return this._reconnectCount
},
/**
* 添加事件监听
* @param {string} eventName
* @param {function} callback
*/
_on(eventName, callback) {
if (!Array.isArray(this._events[eventName])) {
this._events[eventName] = [];
}
this._events[eventName].push(callback)
},
/**
* 移除事件监听
* @param {string} eventName
* @param {function|null} callback 传入一个函数,将只移除对应的监听器,否则移除该事件的全部监听器
*/
_off(eventName, callback = null) {
if (callback === null) {
delete this._events[eventName]
return
}
for (let index in (this._events[eventName] || [])) {
if (callback === this._events[eventName][index]) {
this._events[eventName].splice(index, 1)
}
}
},
/**
* 触发事件
* @param {string} eventName
* @param data
*/
_trigger(eventName, data) {
for (let handler of this._events[eventName] || []) {
handler(data, this)
}
},
/**
* 登录成功事件
* @param {function} callback
*/
onLoginSuccess(callback) {
reconnected = 0
this._on(this.constructor.EVENT_LOGIN_SUCCESS, callback)
},
/**
* 移除登录成功事件监听
* @param {function|null} callback 传入一个函数,将只移除对应的监听器,否则移除该事件的全部监听器
*/
offLoginSuccess(callback = null) {
this._off(this.constructor.EVENT_LOGIN_SUCCESS, callback)
},
/**
* 接收消息事件
* @param {function} callback
*/
onReceive(callback) {
this._on(this.constructor.EVENT_RECEIVE, callback)
},
/**
* 移除新消息事件监听
* @param {function|null} callback 传入一个函数,将只移除对应的监听器,否则移除该事件的全部监听器
*/
offReceive(callback = null) {
this._off(this.constructor.EVENT_RECEIVE, callback)
},
/**
* 连接断开事件
* @param {function} callback
*/
onDisconnect(callback) {
this._on(this.constructor.EVENT_DISCONNECT, callback)
},
/**
* 移除连接断开事件监听
* @param {function|null} callback 传入一个函数,将只移除对应的监听器,否则移除该事件的全部监听器
*/
offDisconnect(callback = null) {
this._off(this.constructor.EVENT_DISCONNECT, callback)
},
/**
* 连接失败事件
* @param {function} callback
*/
onConnectFail(callback) {
this._on(this.constructor.EVENT_CONNECT_FAIL, callback)
},
/**
* 移除连接失败事件监听
* @param {function|null} callback 传入一个函数,将只移除对应的监听器,否则移除该事件的全部监听器
*/
offConnectFail(callback = null) {
this._off(this.constructor.EVENT_CONNECT_FAIL, callback)
},
}
export default VSocket