解决SpringCloud Gateway配置自定义路由404的坑
问题背景
将原有项目中的websocket模块迁移到基于SpringCloud Alibaba的微服务系统中,其中网关部分使用的是gateway。
问题现象
迁移后,我们在使用客户端连接websocket时报错:
io.netty.handler.codec.http.websocketx.WebSocketHandshakeException: Invalid subprotocol. Actual: null. Expected one of: protocol
...
同时,我们还有一个用py写的程序,用来模拟客户端连接,但是程序的websocket连接就是正常的。
解决过程
1 检查网关配置
先开始,我们以为是gateway的配置有问题。
但是在检查gateway的route配置后,发现并没有问题。很常见的那种。
... gateway: routes: #表示websocket的转发 - id: user-service-websocket uri: lb:ws://user-service predicates: - Path=/user-service/mq/** filters: - StripPrefix=1
其中,lb指负载均衡,ws指定websocket协议。
ps,如果,这里还有其他协议的相同路径的请求,也可以直接写成:
... gateway: routes: #表示websocket的转发 - id: user-service-websocket uri: lb://user-service predicates: - Path=/user-service/mq/** filters: - StripPrefix=1
这样,其他协议的请求也可以通过这个规则进行转发了。
2 跟源码,查找可能的原因
既然gate的配置没有问题,那我们就尝试从源码的角度,看看gateway是如何处理ws协议请求的。
首先,我们要对“gateway是如何工作的”有个大概的认识:
可见,在收到请求后,要先经过多个Filter才会到达Proxied Service。其中,要有自定义的Filter也有全局的Filter,全局的filter可以通过GET请求/actuator/gateway/globalfilters来查看
{ "org.springframework.cloud.gateway.filter.LoadBalancerClientFilter@77856cc5": 10100, "org.springframework.cloud.gateway.filter.RouteToRequestUrlFilter@4f6fd101": 10000, "org.springframework.cloud.gateway.filter.NettyWriteResponseFilter@32d22650": -1, "org.springframework.cloud.gateway.filter.ForwardRoutingFilter@106459d9": 2147483647, "org.springframework.cloud.gateway.filter.NettyRoutingFilter@1fbd5e0": 2147483647, "org.springframework.cloud.gateway.filter.ForwardPathFilter@33a71d23": 0, "org.springframework.cloud.gateway.filter.AdaptCachedBodyGlobalFilter@135064ea": 2147483637, "org.springframework.cloud.gateway.filter.WebsocketRoutingFilter@23c05889": 2147483646 }
可以看到,其中的WebSocketRoutingFilter似乎与我们这里有关
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) { this.changeSchemeIfIsWebSocketUpgrade(exchange); URI requestUrl = (URI)exchange.getRequiredAttribute(ServerWebExchangeUtils.GATEWAY_REQUEST_URL_ATTR); String scheme = requestUrl.getScheme(); if (!ServerWebExchangeUtils.isAlreadyRouted(exchange) && ("ws".equals(scheme) || "wss".equals(scheme))) { ServerWebExchangeUtils.setAlreadyRouted(exchange); HttpHeaders headers = exchange.getRequest().getHeaders(); HttpHeaders filtered = HttpHeadersFilter.filterRequest(this.getHeadersFilters(), exchange); List<String> protocols = headers.get("Sec-WebSocket-Protocol"); if (protocols != null) { protocols = (List)headers.get("Sec-WebSocket-Protocol").stream().flatMap((header) -> { return Arrays.stream(StringUtils.commaDelimitedListToStringArray(header)); }).map(String::trim).collect(Collectors.toList()); } return this.webSocketService.handleRequest(exchange, new WebsocketRoutingFilter.ProxyWebSocketHandler(requestUrl, this.webSocketClient, filtered, protocols)); } else { return chain.filter(exchange); } }
以debug模式跟踪到这里后,可以看到,客户端请求中,子协议指定为“protocol”。
netty相关:
WebSocketClientHandshaker
WebSocketClientHandshakerFactory
这段烂尾了。。。
直接看结论吧
最后发现出错的原因是在netty的WebSocketClientHandshanker.finishHandshake
public final void finishHandshake(Channel channel, FullHttpResponse response) { this.verify(response); String receivedProtocol = response.headers().get(HttpHeaderNames.SEC_WEBSOCKET_PROTOCOL); receivedProtocol = receivedProtocol != null ? receivedProtocol.trim() : null; String expectedProtocol = this.expectedSubprotocol != null ? this.expectedSubprotocol : ""; boolean protocolValid = false; if (expectedProtocol.isEmpty() && receivedProtocol == null) { protocolValid = true; this.setActualSubprotocol(this.expectedSubprotocol); } else if (!expectedProtocol.isEmpty() && receivedProtocol != null && !receivedProtocol.isEmpty()) { String[] var6 = expectedProtocol.split(","); int var7 = var6.length; for(int var8 = 0; var8 < var7; ++var8) { String protocol = var6[var8]; if (protocol.trim().equals(receivedProtocol)) { protocolValid = true; this.setActualSubprotocol(receivedProtocol); break; } } } if (!protocolValid) { throw new WebSocketHandshakeException(String.format("Invalid subprotocol. Actual: %s. Expected one of: %s", receivedProtocol, this.expectedSubprotocol)); } else { ...... } }
这里,当期望的子协议类型非空,而实际子协议不属于期望的子协议时,会抛出异常。也就是文章最初提到的那个。
3 异常原因分析
客户端在请求时,要求子协议为“protocol”,而我们的后台websocket组件中,并没有指定使用这个子协议,也就无法选出使用的哪个子协议。因此,在走到finishHandShaker时,netty在检查子协议是否匹配时抛出异常WebSocketHandshakeException。 py的模拟程序中,并没有指定子协议,也就不会出错。
而在springboot的版本中,由于我们是客户端直连(通过nginx转发)到websocket服务端的,因此也没有出错(猜测是客户端没有检查子协议是否合法)。。。
解决方法
在WebSocketServer类的注解@ServerEndpoint中,增加subprotocols={“protocol”}
@ServerEndpoint(value = "/ws/asset",subprotocols = {"protocol"})
随后由客户端发起websocket请求,请求连接成功,未抛出异常。
与客户端的开发人员交流后,其指出,他们的代码中,确实指定了子协议为“protocol”,当时随手写的…
心得
- 定位问题较慢,中间走了不少弯路。有优化的空间;
- 对gateway的模型有了更深刻的理解;
- idea 可以用双击Shift键来查找所有类,包括依赖包中的。
以上为个人经验,希望能给大家一个参考,也希望大家多多支持猪先飞。
相关文章
基于springcloud异步线程池、高并发请求feign的解决方案
这篇文章主要介绍了基于springcloud异步线程池、高并发请求feign的解决方案,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2021-02-25- 这篇文章主要介绍了vue 实现动态路由的方法,文中示例代码非常详细,帮助大家更好的理解和学习,感兴趣的朋友可以了解下...2020-07-06
完美解决SpringCloud-OpenFeign使用okhttp替换不生效问题
这篇文章主要介绍了完美解决SpringCloud-OpenFeign使用okhttp替换不生效问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2021-02-25- 这篇文章主要介绍了详解SpringCloudGateway内存泄漏问题,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2020-07-16
解决vue动态路由异步加载import组件,加载不到module的问题
这篇文章主要介绍了解决vue动态路由异步加载import组件,加载不到module的问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2020-07-27如何解决springcloud feign 首次调用100%失败的问题
这篇文章主要介绍了如何解决springcloud feign 首次调用100%失败的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-06-23解决php导致nginx报502 bad gateway错误问题
502 bad gateway这个问题很多朋友一看就以为是nginx或apache的问题,其实不然了,除了它们两会出现这个问题之外还有像php模块也会导致此问题的出现了,下面一起来看看吧....2016-11-25- 这篇文章主要介绍了解决vue-router路由拦截造成死循环问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2020-08-05
- 这篇文章主要给大家介绍了关于vue.js Router中嵌套路由的相关资料,所谓嵌套路由就是路由里面嵌套他的子路由,文章通过示例代码介绍的非常详细,需要的朋友可以参考下...2021-06-27
- 这篇文章主要介绍了vue-router路由参数刷新消失的问题...2017-06-24
- 这篇文章主要介绍了spring cloud gateway中如何读取请求参数的操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-07-15
- 这篇文章主要介绍了vue-router为激活的路由设置样式操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2020-07-18
- 这篇文章主要介绍了Vue鼠标滚轮滚动切换路由效果的实现方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2021-08-04
- 502 bad gateway是php-fpm的问题对于这个问题就是配置参数的问题了,下面我们整理了一些关于php-fpm错误问题的解决办法,具体如下。 今天升级完PHP出现了502 Bad Gat...2016-11-25
- 这篇文章主要介绍了springboot中nacos动态路由的配置方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-09-11
解决SpringCloud Feign传对象参数调用失败的问题
这篇文章主要介绍了解决SpringCloud Feign传对象参数调用失败的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-06-24SpringCloud2020整合Nacos-Bootstrap配置不生效的解决
这篇文章主要介绍了SpringCloud2020整合Nacos-Bootstrap配置不生效的解决,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-01-25- 这篇文章主要介绍了spring cloud gateway转发服务报错的解决,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-09-02
- 这篇文章主要介绍了解决springcloud-gateway限流遇到的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-07-16
SpringCloud @FeignClient参数的用法解析
这篇文章主要介绍了SpringCloud @FeignClient参数的用法,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-10-21