如何在Nuxt3中使用WebSocket Nuxt3服务端与客户端连接【笔记】

轻晨小哥_7177

轻晨小哥_7177

2026-05-28

256人浏览

原创

nuxt 3 中 nitro 默认不支持 websocket 服务,客户端直连 ws://localhost:3000/ws 会失败;需独立启动 ws 服务或通过反向代理(如 nginx)将 upgrade 请求透传至 nitro 的 definewebsockethandler 处理。

如何在nuxt3中使用websocket nuxt3服务端与客户端连接【笔记】

在 Nuxt 3 中,WebSocket 不能直接在服务端(Nitro)启动一个对外暴露的 WebSocket 服务器,除非你手动接管底层 HTTP server;客户端连接也**不能直接用 ws:// 地址直连 Nitro 的 dev server 或生产 server**——因为默认的 Nitro server 不处理 WebSocket 升级请求。必须明确区分“谁提供 WS 服务”和“谁消费 WS 连接”。

为什么 useWebSocket 或 new WebSocket() 在客户端报错 Connection refused?

常见现象是控制台抛出 Failed to construct 'WebSocket': The URL 'ws://localhost:3000/ws' is invalid 或连接后立刻 onclose。根本原因是:

  • Nitro 默认不监听或响应 Upgrade: websocket 请求,即使你在 nuxt.config.ts 里配了 @nuxtjs/proxy,它只代理 HTTP 请求,不代理 WebSocket 升级流量
  • ws://localhost:3000/xxx 想让 Nitro 自己当 WS 服务端?不行——Nitro 不是 ws 库的封装,它没有内置 WebSocket server 实现
  • 开发时浏览器访问 http://localhost:3000,但 ws://localhost:3000/ws 是另一个协议、另一层服务,必须有独立进程监听该端口并处理升级

所以,ws://localhost:3000/... 这类地址只在你**额外启动了一个 WebSocket 服务(如 ws、socket.io、Spring Boot WS endpoint)并确保端口可达**时才有效。

如何让客户端在 Nuxt 3 页面中安全建立 WebSocket 连接?

客户端代码本身没问题,关键在连接目标和生命周期管理:

  • 连接地址必须指向真实运行的 WebSocket 服务,例如 ws://localhost:8080/ws(后端 Node.js ws.Server),或 wss://api.example.com/chat(反向代理后的生产地址)
  • 不要在 setup() 或 onMounted 里无条件新建 WebSocket 实例——SSR 渲染时会报错,需用 process.client && ... 包裹
  • 务必手动清理:组件卸载时调用 socket.close(),否则可能残留连接、触发内存泄漏
  • 若用 socket.io-client,注意它默认启用自动重连,但需配合服务端正确配置 transports: ['websocket'] 避免降级到轮询

示例片段:

WebSocket 8.18.2
WebSocket 8.18.2

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

下载
onMounted(() => {
  if (!process.client) return
  const socket = new WebSocket('wss://your-ws-api.com/realtime')
  socket.onopen = () => console.log('connected')
  socket.onmessage = (e) => console.log(JSON.parse(e.data))
  
  onUnmounted(() => {
    socket.close()
  })
})

如何在 Nuxt 3 Nitro 服务端接收并处理 WebSocket 连接?

Nitro 从 v2.8+ 开始支持原生 WebSocket 路由,但仅限于 server/routes/*.ts 下定义的 defineWebSocketHandler,且只能处理已由反向代理(如 Nginx、Cloudflare、Caddy)或 Node.js 原生 server 升级后的连接,Nitro 自身不监听 TCP 端口。

  • 文件路径必须为 server/routes/ws.ts(后缀必须是 .ts 或 .js),内容使用 defineWebSocketHandler
  • 该 handler 不是“启动一个 WS 服务”,而是“处理已被升级的 WebSocket 请求的业务逻辑”,类似中间件
  • 必须搭配外部 server:比如用 node:http 启一个 server,把 upgrade 请求转发给 Nitro 的 handler;或者部署时用 Nginx 把 /ws 路径的 upgrade 请求透传到你的 Node 进程
  • 常见错误:直接访问 http://localhost:3000/ws 返回 404,是因为没配置反向代理,upgrade 请求压根没到达 Nitro 的 WebSocket handler

典型 server/routes/ws.ts:

export default defineWebSocketHandler({
  async upgrade(request) {
    // 可校验 token、session、origin 等
    if (!request.headers.get('sec-websocket-protocol')) {
      throw createError({ statusCode: 400, statusMessage: 'Missing protocol' })
    }
  },
  open(peer) {
    console.log('peer connected:', peer.id)
  },
  message(peer, message) {
    peer.send(`echo: ${message}`)
  }
})

代理 WebSocket 到后端服务时,@nuxtjs/proxy 已过时

该模块自 Nuxt 3.7+ 起被官方弃用,且它根本**不支持 WebSocket 代理**(其底层是 http-proxy-middleware,对 Upgrade 请求支持极弱)。现在应改用:

  • Nginx 配置:在 location 块中显式设置 proxy_http_version 1.1、proxy_set_header Upgrade $http_upgrade、proxy_set_header Connection "upgrade"
  • Caddy 2:天然支持 WebSocket 透传,只需 reverse_proxy + transport http 即可
  • Vercel / Netlify:不支持 WebSocket,必须换托管平台(如 Cloudflare Pages + Workers,或自建 Node 服务)

如果你坚持用本地开发代理,可用 nitro-dev-server 插件或直接写一个微型 Express 中间件挂载到 Nitro 的 server.handlers,但复杂度远高于直接起一个独立 ws 服务。

真正容易被忽略的一点:WebSocket 的鉴权不是靠 Cookie 自动携带的——new WebSocket(url) 不发送 Cookie,除非你显式配置 credentials: 'include'(但原生 API 不支持该选项),所以 token 必须放在 URL query 或首次 send() 的消息体里。Nitro 的 defineWebSocketHandler 中拿到的 request 是 upgrade request,能读 header 和 query,但无法像 HTTP route 那样用 event.context.auth——所有认证逻辑得自己手写解析。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

websocket

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.06.20

3029

3

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

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

2023.07.25

2268

9

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

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

2023.08.02

1200

5

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

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

2023.08.09

1158

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

2098

7

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

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

2023.09.20

3320

8

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

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

2023.09.22

14955

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人学习