WebSocket子协议怎么定义 WebSocket Sec-WebSocket-Protocol设置【协议】

阿墨小哥_8827

阿墨小哥_8827

2026-06-01

983人浏览

原创

websocket客户端通过websocket构造函数第二个参数定义子协议,支持字符串或字符串数组,需符合ascii命名规范;服务端须在握手阶段解析sec-websocket-protocol头并响应匹配值,否则ws.protocol为空。

websocket子协议怎么定义 websocket sec-websocket-protocol设置【协议】

WebSocket子协议怎么在客户端定义

客户端定义子协议就是调用 WebSocket 构造函数时传入第二个参数,它不叫“设置头”,而是由浏览器自动映射为 Sec-WebSocket-Protocol 请求头。这个参数必须是字符串或字符串数组,不能是对象、数字或带空格的字符串。

常见错误现象包括:ws.protocol 始终为空、服务端收不到该字段、控制台报错 “Invalid subprotocol”。

  • 单协议场景直接传字符串:new WebSocket("wss://api.example.com", "chat")
  • 多协议协商传数组,按优先级排序:new WebSocket("wss://api.example.com", ["myapp-v2", "myapp-v1"])
  • 协议名只能含 ASCII 字母、数字、-、.,禁止中文、@、/、空格等 —— 例如 "auth:token-abc" 合法,"auth/token" 或 "用户-v1" 会触发浏览器拒绝
  • 如果传了非法字符,Chrome 会静默忽略该参数(不报错但请求头不出现),Firefox 可能抛 SyntaxError

Sec-WebSocket-Protocol 请求头怎么被服务端读取

服务端不是“读取请求头”那么简单,而是在 WebSocket 握手阶段(即 HTTP Upgrade 请求处理时)从原始 HTTP 请求中提取该字段。不同框架方式差异大,关键点在于:不能等到 onOpen 再解析,必须在握手响应前完成鉴权或协议选择。

典型误区是以为像普通 HTTP 请求一样,在 WebSocket 连接建立后发个消息传 token —— 这完全绕过了子协议设计初衷,也失去握手期拦截非法连接的能力。

  • Spring Boot + spring-websocket:需自定义 HandshakeInterceptor,重写 beforeHandshake 方法,从 request.getHeaders().get("Sec-WebSocket-Protocol") 取值
  • FastAPI:通过 websocket.scope["subprotocols"] 获取客户端声明的列表,再在 accept() 时显式指定返回值
  • Node.js + ws 库:在 handleProtocols 钩子中接收 protocols 参数(字符串数组)和 request 对象,返回匹配的协议字符串或 null 拒绝
  • 若服务端未在响应中返回 Sec-WebSocket-Protocol 头,或返回值不在客户端列表中,浏览器仍会建连,但 ws.protocol 为空 —— 这是静默失败,极易被忽略

为什么用 Sec-WebSocket-Protocol 做鉴权而不是 URL 参数

因为它是唯一被浏览器原生 WebSocket API 官方允许携带的、可参与握手校验的自定义字段。URL 参数虽简单,但存在硬伤:会被代理、CDN、浏览器历史记录、服务端日志明文记录,且无法在握手阶段阻断非法连接。

WebSocket 8.18.2
WebSocket 8.18.2

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

下载

而 Sec-WebSocket-Protocol 的值在握手阶段就可用于校验,服务端可立即拒绝不合法的协议名(比如 token 格式错误、签名失效),避免后续资源占用。

  • 适合放轻量鉴权信息:base64 编码后的短 token、版本号、租户 ID 等,如 "v2.tenant-abc"、"auth-eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
  • 不适合放敏感长 token 或原始密码 —— 协议名长度受浏览器实现限制(Chrome 约 4KB,但实际建议控制在 256 字符内)
  • HTTP 代理或负载均衡器可能剥离或重写 Sec-WebSocket-Protocol 头,生产环境务必验证中间件配置
  • 前端不要拼接动态字符串传入构造函数,避免注入风险;应提前校验格式,再作为字面量传入

调试 Sec-WebSocket-Protocol 是否生效

别只看控制台有没有报错,重点查 Network 面板里的 WebSocket 握手帧 —— 它本质是两个 HTTP 包(Request + Response),不是真正的 WebSocket 数据帧。

打开 Chrome DevTools → Network → 找到 ws:// 或 wss:// 请求 → 点开 → 查看 Headers 标签页:

  • 检查 Request Headers 中是否存在 Sec-WebSocket-Protocol,值是否与代码一致
  • 检查 Response Headers 中是否存在同名字段,且值是否为客户端列表中的某一项
  • 如果 Request 有而 Response 没有,说明服务端未正确返回或中间件过滤了该头
  • 如果两者都有但 ws.protocol 仍为空,大概率是服务端返回的值大小写不一致(协议名区分大小写)或含不可见字符(比如 BOM)

真正容易被忽略的是:子协议协商成功后,ws.protocol 是只读属性,且仅在 open 事件之后才可读取 —— 在 onopen 回调外访问它,结果一定是空字符串。

相关专题

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

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

2023.06.20

2949

3

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

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

2023.07.25

2208

9

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

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

2023.08.02

1180

5

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

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

2023.08.09

1118

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

1316

5

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

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

2023.09.20

2058

7

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

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

2023.09.20

3240

8

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

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

2023.09.22

14495

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人学习