登录
推荐 文章 Go 技术 课程 下载 专题 AI
首页 >  文章 >  前端

JavaScript WebSocket 怎样处理 close 事件的 code 和 reason

来源:17golang原创

时间:2026-11-19 20:21:33 239浏览 收藏

处理 JavaScript WebSocket 的 close 事件时,读取 event.code 判断关闭类别,用 event.reason 获取可能为空的说明,并单独记录 event.wasClean。不要把 reason 当成必填业务错误,不要从 wasClean 推断消息已经处理成功,也不要仅凭 1006 确定是断网、服务器故障还是握手失败。

WebSockets 标准地址:https://websockets.spec.whatwg.org/

我会先改关闭后的页面状态,再决定是否需要恢复连接。下面以“实时频道”的退出提示为设计示例,说明如何改造已有处理逻辑;这是对现有 API 使用方式的调整,不是浏览器新版本公告,也不声称来自某次线上故障实测。

从关闭后的页面状态改起

设想用户已经点击“退出频道”,页面随后收到 close。如果旧处理器对所有关闭都提示“网络错误,请重试”,用户会以为退出失败。另一个常见问题是把任何正常关闭都显示成“保存成功”,但连接结束与业务确认根本不是同一个条件。

我更倾向于让连接事件只负责连接状态:关闭后停止把该连接当成可发送通道,把待确认的业务状态留给业务协议处理。是否自动重连是另一个应用策略,不能由 close 事件名称替你决定。

这次改造的变化很小:在既有 close 监听器旁保留本地退出意图,并完整保存关闭字段。无需为此更换通信库,也不要把旧连接对象重新当成新连接。

把 code、reason 和 wasClean 分开理解

close 监听器接收 CloseEvent。code 是关闭码,reason 是关闭说明,wasClean 表达连接是否干净地关闭。这些基础定义见 MDN close 事件文档与 WebSockets 标准。

信息适合表达什么不能据此断言什么
code协议关闭类别或约定的应用码所有客户端可见的码都可传给 close()
reason可选的关闭说明一定存在,或一定是可解析的 JSON
wasClean关闭是否干净完成最后一条业务消息已落库
requestedStop本地用户是否请求退出这是 CloseEvent 自带字段
CloseEvent 三个字段与本地退出意图的分组结构
图1:静态结构说明图。连接事件分组说明 CloseEvent 与 code、reason、wasClean 的字段关系;应用意图分组保留独立的 requestedStop。图中连线不表示事件先后顺序。

1006 尤其值得谨慎处理:多种连接失败都可能对脚本呈现这个码,浏览器不会给页面公开所有底层细节。因此,“连接异常中断”是合适的页面描述,“一定是证书过期”则超出了字段所能证明的范围。诊断需要结合环境与服务端记录,而不是对同一个数值赋予唯一故障原因。

给现有连接增加关闭处理

下面的函数接收已有 socket 和用于提示的 statusNode,返回可以交给退出按钮调用的 stopChannel。它只绑定关闭处理,不创建网络连接、不自动重试。requestedStop 是这个绑定实例内的状态;下一条新连接需要重新调用函数创建自己的处理器。

function bindChannelClose(socket, statusNode) {
  let requestedStop = false;

  socket.addEventListener("close", (event) => {
    // 保留三个独立字段,reason 为空也是合法情况
    const report = {
      code: event.code,
      reason: event.reason,
      wasClean: event.wasClean,
      requestedStop
    };
    console.info("连接关闭记录", report);

    // 本地退出意图优先,避免主动退出后仍弹出重试提示
    if (requestedStop) {
      statusNode.textContent = "已退出实时频道";
    } else if (event.code === 1000) {
      statusNode.textContent = "实时频道已结束";
    } else if (event.code === 1006) {
      statusNode.textContent = "连接意外中断,请检查后重新连接";
    } else {
      statusNode.textContent = "实时连接已关闭,关闭码:" + event.code;
    }

    // 只作为纯文本补充显示,不把远端字符串当成 HTML
    if (event.reason) {
      statusNode.textContent += ";说明:" + event.reason;
    }
  }, { once: true });

  return function stopChannel() {
    // 这是本地应用状态,不能由 event.code 反推
    requestedStop = true;
    if (socket.readyState === WebSocket.OPEN ||
        socket.readyState === WebSocket.CONNECTING) {
      socket.close(1000, "user-left");
    }
  };
}

绑定应发生在创建连接后尽早的位置。示例假定传入的连接尚未完成关闭,statusNode 是有效页面元素;对一个早已关闭的对象事后添加监听器,不会补发过去的 close 事件。once: true 表达这份监听器只处理该对象的一次关闭。

字段记录和页面文案也应分工。code 与 wasClean 是结构化记录,reason 是补充说明。示例用 textContent 展示说明,避免把它误当 HTML。生产日志还应按项目要求处理可能包含敏感内容的说明文本。

本地点击退出与远端同时关闭可能相遇。这里的 requestedStop 只决定“用户已经要求退出,不再催促重连”的交互政策,并不证明是哪一端先发起协议关闭。这个取舍适合退出频道;需要审计发起方的系统不能拿它替代协议和服务端证据。

主动关闭时遵守参数限制

读取 event.code 与传入 socket.close(code, reason) 的允许范围不同。浏览器主动关闭时,可显式传入 1000 或 3000–4999 的整数;reason 按 UTF-8 编码不得超过 123 字节。中文字符占用的字节数与字符串长度不同,不能只检查 reason.length。参数约束见 MDN close() 文档。

function closeWithNote(socket, note) {
  // 这里固定使用正常关闭码,不把收到的任意 code 原样回传
  const reason = String(note);
  if (new TextEncoder().encode(reason).byteLength > 123) {
    throw new RangeError("关闭说明超过 UTF-8 字节限制");
  }
  socket.close(1000, reason);
}

上面的辅助函数让超长说明以明确的本地错误暴露,调用方应缩短或移除说明后处理。实际应用最好传简短、稳定的标记,并另外维护用户可读文案;示例的 user-left 就属于本项目自行选择的说明,不是标准保留词。

close() 启动关闭操作,并不等于同步完成关闭。不要在调用后立即报告“对方已经完成业务处理”。在关闭期间与最终关闭之后,也不要继续按 OPEN 状态发送业务消息。

主动关闭参数与事件结果的静态边界
图2:静态说明图。主动关闭分组包含 close()、code 参数和 reason 参数,结果观察分组包含 close 事件、readyState 和业务确认。业务确认独立存在,不能由连接结束替代。

迁移旧代码时核对这些分支

迁移旧代码时,我会先把“每次 close 都立即重连”移出监听器,再分别定义主动退出、正常结束和异常中断的页面状态。对于前后端约定的应用码,按你们的协议增加分支,不能把某个项目里的含义当成所有 WebSocket 服务的通用规则。

以下是预期行为对照,供你在自己的开发环境演练;它不是本次运行结果。本文示例未执行网络连接或本地测试。

  • 用户调用返回的 stopChannel:本地意图标记为退出,关闭提示不再催促恢复。
  • 收到 code 为 1000 且没有本地退出意图的事件:显示频道结束,不显示保存成功。
  • 收到 code 为 1006 的事件:显示异常中断,不自动断言单一根因。
  • 收到空 reason:保留基本关闭提示,不尝试 JSON.parse。
  • 主动关闭说明超长:调用方处理本地异常,不能把它登记成已经收到的远端关闭。

如果页面还维护定时任务,应把该连接所属任务的停止放进自己的资源管理逻辑。恢复连接时创建新实例并重建绑定,避免让旧连接的回调修改新连接的页面状态。

常见问题

reason 为空是服务端有问题吗?

不能这样判断。页面应能处理没有可用说明的关闭,把关闭码与本地上下文一起保留。

可以用 close(1006) 模拟异常关闭吗?

不可以,它不在浏览器主动 close 的有效参数范围内。读取到的事件码不能不加区分地作为主动关闭参数。

wasClean 为 true 就不需要检查业务消息了吗?

仍需按照业务协议检查消息确认。连接关闭状态只属于连接层;把它当成保存凭证会产生错误反馈。

声明:本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>