在上一篇文章中,咱们现已了解了 gorilla/websocket 的一些根本概念和简单的用法。 接下来,咱们通过一个再杂乱一点的比如来了解它的实践用法。

功用

这个比如来自源码里边的 examples/chat,它包含了以下功用:

  1. 用户拜访群聊页面的时分,能够发送音讯给一切其他在谈天室内的用户(也便是相同翻开群聊页面的用户)
  2. 一切的用户发送的音讯,群聊中的一切用户都能收到(包含自己)

其根本效果如下:

为了更好地理解 gorilla/websocket 的运用方式,下文在解说的时分会去掉一些出于健壮性考虑而写的代码。

根本架构

这个 demo 的根本组件如下图:

Golang 树立 WebSocket 运用(二) - 根本群聊 demo

  1. Client:也便是衔接到了服务端的客户端,能够有多个
  2. Hub:一切的客户端会保存到 Hub 中,一起一切的音讯也会经过 Hub 来进行播送(也便是将音讯发给一切衔接到 Hub 的客户端)

Golang 树立 WebSocket 运用(二) - 根本群聊 demo

工作原理

Hub

Hub 的源码如下:

type Hub struct {
    // 保存一切客户端
	clients map[*Client]bool
    // 需求播送的音讯
	broadcast chan []byte
    // 等候衔接的客户端
	register chan *Client
    // 等候断开的客户端
	unregister chan *Client
}

Hub 的中心办法如下:

func (h *Hub) run() {
	for {
		select {
		case client := <-h.register:
            // 从等候衔接的客户端 chan 取一项,设置到 clients 中
			h.clients[client] = true
		case client := <-h.unregister:
            // 断开衔接:
            // 1. 从 clients 移除
            // 2. 封闭发送音讯的 chan
			if _, ok := h.clients[client]; ok {
				delete(h.clients, client)
				close(client.send)
			}
		case message := <-h.broadcast:
            // 发送播送音讯给每一个客户端
			for client := range h.clients {
				select {
                    // 成功写入音讯到客户端的 send 通道
				case client.send <- message:
				default:
                    // 发送失败则除掉这个客户端
					close(client.send)
					delete(h.clients, client)
				}
			}
		}
	}
}

这个比如中运用了 chan 来做同步,这能够进步 Hub 的并发处理速度,由于不需求等候 Hubrun 办法中其他 chan 的处理。

简单来说,Hub 做了如下操作:

  1. 保护一切的客户端衔接:客户端衔接、断开衔接等
  2. 发送播送音讯

Client

Client 的源码如下:

type Client struct {
    // Hub 单例
	hub *Hub
    // 底层的 websocket 衔接
	conn *websocket.Conn
    // 等候发送给客户端的音讯
	send chan []byte
}

它包含了如下字段:

  1. Hub 单例(咱们的 demo 中只有一个谈天室)
  2. conn 底层的 WebSocket 衔接
  3. send 通道,这里保存了等候发送给这个客户端的数据

Client 中,是通过 readPump 这个办法来从客户端接纳音讯的:

func (c *Client) readPump() {
	defer func() {
        // 衔接断开、犯错等:
        // 会封闭衔接,从 hub 移除这个衔接
		c.hub.unregister <- c
		c.conn.Close()
	}()
	// ... 
	for {
        // 接纳音讯
		_, message, err := c.conn.ReadMessage()
		if err != nil {
			// ... 错误处理
			break
		}
        // 音讯处理,最终放入 broadcast,预备发给一切其他在线的客户端
		message = bytes.TrimSpace(bytes.Replace(message, newline, space, -1))
		c.hub.broadcast <- message
	}
}

readPump 办法做的事情很简单,它便是接纳音讯,然后通过 Hubbroadcast 来发给一切在线的客户端。

而发送音讯会稍微杂乱一点,咱们来看看 writePump 的源码:

func (c *Client) writePump() {
	defer func() {
        // 衔接断开、犯错:封闭 WebSocket 衔接
		c.conn.Close()
	}()
	for {
		select {
		case message, ok := <-c.send:
            // 操控写超时时间
			c.conn.SetWriteDeadline(time.Now().Add(writeWait))
			if !ok {
				// 衔接现已被 hub 封闭了
				c.conn.WriteMessage(websocket.CloseMessage, []byte{})
				return
			}
            // 获取用以发送音讯的 Writer
			w, err := c.conn.NextWriter(websocket.TextMessage)
			if err != nil {
				return
			}
            // 发送音讯
			w.Write(message)
			n := len(c.send)
			for i := 0; i < n; i++ {
				w.Write(newline)
                // 将接纳到的信息发送出去
				w.Write(<-c.send)
			}
            // 调用 Close 的时分,音讯会被发送出去
			if err := w.Close(); err != nil {
				return
			}
		}
	}
}

虽然比读操作杂乱了一点,但是也仍是很好理解,它做的东西也不多:

  1. 获取用以发送音讯的 Writer
  2. 获取从 hub 中接纳到的其他客户端的音讯,发送给当时这个客户端

详细是如何工作起来的?

  1. main 函数中创建 hub 实例
  2. 通过下面这个 serveWs 来将树立 WebSocket 衔接:
func serveWs(hub *Hub, w http.ResponseWriter, r *http.Request) {
    // 将 HTTP 衔接转换为 WebSocket 衔接
	conn, err := upgrader.Upgrade(w, r, nil)
	if err != nil {
		log.Println(err)
		return
	}
    // 客户端
	client := &Client{hub: hub, conn: conn, send: make(chan []byte, 256)}
    // 注册到 hub
	client.hub.register <- client
	// 发送数据到客户端的协程
	go client.writePump()
    // 从客户端接纳数据的协程
	go client.readPump()
}

serveWs 中,咱们在跟客户端树立起衔接后,创建了两个协程,一个是从客户端接纳数据的,另一个是发送音讯到客户端的。

这个 demo 的效果

这个 demo 是一个比较简单的 demo,不过也包含了咱们构建 WebSocket 运用的一些要害处理逻辑,比如:

  • 运用 Hub 来保持一个低层次的衔接信息
  • Client 中区别读和写的协程
  • 以及一些鸿沟状况的处理:比如衔接断开、超时等

在后续的文章中,咱们会基于这些已有常识去构建一个愈加完善的 WebSocket 运用,今天就到此为止了。