spring cloud gateway

Spring cloud gateway是Spirng官方基于Spring 5.0，Spring boot2.0和Project Reactor等技术开发的网关，Spring Cloud Gateway旨在为微服务架构提供一种简单而有效的统一的API路由管理方式。Spring Cloud Gateway作为Spring Cloud生态系中的网关，目标是替代Netflix ZUUL，其不仅提供统一的路由方式，并且基于Filter链的方式提供了网关基本的功能，例如：安全，监控/埋点和限流等。

 

 

client想要访问server，得先经过网关，然后才能访问到server，所以网关第一个需求就是把client的一个请求二次发送到请求对应的server上，简称路由。请求既然走了网关，网关这一层就得做些事情，那能做哪些事情呢？我们可以自由发挥，比如没有达到某种要求就不让该请求到达对应的server上（请求鉴权），网关可以监控某些特定的请求，让其访问频率不得高于某定值（限流）等等。

1、路由

 

1.id： 路由唯一标志

2.uri:   下游服务地址

3.predicates：匹配该路由需要满足的条件

4.filters：匹配该路由需要经过的过滤器

下面我们其看下源码中对路由的对象定义

 

其中有个默认属性order，其指该路由的优先级

id属性是非必填的，有UUID随机字符串作为默认值；

uri是下游服务的地址，这里支持两种模式，一种是直接填写下游地址，还有一种走服务治理流程，通过服务发现中的服务名寻找下游地址，例如

 

“lb”意味着有注册中心有多个服务实例，走负载均衡。

predicates是匹配路由的重要属性，gateway默认支持10种匹配，如下图

 

请求时间点（分三种，前，后，中），cookie，header，host，method（get，post，put and so on），path，queryParam，remoteAddress

1.1、源码分析

首先从路由的初始化（从配置文件读取数据往spring里注入bean）说起，predicates的初始化依附于router，入口在

GatewayAutoConfiguration

 

此类是网关核心初始化类，其中初始化路由的bean的如下图

  @Qualifier注解表示存在多个bean注入时，指定注入bean  webFluxConversionService

@primary注解说明缓存cachedCompositeRouteLocator优先，没有缓存走routeDefinitionRouteLocator，routeDefinitionRouteLocator初始化依赖GatewayProperties,GatewayFilterFactory,RoutePredicateFactory,webFluxConversionService和RouteDefinitionLocator，对应bean的注入如下图：

 

 

 

 

GatewayProperties是配置文件里的数据注入的bean

webFluxConversionService这个bean是来做数据相应式绑定的

AfterRoutePredicateFactory，BeforeRoutePredicateFactory是AbstractRoutePredicateFactory的子类，AbstractRoutePredicateFactory是RoutePredicateFactory的抽象实现类

AddRequestParameterGatewayFilterFactory，AddResponseHeaderGatewayFilterFactory是AbstractGatewayFilterFactory的子类，AbstractGatewayFilterFactory是GatewayFilterFactory的抽象实现类

RouteDefinitionLocator是路由定义的抽象接口，实现类PropertiesRouteDefinitionLocator是从配置文件中读取配置的路由bean；实现类InMemoryRouteDefinitionRepository是配合网关暴露出的外部接口使用的bean，外部动态调用接口保存的路由在此bean的缓存中。CompositeRouteDefinitionLocator实现类是以上两者的结合（从bean的依赖关系和bean的注入顺序也可以看出），即最终所获取的所有router。

下面我们回到RouteDefinitionRouteLocator的构造方法，如下图：

这里初始化了网关中所有bean注入的predicates，gatewayFilterFactory和router

路由初始化结束了，接着来看RoutePredicateHandlerMapping这个bean  ，这个bean主要负责请求查找router

 

此bean依赖着routeLocator，即上面提到的RouteDefinitionRouteLocator这个bean，

RoutePredicateHandlerMapping继承了AbstractHandlerMapping，AbstractHandlerMapping此抽象类的作用就是为已解析的ServerWebExchange寻找请求handler（往下游服务转发），

此方法在寻找handler之前做了查找路由的操作，如下图：

 

 

查找的路由就是RouteDefinitionRouteLocator依赖的RouteDefinitionLocator中初始化的所有路由，然后predicates匹配，若匹配路由成功，还要经过validateRoute方法，该方法是留给二次开发者使用的，如下图：

 

解释请看图的注解即可。若匹配失败，则返回空，handler为空网关会直接返回给client404的错误码。

到此路由源码解析结束（其中路由的predicates是支持自定义的哦，不知大家能不能发现哈），我们做个总结，如下图：

 

2、过滤器

过滤器的作用是对请求进行过滤，符合条件的往下走，否则over

在网关中，过滤器分为两种，一种是局部过滤器，一种是全局过滤器，局部过滤器是针对特定路由的，会依附于路由配置，而全局过滤器则是每个请求的必经之路。

过滤器是二次开发者重点开拓的对象，它能为业务侧提供业务解耦的功能。

2.1、全局过滤器

样例如图：

 

其必须实现globalFilter接口，实现Ordered接口是在多全局过滤器下区分优先级（请求先走哪个过滤器）的，名称没有特殊要求，bean注入是必须的。

优先级接口如下：

 

值越小优先级越高。

网关业务侧流程接口如下：

参数ServerWebExchange是gateway构造的请求上下文，记录着此次请求的所有内容及行为，另一个参数GatewayFilterChain就是过滤器执行链，主要目的是方便请求下行。

2.2、局部过滤器

样例如下图

 

局部过滤器分为有参和无参，如图是有参的，继承了AbstractGatewayFilterFactory，模板就是入参实体，AbstractGatewayFilterFactory实现了GatewayFilterFactory接口，无参的可以直接实现GatewayFilterFactory接口；其次有参局部过滤器对类名称有要求，必须满足******GatewayFilterFactory的匹配要求，这样在配置的时候，入参配置就是******=。。。。。。。；若有优先级配置还是需要实现ordered接口；spring注入是必须的；业务接口实现与全局过滤器类似

2.3、源码

首先还是看过滤器的初始化

第一部分：全局过滤器的加载

FilteringWebHandler此bean的依赖就是全局过滤器

 

以上就是对应的全局过滤器的相关bean的注入（有网关原始开发的，也包含业务侧二次开发的），AdaptCachedBodyGlobalFilter，RouteToRequestUrlFilter，ForwardRoutingFilter等都是GlobalFilter接口的实现类

那么全局过滤器直接bean注入

在FilteringWebHandler的handle方法中（路由已匹配成功，需要执行filter链），首先获取了全局filter，然后获取了匹配路由的局部过滤器（可以看路由的加载），接着组合排序，最后进行链式过滤。

3、安全

3.1.跨域配置

3.2、SSL配置