Spring Cloud集成WebSocket教程 gateway网关配置方法【实战】

冬强小哥_3987

冬强小哥_3987

2026-05-30

493人浏览

原创

spring cloud gateway 的 websocket 路由必须使用 ws:// 或 lb:ws:// 协议前缀,跨域需配置 allowedoriginpatterns 并启用 add-to-simple-url-handler-mapping,socket.io 需覆盖 /socket.io 及其轮询路径,且过滤器仅作用于握手阶段。

spring cloud集成websocket教程 gateway网关配置方法【实战】

Spring Cloud Gateway 默认支持 WebSocket,但直接照搬 HTTP 路由配置会失败——连接建立后秒断、跨域报错、负载均衡不生效,根本原因是 WebSocket 升级流程与响应式模型的冲突没被处理。

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

Gateway 的 WebsocketRoutingFilter 只识别以 ws:// 或 wss:// 开头的 uri。如果写成 http:// 或省略协议,请求会被当成普通 HTTP 处理,握手失败。

  • uri: ws://192.168.1.100:8081 ✅ 正确,触发 WebSocket 代理逻辑
  • uri: http://192.168.1.100:8081 ❌ 转发为 HTTP,后端收不到 Upgrade 请求
  • uri: lb://socketio-service ❌ 缺少协议,网关无法识别为 WebSocket 流量
  • 正确写法应为 uri: lb:ws://socketio-service,其中 lb:ws:// 是 Gateway 特有语法,表示“走负载均衡的 WebSocket”

CorsWebFilter 在 WebSocket 握手阶段会抛 UnsupportedOperationException

错误日志里出现 ReadOnlyHttpHeaders.put 报空指针或不支持操作,基本就是这个原因:Netty 在完成 WebSocket 升级响应时已提交 headers,而全局 CORS 过滤器仍试图修改它。

frigatebird
frigatebird

使用 frigatebird npm 包在命令行与 X 交互,提供类鸟命令对等、发布/回复/文章功能以及列表自动化,且无需 X API 密钥。

下载
  • 不要用传统的 allowedOrigins(已过时),改用 allowedOriginPatterns
  • 必须开启 add-to-simple-url-handler-mapping: true,否则跨域配置对 WebSocket 不生效
  • 配置需放在 globalcors 下,且路径匹配要覆盖 WebSocket 握手路径(如 /socket.io/**)
  • 示例关键项:
    spring:
      cloud:
        gateway:
          globalcors:
            add-to-simple-url-handler-mapping: true
            cors-configurations:
              '[/socket.io/**]':
                allowedOriginPatterns: "*"
                allowedMethods: ["GET", "OPTIONS"]
                allowCredentials: true

Socket.IO 等封装库需要绕过默认心跳和路径重写

Socket.IO 客户端默认带查询参数(?EIO=4&transport=polling)并频繁发起 HTTP 轮询升级,Gateway 的 Path 断言若只配 /socket.io/**,会漏掉初始 polling 请求;同时其心跳包可能被某些过滤器(如超时设置)中断。

  • 务必把断言扩展到根路径:- Path=/socket.io/**, /socket.io(注意末尾无斜杠的原始路径)
  • 禁用可能干扰长连接的过滤器:比如 RetryGatewayFilterFactory、自定义超时 WriteResponseFilter 等
  • 避免使用 RewritePath 过滤器重写 WebSocket 路径——重写后 Sec-WebSocket-Key 等头可能失效
  • 若后端是 Socket.IO Server,建议在网关层关闭自动压缩:
    spring:
      cloud:
        gateway:
          httpclient:
            compress: false

最易被忽略的是:WebSocket 连接建立后,所有数据帧都绕过 Gateway 的大部分过滤器链,只走 WebsocketRoutingFilter。这意味着你在路由里加的鉴权、日志、Header 修改等局部过滤器,对实际消息传输完全无效——它们只作用于握手阶段那一个 HTTP 请求。

相关文章

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

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

下载

相关标签:

websocket gate

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

相关专题

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

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

2023.06.20

3209

3

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

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

2023.07.25

2328

9

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

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

2023.08.02

1260

5

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

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

2023.08.09

1218

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

1356

5

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

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

2023.09.20

2178

7

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

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

2023.09.20

3500

8

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

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

2023.09.22

15955

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