前言
在 go-zero 開(kāi)源之后比原，非常多的用戶詢問(wèn)是否可以支持以及什么時(shí)候支持 websocket，終于在 v1.1.6 里面我們從框架層面讓 websocket 的支持落地了催首，下面我們就以 chat 作為一個(gè)示例來(lái)講解如何用 go-zero 來(lái)實(shí)現(xiàn)一個(gè) websocket 服務(wù)隔披。
整體設(shè)計(jì)
我們以 zero-example 中的 chat 聊天室為例來(lái)一步步一講解 websocket 的實(shí)現(xiàn)猾封，分為如下幾個(gè)部分：
- 多客戶端接入
- 消息廣播
- 客戶端的及時(shí)上線下線
- 全雙工通信【客戶端本身是發(fā)送端，也是接收端】
先放一張圖浊伙，大致的數(shù)據(jù)傳輸：
中間有個(gè) select loop 就是整個(gè) chat 的 engine。首先要支撐雙方通信：
- 得有一個(gè)交流數(shù)據(jù)的管道长捧∠桑客戶端只管從 管道 讀取/輸送數(shù)據(jù)；
- 客戶端在線情況串结。不能說(shuō)你下線了哑子，還往你那傳輸數(shù)據(jù)；
數(shù)據(jù)流
數(shù)據(jù)流是 engine 的主要功能肌割，先不急著看代碼卧蜓，我們先想 client 怎么接入并被 engine 感知：
- 首先是從前端發(fā)
websocket請(qǐng)求； - 建立連接把敞；準(zhǔn)備接收/發(fā)送通道弥奸；
- 注冊(cè)到
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請(qǐng)求升級(jí)為websocket
conn, err := upgrader.Upgrade(w, r, nil)
...
// 構(gòu)建client：hub{engine}, con{websocker conn}, send{channel buff}
client := &Client{
hub: hub,
conn: conn,
send: make(chan []byte, bufSize),
}
client.hub.register <- client
// 開(kāi)始客戶端雙工的通信先巴，接收和寫(xiě)入數(shù)據(jù)
go client.writePump()
go client.readPump()
}
這樣其爵，新接入的 client 就被加入到 注冊(cè) 通道中。
hub engine
發(fā)出了 注冊(cè) 的動(dòng)作伸蚯，engine 會(huì)怎么處理呢摩渺？
type Hub struct {
clients map[*Client]bool // 上線clients
broadcast chan []byte // 客戶端發(fā)送的消息 ->廣播給其他的客戶端
register chan *Client // 注冊(cè)channel，接收注冊(cè)msg
unregister chan *Client // 下線channel
}
func (h *Hub) Run() {
for {
select {
// 注冊(cè)channel：存放到注冊(cè)表中剂邮，數(shù)據(jù)流也就在這些client中發(fā)生
case client := <-h.register:
h.clients[client] = true
// 下線channel：從注冊(cè)表里面刪除
case client := <-h.unregister:
if _, ok := h.clients[client]; ok {
delete(h.clients, client)
close(client.send)
}
// 廣播消息：發(fā)送給注冊(cè)表中的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)
}
}
}
}
}
- 接收注冊(cè)消息 -> 加入全局注冊(cè)表
- 如果
engine.broadcast接收到，會(huì)將msg傳遞給 注冊(cè)表 的client.sendChan
這樣從 HTML -> client -> hub -> other client 的整個(gè)數(shù)據(jù)流就清晰了。
廣播數(shù)據(jù)
上面說(shuō)到 engine.broadcast 接收到數(shù)據(jù)绰姻，那從頁(yè)面開(kāi)始枉侧，數(shù)據(jù)是怎么發(fā)送到這？
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【頁(yè)面點(diǎn)擊后傳遞】 - 將
msg傳入engine.broadcast狂芋，從而廣播到其他的client - 當(dāng)出現(xiàn)發(fā)送異痴ツ伲或者是超時(shí)，異常退出時(shí)帜矾，會(huì)觸發(fā)下線
client
同時(shí)要知道翼虫，此時(shí)發(fā)送消息的 client 不止有一個(gè)，可能會(huì)有很多個(gè)屡萤。那發(fā)送到其他client珍剑，client 從自己的 send channel 中讀取消息即可：
func (c *Client) writePump() {
// 寫(xiě)超時(shí)控制
ticker := time.NewTicker(pingPeriod)
...
for {
select {
case message, ok := <-c.send:
// 當(dāng)接收消息寫(xiě)入時(shí)，延長(zhǎng)寫(xiě)超時(shí)時(shí)間死陆。
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))
...
}
}
}
上面也說(shuō)了，send 有來(lái)自各自客戶端中發(fā)送的msg：所以當(dāng)檢測(cè)到 send 有數(shù)據(jù)措译，就不斷接收消息并寫(xiě)入當(dāng)前 client别凤；同時(shí)當(dāng)寫(xiě)超時(shí)，會(huì)檢測(cè)websocket長(zhǎng)連接是否還存活领虹，存活則繼續(xù)讀 send chan闻妓，斷開(kāi)則直接返回。
完整示例代碼
https://github.com/zeromicro/zero-examples/tree/main/chat
總結(jié)
本篇文章從使用上介紹如何結(jié)合 go-zero 開(kāi)始你的 websocket 項(xiàng)目掠械，開(kāi)發(fā)者可以按照自己的需求改造由缆。
關(guān)于 go-zero 更多的設(shè)計(jì)和實(shí)現(xiàn)文章，可以持續(xù)關(guān)注我們猾蒂。
https://github.com/tal-tech/go-zero
歡迎使用 go-zero 并 star 支持我們均唉！
go-zero 系列文章見(jiàn)『微服務(wù)實(shí)踐』公眾號(hào)
