Spring Cloud Gateway配置WebSocket教程 统一网关转发WebSocket请求【实战】

雨晨大大_7769

雨晨大大_7769

2026-06-02

753人浏览

原创

Spring Cloud Gateway 默认不支持 WebSocket 转发,直接配置 ws:// 或 lb:ws:// 才正确;若误用 http:// 或 lb:// 会导致握手后秒断,报 UnsupportedOperationException,根源在于 Netty 升级流程被 NettyRoutingFilter 提前消费请求头,且 globalcors 对 WebSocket 跨域无效,需后端服务自身控制 Origin 校验。

spring cloud gateway配置websocket教程 统一网关转发websocket请求【实战】

Spring Cloud Gateway 默认不支持 WebSocket 转发,直接配 ws:// 或 lb:ws:// 会连接成功但秒断,报 java.lang.UnsupportedOperationException —— 根本原因是 Netty 的 HTTP/1.1 连接升级流程被过滤器或默认配置中途拦截了。

WebSocket 路由必须用 lb:ws:// 或 ws://,不能用 http:// 或 lb://

网关识别 WebSocket 请求靠的是协议头(Upgrade: websocket)和路径匹配,但底层转发必须走 WebSocket 协议栈。如果写成 http://service-name 或 lb://service-name,Gateway 会当成普通 HTTP 请求处理,握手后无法维持长连接,导致客户端收到 101 状态码后立刻断开。

  • uri: ws://192.168.1.100:8080:适用于单实例、固定 IP/端口的调试场景
  • uri: lb:ws://message-service:生产环境首选,依赖 Nacos/Eureka 注册中心自动发现实例
  • 绝对禁止:uri: http://message-service、uri: lb://message-service —— 这两类配置看似能启动,但 WebSocket 握手后数据帧会被丢弃

必须关闭默认的 NettyRoutingFilter 干预行为

Gateway 内置的 NettyRoutingFilter 会在请求转发前尝试读取完整 body,这对 WebSocket 的 Upgrade 流程是致命的:它会提前 consume 掉 Upgrade header 和 handshake payload,导致后端服务收不到合法握手请求。

  • 在 application.yml 中显式禁用该 filter:
    spring:
      cloud:
        gateway:
          default-filters:
            - DedupeResponseHeader=Access-Control-Allow-Credentials Access-Control-Allow-Origin
          routes:
            - id: ws-message
              uri: lb:ws://message-service
              predicates:
                - Path=/ws/**
              filters:
                - StripPrefix=1
                # 关键:跳过 NettyRoutingFilter 的 body 解析逻辑
                - name: RequestRateLimiter
                  args:
                    key-resolver: "#{@ipKeyResolver}"
                    redis-rate-limiter.replenishRate: 10
                    redis-rate-limiter.burstCapacity: 20
  • 更稳妥的做法是自定义一个空的 WebFilter,在 NettyRoutingFilter 前插入并标记 WebSocket 请求跳过解析(需 Java 配置)
  • 常见现象:控制台没报错,但浏览器 Network 面板显示 WebSocket 连接状态为 101 Switching Protocols 后立即变成 closed,就是这个原因

跨域与 CORS 配置不能只靠 globalcors

globalcors 只作用于 HTTP 请求,对 WebSocket 握手阶段的 Origin 校验无效。WebSocket 的跨域控制实际由后端服务决定,网关只能透传 Origin 头,不能替后端做决策。

WebSocket 8.18.2
WebSocket 8.18.2

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

下载
  • 网关侧只需确保不删掉 Origin 头:
    filters:
      - StripPrefix=1
      - SetRequestHeader=Origin, "{origin}"
    (如果前端带了 Origin)
  • 真正起作用的是后端 WebSocket 服务的配置,例如 Spring Boot 的 setAllowedOrigins("*") 或白名单校验逻辑
  • 若后端未放开跨域,网关即使配了 allowedOrigins: "*" 也无济于事;错误表现是握手返回 403,而不是 101

负载均衡下 Socket.IO 等封装库容易失败

Socket.IO 不是原生 WebSocket,它依赖 HTTP 轮询 + WebSocket 混合降级,并自带心跳、session 绑定等机制。Gateway 的负载均衡默认按请求分发,会导致客户端首次轮询到 A 实例、后续 upgrade 到 B 实例,session 断开。

  • 解决方案一:强制 sticky session,Nacos 开启 ip:port 作为 instanceId,避免实例复用
  • 解决方案二:改用原生 WebSocket 协议(new WebSocket("ws://...")),绕过 Socket.IO 的复杂握手流程
  • 解决方案三:在网关加 CookieSameSite=Strict + 后端共享 session 存储(如 Redis),但成本高且非银弹
  • 验证方式:抓包看 /socket.io/?EIO=... 请求是否始终落到同一台后端机器

最易被忽略的一点:WebSocket 路由的 Predicate 必须精确匹配握手路径,比如后端监听 /ws,就绝不能配 Path=/ws/** 后又在 filter 里 StripPrefix=2 —— 这会让实际转发路径变成 /,后端收不到 upgrade 请求。

相关专题

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

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

2023.06.20

3849

3

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

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

2023.07.25

2508

9

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

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

2023.08.02

1440

5

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

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

2023.08.09

1378

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

1456

5

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

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

2023.09.20

2438

7

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

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

2023.09.20

4100

8

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

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

2023.09.22

19635

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

569

3

热门下载

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

精品课程

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

共0课时 | 0人学习

Webman中文手册
Webman中文手册

共0课时 | 0人学习