JavaScript WebSocket 通信中怎么使用子协议建立 WebSocket

大磊君_3785

大磊君_3785

2026-10-07

202人浏览

原创

客户端通过websocket构造函数第二个参数传子协议(字符串或数组),浏览器自动映射为sec-websocket-protocol请求头;服务端须在101响应中原样返回匹配值,否则ws.protocol为空。

javascript websocket 通信中怎么使用子协议建立 websocket

直接在 WebSocket 构造函数中传入子协议名,连接建立时浏览器会自动带上 Sec-WebSocket-Protocol 请求头,服务端按规则响应后,ws.protocol 就能拿到协商成功的协议名。关键不是“怎么建连接”,而是“怎么让子协议真正生效”。

客户端怎么传子协议

第二个参数就是子协议声明位置,别绕到 header 或 query 里去:

  • 单协议:直接传字符串,如
    new WebSocket("wss://api.example.com", "json-rpc")
  • 多协议候选:传字符串数组,按优先级从左到右,如 new WebSocket("wss://api.example.com", ["myapp-v2", "myapp-v1"])
  • 不协商子协议:省略该参数、传 null、<code>undefined 或空数组 [],此时请求头不会出现 Sec-WebSocket-Protocol
  • 协议名必须合法:只含小写字母、数字、. 和 -,例如 "chat.v2" 合法,"Chat/V2" 或 "user_v1" 会被浏览器静默忽略或报错

服务端怎么响应才算成功

服务端不能只“支持”某个协议,而必须在 101 响应中**原样返回**客户端列表里的某一个值:

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载
  • Node.js + ws 库:在 handleProtocols 回调中返回字符串(如 return "json-rpc"),返回 null 表示全部拒绝
  • FastAPI:调用 websocket.accept(subprotocol="json-rpc"),且该字符串必须出现在客户端传的数组中,一个字符都不能差
  • .NET 的 ClientWebSocket:用 options.AddSubProtocol("json-rpc") 添加,不是赋值给某个属性
  • Spring Boot:需在握手拦截器 beforeHandshake 中读取请求头,并确保响应头写回匹配项

怎么确认子协议真的协商上了

别等出问题才查,连接一打开就看 ws.protocol:

  • 加一行日志:ws.onopen = () => console.log("Negotiated:", ws.protocol)
  • 输出为空字符串 ""?立刻检查 Network 面板:
    • 请求头是否有 Sec-WebSocket-Protocol(值是否合法、是否被代理过滤)
    • 响应头是否有同名字段,且值与客户端所列完全一致(大小写、连字符、顺序都算)
  • 只要其中任一环失败,ws.protocol 就是空,但连接仍能建立——后续所有依赖该协议的解析逻辑都会静默失效

常见陷阱和注意事项

子协议不是运行时开关,也不是安全机制,它只在握手阶段起作用:

  • ws.protocol 是只读的,连接建立后无法修改,协商失败只能重连
  • 代理(Nginx、CDN)常默认丢弃 Sec-WebSocket-Protocol 头,需显式配置:proxy_pass_request_headers on;,并确认没被 proxy_set_header 覆盖
  • 子协议不校验消息内容:浏览器不会检查你发的是不是 JSON、字段对不对、opcode 是不是文本帧——它只负责把字节流送过去
  • 不要用 URL 参数或自定义 header 做认证替代子协议,那是绕过握手期校验,失去协议层拦截非法连接的能力

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4586

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1149

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4504

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

900

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1796

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3285

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4253

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

2760

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

888

7

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.1万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习