什么是WebSocket Subprotocol WebSocket子协议怎么设置【科普】

秋涛酱_3564

秋涛酱_3564

2026-05-26

271人浏览

原创

sec-websocket-protocol 是 websocket 握手时协商应用层语义的唯一 http 头,仅用于字符串匹配子协议名(如 json-rpc),服务端严格校验客户端所传协议是否在支持列表中并原样回写,不解析、不降级、不自动兼容。

什么是websocket subprotocol websocket子协议怎么设置【科普】

Sec-WebSocket-Protocol 是 WebSocket 握手阶段唯一用于协商应用层语义的 HTTP 头,它不是加密机制、不改变传输格式、也不影响连接建立本身,而纯粹是客户端与服务端之间「约好用什么规则说话」的信号。

WebSocket 子协议本质就是字符串匹配

子协议名称只是一个区分用途的字符串,比如 json-rpc、graphql-ws、json.reliable.webpubsub.azure.v1。服务器收到客户端发来的 Sec-WebSocket-Protocol: json-rpc, xml-rpc 后,只做三件事:检查是否在自己支持列表里、选一个(通常是第一个匹配项)、在响应头里原样回写。没有解析、不校验版本、不自动降级。

FastAPI 中 accept() 的 subprotocol 参数必须严格匹配

如果你在 websocket.accept(subprotocol="json-rpc") 里写了某个值,那客户端传来的 Sec-WebSocket-Protocol 列表中**必须包含完全相同的字符串**,否则握手失败,浏览器控制台会报 WebSocket connection to '...' failed: Error during WebSocket handshake: Sent non-empty 'Sec-WebSocket-Protocol' header but no response was received。

WebSocket 8.18.2
WebSocket 8.18.2

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

下载
  • 服务端写 await websocket.accept(subprotocol="json-rpc") → 客户端必须传 ["json-rpc"] 或 ["json-rpc", "xml-rpc"]
  • 服务端写 await websocket.accept(subprotocol="json-rpc-v2") → 客户端传 ["json-rpc"] 不行,大小写/连字符/版本号都算不同协议
  • 不传 subprotocol 参数(即 await websocket.accept())→ 服务端不声明协议,客户端也不能带 Sec-WebSocket-Protocol 头,否则被拒绝

客户端 new WebSocket() 的第二个参数是协议优先级列表

JavaScript 中 new WebSocket(url, protocols) 的 protocols 是字符串数组,顺序代表客户端偏好。服务端 handleProtocols 或 FastAPI 的 accept() 逻辑通常取第一个匹配项 —— 所以把最稳定、最常用、最兼容的协议放前面。

  • 传 ["protobuf.reliable.webpubsub.azure.v1", "json.reliable.webpubsub.azure.v1"] → 服务端若只支持后者,就会选中它并返回 Sec-WebSocket-Protocol: json.reliable.webpubsub.azure.v1
  • 传空数组 [] 或不传 → 不发送 Sec-WebSocket-Protocol 头,等价于无子协议协商
  • 协议名含非法字符(如空格、斜杠、控制符)会导致连接直接被浏览器拦截,错误信息为 Failed to construct 'WebSocket': The subprotocol contains invalid characters

子协议不等于消息格式,但强烈建议保持一致

子协议本身不强制你用 JSON 或 Protobuf 封包,但实际中几乎所有主流子协议(如 graphql-ws、json.reliable.webpubsub.azure.v1)都隐含了消息结构、控制帧语义和重连逻辑。你如果协商了 json-rpc 却发裸字符串,服务端大概率解析失败;协商了 Azure 可靠协议却跳过连接恢复流程,消息就真的会丢。

  • 子协议是契约,不是装饰:一旦选择,就要按其规范收发数据、处理错误、响应 ping/pong
  • 调试时先用 chrome://net-internals/#websockets 查看真实收发的 Sec-WebSocket-Protocol 值,比猜更可靠
  • CDN 或反向代理(如 Nginx)默认可能剥离或改写该头,需显式配置 proxy_set_header Sec-WebSocket-Protocol $http_sec_websocket_protocol;
子协议最常被忽略的一点:它不提供任何运行时保障。协商成功只是握手通过,后续所有语义、序列化、重试、鉴权,都得你自己实现或依赖 SDK —— 比如用 json.reliable.webpubsub.azure.v1 却没处理 sequenceId 和 resume 帧,可靠性就形同虚设。

相关专题

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

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

2023.06.20

2989

3

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

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

2023.07.25

2248

9

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

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

2023.08.02

1200

5

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

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

2023.08.09

1138

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

1336

5

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

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

2023.09.20

2078

7

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

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

2023.09.20

3300

8

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

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

2023.09.22

14735

6

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

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

2023.09.22

549

3

热门下载

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

精品课程

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

共0课时 | 0人学习

Webman中文手册
Webman中文手册

共0课时 | 0人学习