generated from wyy-go/go-cli-template
-
Notifications
You must be signed in to change notification settings - Fork 2
/
wsc.go
407 lines (371 loc) · 9.11 KB
/
wsc.go
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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
package wsc
import (
"errors"
"github.com/gorilla/websocket"
"github.com/jpillora/backoff"
"github.com/panjf2000/ants/v2"
"math/rand"
"net/http"
"sync"
"time"
)
var (
CloseErr = errors.New("connection closed")
BufferErr = errors.New("message buffer is full")
)
type Wsc struct {
// 配置信息
Config *Config
// 底层WebSocket
WebSocket *WebSocket
// 连接成功回调
onConnected func()
// 连接异常回调,在准备进行连接的过程中发生异常时触发
onConnectError func(err error)
// 连接断开回调,网络异常,服务端掉线等情况时触发
onDisconnected func(err error)
// 连接关闭回调,服务端发起关闭信号或客户端主动关闭时触发
onClose func(code int, text string)
// 发送Text消息成功回调
onTextMessageSent func(message string)
// 发送Binary消息成功回调
onBinaryMessageSent func(data []byte)
// 发送消息异常回调
onSentError func(err error)
// 接受到Ping消息回调
onPingReceived func(appData string)
// 接受到Pong消息回调
onPongReceived func(appData string)
// 接受到Text消息回调
onTextMessageReceived func(message string)
// 接受到Binary消息回调
onBinaryMessageReceived func(data []byte)
// 心跳
onKeepalive func()
}
type Config struct {
// 写超时
WriteWait time.Duration
// 支持接受的消息最大长度,默认512字节
MaxMessageSize int64
// 最小重连时间间隔
MinRecTime time.Duration
// 最大重连时间间隔
MaxRecTime time.Duration
// 每次重连失败继续重连的时间间隔递增的乘数因子,递增到最大重连时间间隔为止
RecFactor float64
// 消息发送缓冲池大小,默认256
MessageBufferSize int
// 心跳包时间间隔
KeepaliveTime time.Duration
// 允许断线重连
EnableReconnect bool
}
type WebSocket struct {
// 连接url
Url string
Conn *websocket.Conn
Dialer *websocket.Dialer
RequestHeader http.Header
HttpResponse *http.Response
// 是否已连接
isConnected bool
// 加锁避免重复关闭管道
connMu *sync.RWMutex
// 发送消息锁
sendMu *sync.Mutex
// 发送消息缓冲池
sendChan chan *wsMsg
// 连接上
connected chan struct{}
}
type wsMsg struct {
t int
msg []byte
}
// New 创建一个Wsc客户端
func New(url string) *Wsc {
return &Wsc{
Config: &Config{
WriteWait: 10 * time.Second,
MaxMessageSize: 10 * 1024 * 1024,
MinRecTime: 2 * time.Second,
MaxRecTime: 60 * time.Second,
RecFactor: 1.5,
MessageBufferSize: 256,
KeepaliveTime: 40,
EnableReconnect: true,
},
WebSocket: &WebSocket{
Url: url,
Dialer: websocket.DefaultDialer,
RequestHeader: http.Header{},
isConnected: false,
connMu: &sync.RWMutex{},
sendMu: &sync.Mutex{},
},
}
}
func (wsc *Wsc) SetConfig(config *Config) {
wsc.Config = config
}
func (wsc *Wsc) OnConnected(f func()) {
wsc.onConnected = f
}
func (wsc *Wsc) OnConnectError(f func(err error)) {
wsc.onConnectError = f
}
func (wsc *Wsc) OnDisconnected(f func(err error)) {
wsc.onDisconnected = f
}
func (wsc *Wsc) OnClose(f func(code int, text string)) {
wsc.onClose = f
}
func (wsc *Wsc) OnTextMessageSent(f func(message string)) {
wsc.onTextMessageSent = f
}
func (wsc *Wsc) OnBinaryMessageSent(f func(data []byte)) {
wsc.onBinaryMessageSent = f
}
func (wsc *Wsc) OnSentError(f func(err error)) {
wsc.onSentError = f
}
func (wsc *Wsc) OnPingReceived(f func(appData string)) {
wsc.onPingReceived = f
}
func (wsc *Wsc) OnPongReceived(f func(appData string)) {
wsc.onPongReceived = f
}
func (wsc *Wsc) OnTextMessageReceived(f func(message string)) {
wsc.onTextMessageReceived = f
}
func (wsc *Wsc) OnBinaryMessageReceived(f func(data []byte)) {
wsc.onBinaryMessageReceived = f
}
func (wsc *Wsc) OnKeepalive(f func()) {
wsc.onKeepalive = f
}
// IsConnected 返回连接状态
func (wsc *Wsc) IsConnected() bool {
wsc.WebSocket.connMu.RLock()
defer wsc.WebSocket.connMu.RUnlock()
return wsc.WebSocket.isConnected
}
// Connect 发起连接
func (wsc *Wsc) Connect() {
wsc.WebSocket.sendChan = make(chan *wsMsg, wsc.Config.MessageBufferSize) // 缓冲
b := &backoff.Backoff{
Min: wsc.Config.MinRecTime,
Max: wsc.Config.MaxRecTime,
Factor: wsc.Config.RecFactor,
Jitter: true,
}
rand.Seed(time.Now().UTC().UnixNano())
for {
var err error
nextRec := b.Duration()
wsc.WebSocket.Conn, wsc.WebSocket.HttpResponse, err =
wsc.WebSocket.Dialer.Dial(wsc.WebSocket.Url, wsc.WebSocket.RequestHeader)
if err != nil {
if wsc.onConnectError != nil {
wsc.onConnectError(err)
}
// 重试
time.Sleep(nextRec)
continue
}
// 变更连接状态
wsc.WebSocket.connMu.Lock()
wsc.WebSocket.isConnected = true
wsc.WebSocket.connMu.Unlock()
// 连接成功回调
if wsc.onConnected != nil {
wsc.onConnected()
}
// 设置支持接受的消息最大长度
wsc.WebSocket.Conn.SetReadLimit(wsc.Config.MaxMessageSize)
// 收到连接关闭信号回调
defaultCloseHandler := wsc.WebSocket.Conn.CloseHandler()
wsc.WebSocket.Conn.SetCloseHandler(func(code int, text string) error {
result := defaultCloseHandler(code, text)
wsc.clean()
if wsc.onClose != nil {
wsc.onClose(code, text)
}
return result
})
// 收到ping回调
defaultPingHandler := wsc.WebSocket.Conn.PingHandler()
wsc.WebSocket.Conn.SetPingHandler(func(appData string) error {
if wsc.onPingReceived != nil {
wsc.onPingReceived(appData)
}
return defaultPingHandler(appData)
})
// 收到pong回调
defaultPongHandler := wsc.WebSocket.Conn.PongHandler()
wsc.WebSocket.Conn.SetPongHandler(func(appData string) error {
if wsc.onPongReceived != nil {
wsc.onPongReceived(appData)
}
return defaultPongHandler(appData)
})
// 开启协程读
_ = ants.Submit(func() {
wsc.writeLoop()
})
// 开启协程写
_ = ants.Submit(func() {
wsc.readLoop()
})
return
}
}
// readLoop 消息读取
func (wsc *Wsc) readLoop() {
for {
messageType, message, err := wsc.WebSocket.Conn.ReadMessage()
if err != nil {
// 异常断线重连
if wsc.onDisconnected != nil {
wsc.onDisconnected(err)
}
wsc.closeAndRecConn()
return
}
switch messageType {
// 收到TextMessage回调
case websocket.TextMessage:
if wsc.onTextMessageReceived != nil {
wsc.onTextMessageReceived(string(message))
}
break
// 收到BinaryMessage回调
case websocket.BinaryMessage:
if wsc.onBinaryMessageReceived != nil {
wsc.onBinaryMessageReceived(message)
}
break
}
}
}
// writeLoop 消息发送
func (wsc *Wsc) writeLoop() {
keepaliveTick := time.NewTicker(wsc.Config.KeepaliveTime * time.Second)
for {
select {
case wsMsg, ok := <-wsc.WebSocket.sendChan:
if !ok {
return
}
err := wsc.send(wsMsg.t, wsMsg.msg)
if err != nil {
if wsc.onSentError != nil {
wsc.onSentError(err)
}
continue
}
switch wsMsg.t {
case websocket.CloseMessage:
return
case websocket.TextMessage:
if wsc.onTextMessageSent != nil {
wsc.onTextMessageSent(string(wsMsg.msg))
}
break
case websocket.BinaryMessage:
if wsc.onBinaryMessageSent != nil {
wsc.onBinaryMessageSent(wsMsg.msg)
}
break
}
case <-keepaliveTick.C:
if wsc.onKeepalive != nil {
wsc.onKeepalive()
}
}
}
}
// SendTextMessage 发送TextMessage消息
func (wsc *Wsc) SendTextMessage(message string) error {
if !wsc.IsConnected() {
return CloseErr
}
// 丢入缓冲通道处理
select {
case wsc.WebSocket.sendChan <- &wsMsg{
t: websocket.TextMessage,
msg: []byte(message),
}:
default:
return BufferErr
}
return nil
}
// SendBinaryMessage 发送BinaryMessage消息
func (wsc *Wsc) SendBinaryMessage(data []byte) error {
if !wsc.IsConnected() {
return CloseErr
}
// 丢入缓冲通道处理
select {
case wsc.WebSocket.sendChan <- &wsMsg{
t: websocket.BinaryMessage,
msg: data,
}:
default:
return BufferErr
}
return nil
}
// send 发送消息到连接端
func (wsc *Wsc) send(messageType int, data []byte) error {
wsc.WebSocket.sendMu.Lock()
defer wsc.WebSocket.sendMu.Unlock()
if !wsc.IsConnected() {
return CloseErr
}
var err error
// 超时时间
_ = wsc.WebSocket.Conn.SetWriteDeadline(time.Now().Add(wsc.Config.WriteWait))
err = wsc.WebSocket.Conn.WriteMessage(messageType, data)
return err
}
// closeAndRecConn 断线重连
func (wsc *Wsc) closeAndRecConn() {
if !wsc.IsConnected() {
return
}
wsc.clean()
if wsc.Config.EnableReconnect {
_ = ants.Submit(func() {
wsc.Connect()
})
}
}
// Close 主动关闭连接
func (wsc *Wsc) Close() {
wsc.CloseWithMsg("")
}
// CloseWithMsg 主动关闭连接,附带消息
func (wsc *Wsc) CloseWithMsg(msg string) {
if !wsc.IsConnected() {
return
}
_ = wsc.send(websocket.CloseMessage, websocket.FormatCloseMessage(websocket.CloseNormalClosure, msg))
wsc.clean()
if wsc.onClose != nil {
wsc.onClose(websocket.CloseNormalClosure, msg)
}
}
// clean 清理资源
func (wsc *Wsc) clean() {
if !wsc.IsConnected() {
return
}
wsc.WebSocket.connMu.Lock()
wsc.WebSocket.isConnected = false
_ = wsc.WebSocket.Conn.Close()
close(wsc.WebSocket.sendChan)
wsc.WebSocket.connMu.Unlock()
}