用 Go + WebSocket 快速实现一个 chat 服务

发布于 2023-08-28 00:24:20 字数 6219 浏览 38 评论 0

在 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 中发生
  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 {
    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))
   ...
  }
 }
}