Spring Cloud Gateway转发WebSocket教程 网关配置WS路由方法

云涛君_4222

云涛君_4222

2026-05-29

923人浏览

原创

spring cloud gateway 必须显式配置 ws:// 或 wss:// 协议路由,uri 不可为 http://,需匹配 upgrade 头、避免 stripprefix,建议直连或 lb:ws:// 并确保后端正确处理 websocket 握手。

spring cloud gateway转发websocket教程 网关配置ws路由方法

Spring Cloud Gateway 默认不自动代理 WebSocket 请求,必须显式配置 ws:// 或 wss:// 协议的路由,否则客户端连接会立即断开,报 java.lang.UnsupportedOperationException 或 404/503。

WebSocket 路由必须用 ws:// 或 wss:// 协议写死 uri

Gateway 不会把 http:// 自动升级为 WebSocket,也不能靠过滤器“改协议”。uri 字段必须明确以 ws:// 或 wss:// 开头,否则请求会被当作普通 HTTP 处理,触发协议不匹配错误。

  • uri: http://backend:8080 → ❌ 一定失败,即使后端支持 WebSocket
  • uri: ws://backend:8080 → ✅ 正确,直连模式
  • uri: lb:ws://message-service → ✅ 正确,服务发现模式(需启用 spring.cloud.gateway.discovery.locator.enabled=true)
  • uri: lb://message-service → ❌ 协议缺失,Gateway 不识别为 WebSocket 流量

Path 断言要匹配 Upgrade 请求头,不能只靠路径

WebSocket 握手本质是 HTTP GET + Upgrade: websocket 头。Gateway 的 Path 断言只校验路径,但后端服务可能依赖完整路径(如 /ws/{userId})。如果目标服务要求路径带参数或固定前缀,StripPrefix 过滤器不能用于 WebSocket 路由——它会破坏 Sec-WebSocket-Key 等关键头,导致握手失败。

gate-info-macroimpact
gate-info-macroimpact

通过Gate-Info和Gate-News MCP进行宏观驱动的加密货币分析,用于CPI、NFP、美联储、利率、工资等宏观因素与加密货币、日历或指标的关联。

下载
  • ✅ 推荐写法:- Path=/ws/**,后端监听 /ws 路径,不依赖 StripPrefix
  • ❌ 避免写法:- Path=/api/ws/** + StripPrefix=2 → 可能丢掉必要路径段或干扰头
  • ⚠️ 注意:某些旧版 Spring Boot(如 2.7.x)对带查询参数的 WebSocket 路径支持不稳定,建议路径尽量简洁,参数改用连接后消息体传递

生产环境必须加 SetResponseHeader 过滤器

部分客户端(尤其是浏览器)在收到响应时,会对 Sec-WebSocket-Accept 头缺失或格式异常敏感,导致连接建立后秒断。Gateway 默认不透传或重写该头,需手动添加过滤器确保响应头合规。

  • YAML 配置示例:
    filters:<br>  - SetResponseHeader=Sec-WebSocket-Accept,{{value}}
    (实际不推荐硬编码值,应让后端生成)
  • ✅ 更稳妥做法:去掉该 filter,改用 preserveHostHeader: true 并确保后端正确处理原始 Sec-WebSocket-Key
  • ⚠️ 如果后端是 Spring Boot WebSocket(@EnableWebSocket),它会自动计算并设置 Sec-WebSocket-Accept,此时 Gateway 只需透传所有响应头,不要干预

lb:ws:// 依赖服务注册名和健康检查

使用 lb:ws://service-id 时,Gateway 会通过 LoadBalancer 查找实例,但默认不检查 WebSocket 端口是否就绪。若服务刚启动、WebSocket handler 尚未初始化,Gateway 可能将请求转发到不可用节点,返回 503 或空响应。

  • 必须确认注册中心(如 Nacos/Eureka)中该服务的元数据包含 WebSocket 端口(例如 websocket.port=8081),且健康检查端点(/actuator/health)返回 UP 时,WebSocket 实际已可连接
  • 建议在服务启动类中增加简单就绪探针,例如监听 /ws/ready 返回 200,再接入 Gateway 的 readiness probe
  • 调试时可临时切回 ws://ip:port 直连,排除服务发现层干扰

最容易被忽略的是:WebSocket 连接建立后,心跳帧(ping/pong)和长连接保活完全由客户端和服务端协商控制,Gateway 不参与也不感知;一旦连接建立成功,后续所有帧都直接透传,任何中间网络设备(如 SLB、Nginx)也必须开启 WebSocket 支持,否则会在空闲几秒后静默断连。

相关文章

路由优化大师
路由优化大师

路由优化大师是一款及简单的路由器设置管理软件,其主要功能是一键设置优化路由、屏广告、防蹭网、路由器全面检测及高级设置等,有需要的小伙伴快来保存下载体验吧!

下载

相关标签:

websocket 路由 gate

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

相关专题

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

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

2023.06.20

3009

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

14855

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