关于golang:用-Go-WebSocket-快速实现一个-chat-服务

在 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 就被退出到注册通道中。

收回了注册的动作，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))
            ...
        }
    }
}

下面也说了，send 有来自各自客户端中发送的 msg：所以当检测到 send 有数据，就一直接管音讯并写入以后 client；同时当写超时，会检测 websocket 长连贯是否还存活，存活则持续读 send chan，断开则间接返回。

https://github.com/zeromicro/zero-examples/tree/main/chat

本篇文章从应用上介绍如何联合 go-zero 开始你的 websocket 我的项目，开发者能够依照本人的需要革新。

对于 go-zero 更多的设计和实现文章，能够继续关注咱们。

https://github.com/tal-tech/go-zero

欢送应用 go-zero 并 star 反对咱们！

go-zero 系列文章见『微服务实际』公众号

关于golang:用-Go-WebSocket-快速实现一个-chat-服务

前言

整体设计

数据流

hub engine

播送数据

残缺示例代码

总结