使用 gorilla/websocket 构建 websocket 服务需遵循以下步骤:1. 导入包并定义 upgrader 配置,设置缓冲区大小和跨域策略;2. 编写处理函数,通过 upgrade 方法将 http 连接升级为 websocket;3. 使用 conn 对象进行消息读写操作,注意并发安全;4. 设置心跳机制以维持连接稳定性,包括设置超时和自定义 ping/pong 处理。该库功能全面,适合大多数项目需求,但需关注并发控制、缓冲区配置及连接保持等细节,以确保服务稳定运行。

WebSocket 是现代 Web 开发中实现双向通信的重要手段,Golang 作为高性能后端语言,天然适合构建 WebSocket 服务。在众多 Golang 的 WebSocket 库中,gorilla/websocket 是最常用、最稳定的一个。它不仅功能全面,而且文档清晰,适合大多数实际项目需求。

下面我们就来看看,如何用 gorilla/websocket 构建一个 WebSocket 服务,并解析它的核心机制。
1. 快速搭建一个 WebSocket 服务
构建一个基础的 WebSocket 服务非常简单,只需要几个步骤:
立即学习“go语言免费学习笔记(深入)”;

- 导入
github.com/gorilla/websocket - 定义升级配置(可选)
- 编写处理函数,使用
Upgrader.Upgrade()将 HTTP 连接升级为 WebSocket 连接 - 使用
Conn对象进行消息读写
示例代码如下:
package main
import (
"github.com/gorilla/websocket"
"net/http"
)
var upgrader = websocket.Upgrader{
ReadBufferSize: 1024,
WriteBufferSize: 1024,
CheckOrigin: func(r *http.Request) bool {
return true // 允许跨域,生产环境应根据需要设置
},
}
func handleWebSocket(w http.ResponseWriter, r *http.Request) {
conn, _ := upgrader.Upgrade(w, r, nil)
for {
messageType, p, err := conn.ReadMessage()
if err != nil {
return
}
conn.WriteMessage(messageType, p)
}
}
func main() {
http.HandleFunc("/ws", handleWebSocket)
http.ListenAndServe(":8080", nil)
}这个服务会接收客户端连接,然后把收到的消息原样返回。

2. Upgrader 的作用与配置细节
Upgrader 是 gorilla/websocket 中的核心结构体,它的主要作用是将普通的 HTTP 请求“升级”为 WebSocket 连接。
它有几个关键配置项需要注意:
-
CheckOrigin:用于防止跨域请求,默认只允许同源。开发时可以设置为返回true来允许所有来源,但生产环境应根据实际需求配置。 -
ReadBufferSize和WriteBufferSize:控制内部缓冲区大小,影响性能。通常设置为 1024 或更大。 -
Subprotocols:用于协商子协议,比如客户端发送了Sec-WebSocket-Protocol请求头,可以在这里做匹配。 -
HandshakeTimeout:控制握手阶段的最大等待时间,默认是 45 秒。
这些配置在初始化 Upgrader 时设置,影响整个服务的行为。
3. WebSocket 连接的读写机制
一旦连接建立成功,就可以通过 *websocket.Conn 对象进行通信。
常用方法包括:
-
ReadMessage():读取消息,返回消息类型(文本或二进制)和内容。 -
WriteMessage(messageType int, data []byte):发送消息。 -
WriteJSON(v interface{})和ReadJSON(v interface{}):用于收发 JSON 格式数据,非常方便。
注意:
- 每个连接的读写操作是并发不安全的,因此如果你需要从多个 goroutine 向同一个连接写数据,应该加锁或者使用通道统一管理。
- 如果读取时遇到错误(如连接关闭),应退出循环并清理资源。
4. 心跳机制与连接保持
WebSocket 连接默认是长连接,但网络环境复杂,可能会出现“假连接”——连接看似存在,但其实已经断开。这时候就需要心跳机制来检测连接状态。
gorilla/websocket 提供了内置的心跳支持:
- 设置
Conn的SetReadDeadline()和SetWriteDeadline()来控制超时 - 使用
SetPingHandler()和SetPongHandler()自定义心跳逻辑
例如:
conn.SetReadDeadline(time.Now().Add(10 * time.Second))
conn.SetPongHandler(func(appData string) error {
conn.SetReadDeadline(time.Now().Add(10 * time.Second))
return nil
})这样每次收到 pong 消息就更新读超时时间,如果超过时间没收到,就会触发超时错误,进而关闭连接。
基本上就这些。用 gorilla/websocket 构建服务不复杂,但有些细节容易忽略,比如并发写锁、心跳设置、缓冲区大小等,这些都会影响服务的稳定性。










