浏览器WebSocket API文档说明 常用属性和方法汇总【教程】

轻枫姑娘_6422

轻枫姑娘_6422

2026-05-30

421人浏览

原创

浏览器 WebSocket API 易踩四大坑:readyState 判断不严(构造后立即 send 报错)、send() 过早调用(仅 readyState === 1 可用)、onerror 不处理导致重连失效(错误无详情,需结合 onclose 的 code/reason 判断)、close() 乱传 code(必须为 1000–4999 整数)。

浏览器websocket api文档说明 常用属性和方法汇总【教程】

直接说结论:浏览器原生 WebSocket API 极简但易踩坑,readyState 判断不严、send() 调用过早、onerror 不处理就丢、close() 乱传 code 是最常导致连接异常或静默失败的四个点。

WebSocket 构造与 readyState 状态判断必须配对使用

不能只靠 new WebSocket(url) 就认为连接可用。构造后 readyState 立即是 0(CONNECTING),不是 1(OPEN)。很多代码直接在 new 后立刻调用 send(),结果报错 InvalidStateError: Failed to execute 'send' on 'WebSocket': Still in CONNECTING state。

正确做法是只在 onopen 回调里发数据,或者手动轮询检查:

const socket = new WebSocket('wss://api.example.com');
socket.onopen = () => {
  socket.send(JSON.stringify({ type: 'auth', token: 'xxx' }));
};
// ❌ 错误示例:没等 onopen 就 send
// socket.send('hello'); // 报错
  • readyState === 0:握手还没完成,任何 send() 都会失败
  • readyState === 1:唯一可安全 send() 的状态
  • readyState === 2 或 3 时调用 send() 不报错但无效,数据直接丢弃

send() 支持的数据类型和二进制传输陷阱

send() 接收 string、Blob、ArrayBuffer,但类型决定后续解析方式。默认接收文本消息为字符串,但若服务端发的是二进制帧,而客户端没设 binaryType,event.data 可能是 ArrayBuffer 也可能是 Blob,行为不一致。

关键控制点是 socket.binaryType,它必须在连接打开前或刚打开时设置(onopen 里设最稳妥):

socket.binaryType = 'arraybuffer'; // 或 'blob'
socket.onmessage = (e) => {
  if (e.data instanceof ArrayBuffer) {
    const view = new Uint8Array(e.data);
    console.log('bytes:', view);
  }
};
  • 设成 'arraybuffer' 后,所有二进制消息都以 ArrayBuffer 形式到达,适合做位操作或解码
  • 设成 'blob' 更省内存,适合大文件下载,但读取需 blob.arrayBuffer() 或 blob.text()
  • 不设默认值是 'blob',但某些浏览器旧版本可能表现不同,显式声明更可靠

onerror 和 onclose 必须配合看,否则重连逻辑会失效

onerror 触发时,连接不一定已断开;它只是“出错了”,之后大概率触发 onclose,但不是 100%。更重要的是:onerror 不带任何错误详情,event 参数为空对象 —— 它只是个信号,不是诊断依据。

CDP浏览器大师
CDP浏览器大师

CDP浏览器大师:通过Chrome DevTools Protocol驱动已登录浏览器实现自动化任务,解决反爬封号、选择器失效、SPA路由难导航、固定sleep不准四大痛点。核心能力包括UA伪装、WebGL/Canvas指纹混淆、智能等待、动态选择器以及可视化调试。

下载

真正有用的关闭信息在 onclose 的 event.code 和 event.reason 里:

socket.onclose = (e) => {
  console.log('closed with code:', e.code, 'reason:', e.reason);
  console.log('wasClean?', e.wasClean); // true 表示是正常握手关闭
};
// 常见 code:
// 1000:正常关闭
// 1006:连接被意外中断(如网络闪断),wasClean === false
// 4001+:自定义业务码,需和服务端约定
  • wasClean === false 是判断是否需要重连的关键指标
  • code === 1005 表示服务器没传关闭码,属于中性状态,一般不重连
  • 不要在 onerror 里直接 new WebSocket() 重连,容易雪崩;应节流 + 指数退避

close() 方法的 code 参数不是随便填的

socket.close(code, reason) 主动关闭时,code 必须是规范定义的整数(1000–4999),且 1000–2999 是 WebSocket 标准码,3000–4999 是应用自定义区间。填错会导致服务端无法识别关闭意图,甚至拒绝关闭握手。

常见误用:

  • 传字符串如 close('1000') → 握手失败,连接卡在 CLOSING 状态
  • 传非法码如 close(999) 或 close(5000) → 浏览器抛 SyntaxError
  • 不传 code(即 close())→ 默认用 1005(无状态码),服务端可能无法区分是用户退出还是异常

推荐写法:

// 正常退出
socket.close(1000, 'user logout');
// 临时故障需重连
socket.close(4001, 'reconnect soon');

实际项目里,code 的选择要和服务端协议对齐,否则 onclose 里的 event.code 会和预期不符 —— 这个细节在调试连接生命周期时最容易被忽略。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关专题

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

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

2023.06.20

3709

3

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

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

2023.07.25

2468

9

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

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

2023.08.02

1400

5

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

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

2023.08.09

1338

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

1436

5

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

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

2023.09.20

2398

7

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

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

2023.09.20

3960

8

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

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

2023.09.22

18835

6

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

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

2023.09.22

549

3

热门下载

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

精品课程

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