讲师中心 微信公众号
AI工具推荐 视频效率加速

如何在Next.js中使用WebSocket Next.js客户端集成WebSocket【指南】

落辰同学_6584

落辰同学_6584

发布时间:2026-05-24 08:41:59

|

239人浏览过

|

来源于php中文网

原创

Next.js中WebSocket只能在客户端组件useEffect内初始化并管理生命周期,服务端完全不支持;需用useRef存储实例、检查readyState后发送消息,并通过独立服务或现有后端提供WS端点。

Next.js客户端页面里直接用 WebSocket 就行,别碰服务端

next.js 的 app router 中,websocket 只能在客户端组件(或 "use client" 模块)里初始化,服务端组件(包括 generatestaticparams、fetch、getserversideprops)完全不支持。这不是限制,是浏览器 api 的天然边界——websocket 本质就是个 dom api,和服务端 runtime 无关。

常见错误:在服务端组件里写 new WebSocket(...),会直接报 ReferenceError: WebSocket is not defined;或者试图在 useEffect 外初始化连接,导致 hydration 不一致或多次重复连接。

  • 只在带 "use client" 的组件顶层作用域外、useEffect 内创建实例
  • 连接地址必须是真实可访问的 ws/wss URL(如 wss://echo.websocket.org),不能是 http://localhost:3000/api/ws 这类路径——那是 HTTP 路由,不是 WebSocket 端点
  • 如果用本地开发代理(比如 next.config.js 的 rewrites),它对 WebSocket 无效,得单独配反向代理或改用真实后端地址

useEffect 里建连接 + 清理是唯一可靠模式

手动管理 WebSocket 生命周期的关键是:连接在 useEffect 中建立,关闭逻辑放在返回的清理函数里。跳过这步,轻则内存泄漏,重则页面切走后还在发消息、收消息时 this.readyState === 0 报错。

示例片段(精简核心逻辑):

"use client";
import { useEffect, useRef } from 'react';

export default function Chat() {
  const socketRef = useRef<WebSocket | null>(null);

  useEffect(() => {
    const socket = new WebSocket("wss://your-ws-endpoint.com");
    socketRef.current = socket;

    socket.onopen = () => console.log("connected");
    socket.onmessage = (e) => console.log("received:", e.data);
    socket.onerror = (e) => console.error("ws error", e);

    return () => {
      if (socket.readyState === WebSocket.OPEN || socket.readyState === WebSocket.CONNECTING) {
        socket.close();
      }
    };
  }, []);

  return <div>Chat UI</div>;
}
  • useRef 存实例,避免 useState 触发重渲染,也防止闭包捕获旧 socket
  • 清理函数里判断 readyState 再关,避免调用 close() 时报 InvalidStateError
  • 不要在 onmessage 里直接更新 state(尤其用 useState),需加 if (!mounted) return 判断或用 useReducer + dispatch 配合 ref 控制

Next.js 13+ App Router 下无法用 getServerSideProps 或 API Route 做 WebSocket 服务端

Next.js 的 app/ 目录下,API Routes 是基于 Node.js 的 HTTP handler,不支持升级为 WebSocket 连接(即没法响应 Upgrade: websocket 请求头)。你写的 app/api/ws/route.ts 实际仍是普通 HTTP 接口,强行塞 WebSocket 服务逻辑会失败。

arcgis-js
arcgis-js

提供 ArcGIS Maps SDK for JavaScript 开发辅助,涵盖 2D/3D 地图视图、图层管理、数据可视化、空间分析等功能模块的参考和示例指导。

下载

正确做法只有两个:

  • 用独立服务:Node.js(ws 库)、Deno、NestJS、甚至云服务(Vercel Edge Functions 不支持 WS,但 AWS Lambda + API Gateway WebSocket API 支持)
  • 复用现有后端:如果你已有 Express/Fastify 服务,把 WebSocket endpoint 挂在上面,Next.js 客户端直连即可
  • 开发时想本地联调?别依赖 Next.js 启动的服务端,单独起一个 ws server(npx tsx ws-server.ts),前端连 ws://localhost:8080

消息发送前务必检查 socket.readyState === WebSocket.OPEN

网络抖动、页面切换、连接未就绪就发消息,都会导致 socket.send() 抛出 InvalidStateError: Failed to execute 'send' on 'WebSocket': Still in CONNECTING state。这个错误不会被 try/catch 捕获(它是异步抛出的),只能靠状态判断预防。

  • 发消息前加守卫:if (socket.readyState !== WebSocket.OPEN) return;
  • 更健壮的做法:封装一个 sendMessage 函数,内部用 queue 缓存未发消息,等 onopen 后批量 flush
  • 别依赖 onopen 回调里的 send —— 它可能比你预期早触发(比如服务端快速响应),而你的业务逻辑还没准备好

WebSocket 在 Next.js 里没魔法,它就是浏览器原生 API。真正容易卡住的,是误以为框架能帮你接管连接生命周期,或者试图绕过浏览器限制去“服务端建 WS”。把连接逻辑交给客户端、把服务端留给真正的 WebSocket 服务,事情就简单了。

热门AI工具

更多
PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

超级麦吉

一款通过数字员工协作完成调研、数据分析与文档制作的AI办公平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

相关专题

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

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

3469

2023.06.20

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

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

2408

2023.07.25

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

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

1340

2023.08.02

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

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

1278

2023.08.09

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

1396

2023.09.05

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

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

2298

2023.09.20

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

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

3740

2023.09.20

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

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

17435

2023.09.22

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

20

2026.10.28

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21.2万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn