用 Go + WebSocket 快速實現一個 chat 服務
阿新 • • 發佈：2021-03-31
## 前言
在 `go-zero` 開源之後，非常多的使用者詢問是否可以支援以及什麼時候支援 `websocket`，終於在 `v1.1.6` 裡面我們從框架層面讓 `websocket` 的支援落地了，下面我們就以 `chat` 作為一個示例來講解如何用 `go-zero` 來實現一個 `websocket` 服務。
## 整體設計
我們以 `zero-example` 中的 `chat` 聊天室為例來一步步一講解 `websocket` 的實現，分為如下幾個部分：
1. 多客戶端接入
2. 訊息廣播
3. 客戶端的及時上線下線
4. 全雙工通訊【客戶端本身是傳送端，也是接收端】
先放一張圖，大致的資料傳輸：
中間有個 `select loop` 就是整個 `chat` 的 `engine`。首先要支撐雙方通訊：
- 得有一個交流資料的管道。客戶端只管從 *管道* 讀取/輸送資料；
- 客戶端線上情況。不能說你下線了，還往你那傳輸資料；
## 資料流
資料流是 `engine` 的主要功能，先不急著看程式碼，我們先想 `client` 怎麼接入並被 `engine` 感知：
1. 首先是從前端發 `websocket` 請求；
2. 建立連線；準備接收/傳送通道；
3. 註冊到 `engine`；
```go
// HTML 操作 {js}
if (window["WebSocket"]) {
conn = new WebSocket("ws://" + document.location.host + "/ws");
conn.onclose = function (evt) {
var item = document.createElement("div");
item.innerHTML = "Connection closed.";
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` 會怎麼處理呢？
```go
type Hub struct {
clients map[*Client]bool // 上線clients
broadcast chan []byte // 客戶端傳送的訊息 ->