Spring cloud gateway 设置context-path服务路由404排查

一、背景

    最近做网关重构，技术选型为spring cloud gateway，采用consul作为配置中心和注册中心，秉承不重启原则，网关内部实现动态路由机制，采用定时任务定时更新网关路由信息。

 

二、服务信息

   微服务网关：spring-cloud-gateway

   微服务：order-service、user-service

 

三、问题描述

   因为网关服务集成了knife4j，因此可以通过访问http://网关ip:port/doc.html，即可访问所有在同一个注册中心的服务的knife4j信息，但是实际访问时用户服务相关接口报404错误。

 

四、问题排查

  1、排查发现order-service未设置server.servlet.context-path，user-service有设置；

  2、验证context-path的影响发现在路由设置时path字段值必须加前缀再截取才可以正常路由；

  3、由于公司网关是既有产品，当前是技术框架重构，因此不能改动原来接口访问路径，因此不可以在原有路径前面再加前缀；

  排查源码发现请求会经过

FilteringWebHandler的

filter方法，此方法

在路由过程中会走12个过滤器，其中第5个过滤器

RewritePathGatewayFilterFactory中的

apply方法会匹配服务启动时加载的

regexp正则，从而对服务path进行改写。

源码如下：

 

五、解决方案

1）若配置路由URI为lb，则注册中心服务名称不能和server.servlet.context-path名称一致，否则contextPath会被改写为空字符串；

2）若注册中心和server.servlet.context-path必须一致，则断言中设置Path时需在contextPath前包装一层前缀，且Filter中需截取第一个字符串；

3）禁止gateway网关主动从consul拉取路由信息并设置默认过滤器，该操作会设置默认过滤规则，reWritePath匹配正则修改请求路径

      在启动类添加注解：

     

 @SpringBootApplication( exclude = org.springframework.cloud.gateway.discovery.GatewayDiscoveryClientAutoConfiguration.class) 

4）推荐使用

   重写过滤链（只需添加如下配置）：

   

spring.cloud.gateway.discovery.locator.filters[0]=PreserveHostHeader