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

Spring Cloud微服务中如何使用WebSocket WebSocket网关转发配置【详细】

星辰同学_1294

星辰同学_1294

发布时间:2026-05-31 13:06:35

|

303人浏览过

|

来源于php中文网

原创

Spring Cloud Gateway需显式配置WebSocket路由,uri必须用ws://或lb:ws://协议前缀,且需透传Sec-WebSocket-Key等关键Header,路径断言应兼容查询参数,负载均衡下需确保会话粘性。

spring cloud微服务中如何使用websocket websocket网关转发配置【详细】

Spring Cloud Gateway 默认不自动处理 WebSocket 请求,必须显式配置路由和过滤器才能完成代理转发。如果你的前端连不上后端 WebSocket 服务,大概率不是后端没写好,而是网关拦住了升级请求。


WebSocket 路由必须用 ws:// 或 lb:ws:// 协议前缀

WebsocketRoutingFilter 只识别以 ws://、wss:// 或 lb:ws://、lb:wss:// 开头的 uri。用 http:// 或 lb://(缺 ws)会导致请求被当成普通 HTTP 转发,握手失败,浏览器报错 Unexpected response code: 200 或直接断开。

  • ✅ 正确写法:

    uri: ws://192.168.1.100:8080/websocket
    uri: lb:ws://message-service
  • ❌ 错误写法:

    uri: http://192.168.1.100:8080/websocket
    uri: lb://message-service

注意:lb:ws:// 要求服务已注册到 Nacos/Eureka,且服务实例实际提供的是 WebSocket 端点(如 /websocket),不是 HTTP 接口。


跨域失败?别只配 CorsConfiguration,网关层要透传关键 Header

WebSocket 握手是 HTTP 请求,但涉及多个特殊 Header,比如:

  • Sec-WebSocket-Key
  • Sec-WebSocket-Version
  • Connection: Upgrade
  • Upgrade: websocket

如果网关过滤器(如自定义的 CorsWebFilter)或全局配置清除了这些 Header,握手就会被后端拒绝,报错 Invalid request: missing Sec-WebSocket-Key。

  • 必须确保网关不 strip 这些字段:
    • 不要在 GlobalFilter 中调用 exchange.getRequest().mutate().headers(...) 覆盖原始 headers
    • 如果用了 allowedOrigins: ["*"],在生产环境要改成具体域名,否则某些浏览器会拒绝带凭证的 WebSocket 连接
    • 若后端是 Spring Boot 的 @ServerEndpoint 实现(非 STOMP),它不解析 Origin,但网关仍需透传,否则某些反向代理(如 Nginx)会拦截

示例安全的跨域放行(仅限开发):

spring:
  cloud:
    gateway:
      globalcors:
        cors-configurations:
          '[/**]':
            allowed-origins: "http://localhost:3000"
            allowed-methods: "*"
            allowed-headers: "*"
            allow-credentials: true

Path 断言要匹配完整握手路径,不能漏掉查询参数

WebSocket 客户端连接时 URL 常带参数,例如:

WebSocket 8.18.2
WebSocket 8.18.2

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

下载

ws://gateway:8080/ws?token=abc&uid=1001

而你的路由只写了:

- Path=/ws/**

这个断言能匹配路径,但不保证查询参数透传——默认是透传的,但一旦你加了 StripPrefix 过滤器,就可能把整个 path 截断,导致后端收不到 token。

  • 如果后端依赖 query 参数鉴权,不要用 StripPrefix=1
  • 更稳妥的方式是显式保留:
    filters:
    - StripPrefix=0
  • 或者改用更精确的断言(推荐):
    - Path=/ws
    这样既匹配 /ws,也兼容 /ws?...,避免路径截断引发的参数丢失

负载均衡下 WebSocket 连接不稳定?检查心跳与粘性会话

lb:ws://service-name 走的是 Ribbon 或 Spring Cloud LoadBalancer,默认轮询。但 WebSocket 是长连接,一次握手建立后,后续帧应始终打到同一实例,否则会因 session 不存在而断开。

  • Netty + Socket.IO 类服务:自带心跳,但网关层若超时关闭空闲连接,就会中断。需调大:

    spring:
    cloud:
      gateway:
        httpclient:
          pool:
            max-idle-time: 300000  # 5分钟
            max-life-time: 600000   # 10分钟
          connect-timeout: 5000
          response-timeout: 60s
  • 若服务本身不支持共享 session(如纯 @ServerEndpoint),必须启用 sticky session,Nacos 不支持,得换用 Kubernetes Service + SessionAffinity,或在网关层用 Weight + 固定 IP 路由(见知识库中多节点直连写法)

最易被忽略的一点:WebSocket 连接建立后,网关不会主动刷新连接池中的 channel,旧连接可能复用已关闭的底层 TCP,建议配合健康检查 + 主动 close idle connection。


真实项目里,WebSocket 转发失败十次有八次是因为 uri 写成 http 或漏了 ws,剩下两次是 header 被过滤或路径断言太窄。先盯死这三处,比调一堆过滤器更快定位问题。

热门AI工具

更多
PixTV
PixTV Hot

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

WorkBuddy

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

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

豆包大模型

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

切问学术

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

UpDream
UpDream Hot

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

DeepSeek

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

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

相关专题

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

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

2989

2023.06.20

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

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

2268

2023.07.25

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

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

1200

2023.08.02

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

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

1138

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,随机排序。

1336

2023.09.05

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

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

2098

2023.09.20

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

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

3300

2023.09.20

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

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

14815

2023.09.22

Kratos框架HTTP与gRPC服务开发教程
Kratos框架HTTP与gRPC服务开发教程

本专题围绕Kratos框架双协议服务开发,涵盖HTTP路由与处理器编写、参数获取、gRPC服务实现与客户端调用、metadata上下文传递、encoding编解码注册、统一响应封装、超时控制与流式响应实现方法。

0

2026.10.10

热门下载

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

精品课程

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

共0课时 | 0人学习

Webman中文手册
Webman中文手册

共0课时 | 0人学习

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

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