前言 在 go-zero 开源之后，非常多的用户询问是否可以支持以及什么时候支持 websocket，终于在 v1.1.6 里面我们从框架层面让 websocket 的支持落地了，下面我们就以 chat 作为一个示例来讲解。..
一、Go WebSocket实现
1.1 前言
在
go-zero
开源之后，非常多的用户询问是否可以支持以及什么时候支持
websocket
，终于在
v1.1.6
里面我们从框架层面让
的支持落地了，下面我们就以
chat
作为一个示例来讲解如何用
来实现一个
服务。
1.2 整体设计
我们以
zero-example
中的
聊天室为例来一步步一讲解
的实现，分为如下几个部分：
多客户端接入
消息广播
客户端的及时上线下线
全双工通信【客户端本身是发送端，也是接收端】
先放一张图，大致的数据传输：
中间有个 SELECT loop 就是整个
的
engine
。首先要支撑双方通信：
得有一个交流数据的管道。客户端只管从 管道 读取/输送数据；
客户端在线情况。不能说你下线了，还往你那传输数据；
1.3 数据流
数据流是
的主要功能，先不急着看代码，我们先想
client
怎么接入并被
感知：
首先是从前端发
请求；
建立连接；准备接收/发送通道；
注册到
；
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
|
if (window["WebSocket"]) {
conn = new WebSocket("ws://" + document.location.host + "/ws");
conn.onclose = function (evt) {
var item = document.createElement("div");
item.innerHTML = "<b>Connection closed.</b>";
appendLog(item);
};
...
}
engine.AddRoute(rest.Route{
Method: http.MethodGet,
Path: "/ws",
Handler: func(w http.ResponseWriter, r *http.Request) {
internal.ServeWs(hub, w, r)
},
})
func ServeWs(hub *Hub, w http.ResponseWriter, r *http.Request) {
conn, err := upgrader.Upgrade(w, r, nil)
...
client := &Client{
hub: hub,
conn: conn,
send: make(chan []byte, bufSize),
}
client.hub.register <- client
go client.writePump()
go client.readPump()
}
`这样，新接入的```text
client
|
就被加入到 注册 通道中。
1.4 hub engine
发出了 注册 的动作，
会怎么处理呢？
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
| type Hub struct {
clients map[*Client]bool // 上线clients
broadcast chan []byte // 客户端发送的消息 ->广播给其他的客户端
register chan *Client // 注册channel，接收注册msg
unregister chan *Client // 下线channel
}
func (h *Hub) Run() {
for {
select {
// 注册channel：存放到注册表中，数据流也就在这些client中发生
case client := <-h.register:
h.clients[client] = true
// 下线channel：从注册表里面删除
case client := <-h.unregister:
if _, ok := h.clients[client]; ok {
delete(h.clients, client)
close(client.send)
}
// 广播消息：发送给注册表中的client中，send接收到并显示到client上
case message := <-h.broadcast:
for client := range h.clients {
case client.send <- message:
default:
}
|
如果
engine.broadcast
接收到，会将
msg
传递给 注册表 的
client.sendChan
1
| 这样从 HTML -> client -> hub -> other client 的整个数据流就清晰了。
|
1.5 广播数据
上面说到
接收到数据，那从页面开始，数据是怎么发送到这？
1
| func (c *Client) readPump() {
|
...
1
2
3
4
5
6
| for {
// 1
_, message, err := c.conn.ReadMessage()
if err != nil {
if websocket.IsUnexpectedCloseError(err, websocket.CloseGoingAway, websocket.CloseAbnormalClosure) {
log.Printf("error: %v", err)
|
}
break
}
1
2
3
| message = bytes.TrimSpace(bytes.Replace(message, newline, space, -1))
// 2.
c.hub.broadcast <- message
|
}
从```text conn中不断读取```text
msg
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
| 【页面点击后传递】
将
`msg`
传入
，从而广播到其他的
当出现发送异常或者是超时，异常退出时，会触发下线
同时要知道，此时发送消息的
不止有一个，可能会有很多个。那发送到其他client，client 从自己的
`send channel`
中读取消息即可：
func (c *Client) writePump() {
// 写超时控制
ticker := time.NewTicker(pingPeriod)
...
for {
case message, ok := <-c.send:
// 当接收消息写入时，延长写超时时间。
c.conn.SetWriteDeadline(time.Now().Add(writeWait))
...
w, err := c.conn.NextWriter(websocket.TextMessage)
...
w.Write(message)
// 依次读取 send 中消息，并write
n := len(c.send)
for i := 0; i < n; i++ {
w.Write(newline)
w.Write(<-c.send)
}
...
case <-ticker.C:
...
}
`上面也说了，```text
send
`有来自各自客户端中发送的msg：所以当检测到```text
send
|
有数据，就不断接收消息并写入当前 client；同时当写超时，会检测websocket长连接是否还存活，存活则继续读
send chan ，断开则直接返回。
1.6 完整示例代码
https://github.com/zeromicro/zero-examples/tree/main/chat
1.7 总结
本篇文章从使用上介绍如何结合
开始你的
项目，开发者可以按照自己的需求改造。
关于
https://github.com/tal-tech/go-zero
https://gitee.com/kevwan/go-zero
欢迎使用 go-zero 并 star 支持我们！
本文标题： 用GoWebSocket快速实现一
发布时间： 2022年03月08日 00:00
最后更新： 2025年12月30日 08:54
原始链接： https://haoxiang.eu.org/f185b302/
版权声明： 本文著作权归作者所有，均采用CC BY-NC-SA 4.0许可协议，转载请注明出处！
