前言
前段时间业务拓展搭建了一个新的微服务,然后要在网关配置路由,配置路由的时候配置了一个鉴权的过滤器,结果发现过滤器怎么都不生效,哇~~ 人都麻了。后来经过一通扒源码底裤,彻底搞清楚了原因,竟然是一个服务发现的配置导致的。和广大掘友一起分享~~
在 application.yml 中配置路由
spring:
cloud:
gateway:
discovery:
locator:
enabled: true ## 这个属性很关键,后面会详细介绍
lower-case-service-id: true #小写服务名
routes:
- id: hive-admin
uri: lb://hive-admin
predicates:
- Path=/hive-admin/**
filters:
- name: AdminBackend
复制代码
我们依照已存在的其他微服务示例配置路由,至于 predicates
下面的几种 Route Predicate Factory
比较简单,这里就不详细介绍了,不清楚的可以参考官网文档详细说明 SpringCloud Gateway 配置详解
过滤器不生效
配置好之后我们从网关请求 /hive-admin/xxx
你会发现这个请求怎么都不会走到我们配置的 AdminBackendFilterFactory
过滤器, 直接就路由到目标微服务了。
下面我们来分析为什么过滤器未生效。在分析这个问题之前我们先了解一下 Gateway
的 RouteDefinition
这个类。
RouteDefinition
从这个名字就能看出这个类就是 “路由定义”。其实我们在 application.yml
配置文件中配的就是这个,针对这段配置
- id: hive-admin
uri: lb://hive-admin #这种写法代表去注册中心找服务
predicates: #官网有 11 种断言
- Path=/hive-admin/**
filters:
- name: AdminBackend
复制代码
意思就是当我们访问 /hive-admin/**
的时候我们先过 AdminBackendFilterFactory
这个过滤器,如果放行就将请求转到注册中心中 hive-admin
这个服务。现在请求是正常过去了,但是没有走这个过滤器,那到底是啥原因?
遇到问题不要慌
很多新手程序员一遇到涉及框架源码内部的问题时就会很茫然,无从下手只能问度娘、Google,当然这是很正常的一件事,我当年也是这样。而且我还特别疑惑别的大牛都是怎么从源码排查出问题的,他们是怎么知道要看哪一块代码?该查哪个类哪一块代码的?下面我就分享一下遇到这种问题该如何去排查。真的是详细干货,所有源码问题都是类似的方式排查
开始源码分析
先预估断点进行 debug
我们要阅读源码解决问题,必定要通过 debug
,所以我们得先找到程序会经过的相关源码片段,然后打断点,查看断点前后的每一个方法调用栈,只要能调试起来,一切都是小问题。那如何找到呢?还记得我们的配置文件吧?应用启动源码肯定是要加载这个的,直接按住 ctrl
鼠标左键点 filters
属性进入到映射的 Java
类
点进来跳到 GatewayProperties
,发现了成员变量
private List<RouteDefinition> routes = new ArrayList<>();
复制代码
我们继续点进 RouteDefinition
类,发现了
@NotEmpty
@Valid
private List<PredicateDefinition> predicates = new ArrayList<>();
@Valid
private List<FilterDefinition> filters = new ArrayList<>();
复制代码
找到 predicate
的 getPredicates()
方法,再按住 ctrl
点鼠标左键查找哪里调用了这个方法
<