前言
之前的项目使用的是Zuul网关,有个需求需要用到WebSocket,所以一直在查Spring Cloud Zuul 转发 WebSocket请求的教程和文章,查来查去,发现不行,Zuul对WebSocket的支持不是很友好。
总结下来就是以下几点:
- 高版本的websocket在第一次http请求后,使用的是更快速的tcp连接,zuul网关只能管理http请求,并且不支持tcp以及udp请求
- zuul转发websocket时,会将websocket降级为http请求转发掉(轮询的方式,效率不是很理想),换句话说就是不支持转发长连接,zuul2好像可以。
这让我很发愁,毕竟我是一个强迫症,做自己的项目,当然不能凑活,于是我就找其他办法,在查的偶然间,我发现他们说Spring Cloud Gateway 支持转发WebSocket,我眼睛一亮,但是换网关,也不能说换就换,就搜了搜能不能在Zuul的基础上想想办法,网上的办法有很多,但可惜我觉得都不理想,没有办法,换Gateway吧,话不多说,上教程。
第一步,引入Gateway的 maven依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</exclusion>
</exclusions>
</dependency>
在这里要说个坑(敲黑板,划重点了)由于Gateway自带Netty,和tomcat冲突,所以看上面,第二个依赖,spring-boot-starter-websocket 这个里面自带spring-boot-starter-web jar包,而spring-boot-starter-web jar包里面包含tomcat一系列jar包,所以这里要给排除掉,不然启动会报错,如果依然报错,看看报错提示,是不是提示netty和tomcat冲突,在找找其他jar包里有没有包含tomcat的,排除掉。
第二步,依赖引入完毕,那么开始写配置文件
Gateway 有两种方式,一种是配置文件,一种是拦截器
下面是yml文件的配置
spring:
cloud:
#spring-cloud-gateway
gateway:
routes:
- id: xxx #路由的id,参数配置不要重复,如不配置,Gateway会使用生成一个uuid代替。
uri: lb://xxx #lb:// 表示从注册中心获取路径进行转发,xxx是注册在注册中心的微服务的名称
predicates:
- Path=/xxx/** #符合该路径后,转发
#WebSocket转发配置
- id: xxx
uri: lb:ws://xxx #lb:ws://xxx 表示从注册中心获取路径转发,并且请求协议换成ws
predicates:
- Path=/xxx/**
好了,配置文件写好了,- Path=/xxx/** 设置好断言,如果你的请求路径符合这个规则,Gateway就会进行相应的转发,是不是很简单,但是这里有个问题,普通的转发无所谓,到这里就结束了,可是WebSocket的转发,会有点问题,我使用的是SockJS + Stomp + WebSocket,在这里就要简单介绍一下 SockJS、Stomp、WebSocket了。
WebSocket
-
WebSocke是 HTML5 提供的一种在单个 TCP 连接上进行全双工通讯的协议。
-
WebSocket协议是基于TCP的一种新的网络协议,是一个应用层协议,是TCP/IP协议的子集。
-
它实现了浏览器与服务器全双工(full-duplex)通信,客户端和服务器都可以向对方主动发送和接收数据。在 WebSocket API 中,浏览器和服务器只需要完成一次握手,两者之间就直接可以创建持久性的连接,并进行双向数据传输。
-
在JS中创建WebSocket后,会有一个HTTP请求从浏览器发向服务器。在取得服务器响应后,建立的连接会使用HTTP升级将HTTP协议转换为WebSocket协议。也就是说,使用标准的HTTP协议无法实现WebSocket,只有支持那些协议的专门浏览器才能正常工作。由于WebScoket使用了自定义协议,所以URL与HTTP协议略有不同。未加密的连接为ws://,而不是http://。加密的连接为wss://,而不是https://,所以如果你的项目使用了网关,又想使用WebSocket,在网关转发这方面,就会遇到问题。
SockJS
- SockJS是一个浏览器JavaScript库,它提供了一个连贯的、跨浏览器的JavaScript API,在浏览器和web服务器之间建立一个低延迟、全双工、跨域通信通道。SockJs的一大好处是提供了浏览器兼容性,优先使用原生的WebSocket,在不支持websocket的浏览器中,会自动降为轮询的方式。
Stomp
-
STOMP(Simple Text-Orientated Messaging Protocol),中文为:面向消息的简单文本协议
-
websocket定义了两种传输信息类型:文本信息和二进制信息。类型虽然被确定,但是他们的传输体是没有规定的。所以,需要用一种简单的文本传输类型来规定传输内容,它可以作为通讯中的文本传输协议。
-
STOMP是基于帧的协议,客户端和服务器使用STOMP帧流通讯
-
一个STOMP客户端是一个可以以两种模式运行的用户代理,可能是同时运行两种模式。
-
作为生产者,通过SEND框架将消息发送给服务器的某个服务
-
作为消费者,通过SUBSCRIBE制定一个目标服务,通过MESSAGE框架,从服务器接收消息。
总结
- SockJS 提供了浏览器兼容性,在不支持WebSocket的浏览器中,会自动降为轮询的方式。
- Stomp 简单理解就是规定了传输内容,作为通讯中的文本传输协议;这个我也是看的一知半解,但是我觉得如果你对WebSocket了解足够多的话,你就清楚为什么要用它。
- WebSocket 实现了浏览器与服务器全双工通信,客户端和服务器都可以向对方主动发送和接收数据,而且第一次建立WebSocket的连接的协议是HTTP或HTTPS协议,url使用的是http://或https://,建立成功之后,url使用的是ws://或wss://。
看到这里,你大概就明白了,我说的问题在哪里了(划重点)
由于WebSocket第一次连接使用的是http协议或者是https协议,并且咱们的配置文件还是这样配置的:
- id: xxx
uri: lb:ws://xxx #lb:ws://xxx 表示从注册中心获取路径转发,并且请求协议换成ws
predicates:
- Path=/xxx/**
这样配置的意思就是,如果符合 - Path=/xxx/** 这个地址路径,那么就会转换成WebSocket协议来进行转发请求。
如果你的项目没有网关,前端的WebSocket建立请求会直接请求到你的WebSocket服务上,成功建立连接。
如果你的项目有网关,而且你还这样配置了转发规则,那么前端的每一次WebSocket请求都会以url是ws://或wss://这个路径进行转发请求,连接就不会建立成功。
那么这个时候就要做一下特殊处理,话不多说,上代码。
第三步,拦截第一次WebSocket请求,做特殊处理。
import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.http.HttpHeaders;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import org.springframework.web.util.UriComponentsBuilder;
import reactor.core.publisher.Mono;
import