如何优雅关闭 WebSocket 连接并传递自定义关闭消息

云雪君_9498

云雪君_9498

2026-05-26

722人浏览

原创

如何优雅关闭 WebSocket 连接并传递自定义关闭消息

Go 中使用 golang.org/x/net/websocket 无法直接发送带状态码和原因的关闭消息;需改用更现代的 Gorilla WebSocket 库,通过 FormatCloseMessage 构造关闭帧,并先写入再调用 Close() 实现符合标准的带消息关闭。

go 中使用 `golang.org/x/net/websocket` 无法直接发送带状态码和原因的关闭消息;需改用更现代的 gorilla websocket 库,通过 `formatclosemessage` 构造关闭帧,并先写入再调用 `close()` 实现符合标准的带消息关闭。

WebSocket 协议(RFC 6455)规定:关闭连接时可携带一个 2 字节的状态码(如 1000 表示正常关闭)及 UTF-8 编码的可选原因文本(最长 123 字节)。浏览器 JavaScript 端可通过 event.code 和 event.reason 获取该信息:

websocket.onclose = function(event) {
  console.log('Code:', event.code);      // e.g., 1000
  console.log('Reason:', event.reason);  // e.g., "Server shutdown"
  console.log('WasClean:', event.wasClean); // true if closed gracefully
};

但 golang.org/x/net/websocket(已归档、不再维护)的 Close() 方法不支持传入参数,无法发送自定义关闭消息。因此,强烈建议迁移到功能完备、广泛使用的 Gorilla WebSocket(导入路径:github.com/gorilla/websocket)。

以下是使用 Gorilla WebSocket 发送带消息关闭帧的正确方式:

WebSocket 8.18.2
WebSocket 8.18.2

WebSocket 8.18.2 是该协议规范的一个重要迭代版本,主要优化了连接稳定性与数据传输效率。它通过全双工通信机制,允许客户端与服务器在单一长连接上实时交换数据,大幅降低传统 HTTP 轮询的开销。该版本增强了心跳保活、自动重连及二进制帧传输能力,适用于即时通讯、在线游戏及金融行情推送等低延迟场景,为开发者提供更可靠的实时网络交互基础。

下载
import (
    "log"
    "github.com/gorilla/websocket"
)

// 假设 ws 是 *websocket.Conn 类型的连接
func closeWithMessage(ws *websocket.Conn, code int, reason string) error {
    // 构造标准关闭消息帧(自动处理字节序和长度限制)
    message, err := websocket.FormatCloseMessage(code, reason)
    if err != nil {
        return err // 如 reason 超长或非 UTF-8,会返回错误
    }

    // 同步写入关闭消息帧(必须在 Close() 前调用)
    if err := ws.WriteMessage(websocket.CloseMessage, message); err != nil {
        return err
    }

    // 执行底层连接关闭(此时不会重复发送关闭帧)
    return ws.Close()
}

// 使用示例
err := closeWithMessage(conn, websocket.CloseGoingAway, "Maintenance in progress")
if err != nil {
    log.Printf("Failed to close connection gracefully: %v", err)
}

✅ 关键要点说明:

  • websocket.FormatCloseMessage 自动校验 reason 是否为合法 UTF-8 且长度 ≤123 字节,非法输入将返回错误;
  • 必须先调用 WriteMessage(websocket.CloseMessage, ...),再调用 ws.Close() —— 后者仅清理资源,不重发关闭帧;
  • 若跳过 WriteMessage 直接 Close(),浏览器收到的是无 reason 的默认关闭事件(event.reason === "", event.code === 1005);
  • 常用状态码:websocket.CloseNormalClosure (1000)、websocket.CloseGoingAway (1001)、websocket.CloseInternalServerErr (1011)。

⚠️ 注意:golang.org/x/net/websocket 已于 2022 年正式归档,不再接受更新或安全修复。生产环境务必迁移至 Gorilla 或其他活跃维护的实现(如 nhooyr.io/websocket),以保障协议兼容性与安全性。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

websocket

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

2789

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2168

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1140

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1078

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1296

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

1998

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3100

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

13615

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

529

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebSocket手册
WebSocket手册

共0课时 | 0人学习

Webman中文手册
Webman中文手册

共0课时 | 0人学习