SpringCloud Gateway详解

本文将详细分析SpringCloud Gateway是如何实现的 。
架构SpringCloud Gateway(下面简称SG)基于SpringWebFlux,整体架构如下图所示:

SpringCloud Gateway详解

文章插图
 
SG定义了几个概念:
  • 路由(Route):路由是网关的基本构成单元 。它由一个ID、一个目标URL、一组谓词以及一组过滤器组成 。当谓词判定为true时,表示请求与对应路由匹配
  • 谓词(Predicate):JAVA8函数式谓词 。输入参数是Spring框架封装的ServerWebExchange对象 。开发人员可以基于此对象来匹配HTTP请求的任意内容,比如请求头或请求参数
  • 过滤器(Filter):由特定工厂类构造的一组Spring框架提供的GatewayFilter对象 。过滤器可以在请求或响应被处理前/后对其进行修改 。
架构流程一个请求被SG处理的大致流程如下所示:
  • GatewayHandlerMApping判定对应的请求是否匹配某个路由 。
  • 如果匹配到某个路由,则将请求交给GatewayWebHandler处理,Handler调用一个Filter链来处理这个请求:
    • 首先,会执行「pre」过滤器的逻辑
    • 然后执行请求处理luoji
    • 最后再执行「post」过滤器的逻辑
  • 如果没有匹配到路由,则不执行对应处理
下面以一个具体的例子来进行说明 。
SG支持基于Java编码方式的配置以及基于配置文件的配置 。
  • Java编码方式配置

SpringCloud Gateway详解

文章插图
 
  • 配置文件配置

SpringCloud Gateway详解

文章插图
【SpringCloud Gateway详解】 
这两个配置是等价的 。
启动流程
  • SG是基于SpringBoot构建的,启动相关配置可见项目中的spring.factories文件 。
  • 由于涉及的配置很多,我们直接定位到核心Bean
    • HandlerMapping:SG构建的HandlerMapping实例是RoutePredicatehandlerMapping
    • WebHandler:构建的WebHandler为FilteringWebHandler,它接收List<GlobalFilter>作为参数
    • Route:路由构建由RouteDefinitionRouteLocator实例来处理,它基于路由配置(即上面的配置文件)来构建Route实例

SpringCloud Gateway详解

文章插图
 
  • 从上面的代码可以看到,最终Filter,WebHandler(注意,这里是GlobalFilter),Route都作为直接参数或间接参数传递给了RoutePredicateHandlerMapping 。所以我们可以从RoutePredicateHandlerMapping来梳理SG的执行流程 。
RoutePredicateHandlerMapping是HandlerMapping的一个实例,HandlerMapping归属于SpringWebFlux,这里不做说明,请自行查阅相关资料 。
SpringCloud Gateway详解

文章插图
 
请求处理流程我们结合上面的配置文件,以及SG具体的实例来说明SG对请求的处理流程:
  • 当请求到达SG后,首先由RoutePredicateHandlerMapping来处理请求(前面的流程由SpringWebFlux处理,不在讨论范围内)
    • 首先根据请求从RouteLocator中查询符合规则的路由,返回Route
    • 返回的Route设置为exchange的属性
    • 返回构造时传入的WebHandler
  • 执行WebHandler
    • 从exchange的属性中获取Route
    • 从Route中获取GatewayFilter链
    • 与GlobalFilter进行整合,排序,构成完成的Filter
    • 遍历执行Filter
  • 其中部分GlobalFilter有执行Service的功能,例如NettyRoutingFilter 。这类Filter负责将请求转发给对应的Service进行具体的逻辑处理
 
SpringCloud Gateway详解

文章插图
 
关键流程代码
SpringCloud Gateway详解

文章插图
 
  • 1处即根据exchange从RouteLocator中查询匹配的路由
  • 1.1处根据谓词进行路由匹配
  • 2处,将路由设置到exchange的属性中
  • 3处,从exchange的属性中获取路由
  • 4处,从路由中获取GatewayFilter列表
  • 5、6、7处,将GlobalFilter与GatewayFilter整合到一起,按Order排序
  • 8处,执行Filter
执行服务SG中服务的执行也是通过GlobalFilter来执行的,SG中默认配置了一些GlobalFilter,下面列出了部分 。
SpringCloud Gateway详解

文章插图
 
具体Filter作用这里不做详述,可自行阅读源码,这里只关注三个Filter: