前言
在 go-zero 开源之后，非常多的用户询问是不是能够支持以及什么时候支持 websocket，最终在 v1.1.6 里面咱们从框架层面让 websocket 的支持落地了，下面咱们就以 chat 做为一个示例来讲解怎样用 go-zero 来实现一个 websocket 服务。
整体设计
咱们以 zero-example 中的 chat 聊天室为例来一步步一讲解 websocket 的实现，分为如下几个部分： 多客户端接入信息广播客户端的即时上线下线全双工通信【客户端本身是发送端，亦是接收端】先放一张图，大致的数据传输：
中间有个 select loop 便是全部 chat 的 engine。首要要支撑双方通信： 得有一个交流数据的管道。客户端只管从 管道 读取/传送数据；客户端在线状况。不可说你下线了，还往你那传输数据；数据流
数据流是 engine 的重点功能，先不急着看代码，咱们先想 client 怎么接入并被 engine 感知： 首要是从前端发 websocket 请求；创立连接；准备接收/发送通道；注册到 engine；// HTML 操作 {js}
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) {
// 将http请求升级为websocket
conn, err := upgrader.Upgrade(w, r, nil)
...// 构建client：hub{engine}, con{websocker conn}, send{channel buff}
client := &Client{
hub: hub,
conn: conn,
send: make(chan []byte, bufSize),
}
client.hub.register <- client// 起始客户端双工的通信，接收和写入数据
go client.writePump()
go client.readPump()
}
这般，新接入的 client 就被加入到 注册 通道中。
hub engine
发出了 注册 的动作，engine 会怎么处理呢？ 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中出现
caseclient := <-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 {
select {
case client.send <- message:
default:
close(client.send)delete(h.clients, client)
}
}
}
}
}
接收注册信息 -> 加入全局注册表倘若 engine.broadcast 接收到，会将 msg 传递给 注册表 的 client.sendChan这般从 HTML -> client -> hub -> other client 的全部数据流就清晰了。
广播数据
上面说到 engine.broadcast 接收到数据，那从页面起始，数据是怎么发送到这？ func (c *Client) readPump() {
...
for {
// 1
_, message, err :=c.conn.ReadMessage()
if err != nil {
if websocket.IsUnexpectedCloseError(err, websocket.CloseGoingAway, websocket.CloseAbnormalClosure) {
log.Printf("error: %v", err)
}
break
}
message = bytes.TrimSpace(bytes.Replace(message, newline, space, -1))
// 2.
c.hub.broadcast <- message
}
}
从 conn 中持续读取 msg【页面点击后传递】将 msg 传入 engine.broadcast，从而广播到其他的 client当显现发送反常或是超时，反常退出时，会触发下线 client同期要晓得，此时发送信息的 client 不止有一个，可能会有非常多个。那发送到其他client，client 从自己的 send channel 中读取信息就可： func (c *Client) writePump() {
// 写超时掌控
ticker := time.NewTicker(pingPeriod)
...
for {
select {
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:
c.conn.SetWriteDeadline(time.Now().Add(writeWait))
...
}
}
}上面亦说了，send 有来自各自客户端中发送的msg：因此当检测到 send 有数据，就持续接收信息并写入当前 client；同期当写超时，会检测websocket长连接是不是还存活，存活则继续读 send chan，断开则直接返回。
完整示例代码
https://github.com/zeromicro/zero-examples/tree/main/chat
总结
本篇文案从运用上介绍怎样结合 go-zero 起始你的 websocket 项目，研发者能够根据自己的需要改造。
| 
发表于 2024-8-22 15:45:16
