Spring Cloud Gateway源码导读

251 阅读4分钟

Spring Cloud Gateway源码导读:

首先我们观察在引入了Spring Cloud Gateway后自动装配都做了什么?从Spring Cloud Gateway包下找到spring.factories,查看EnableAutoConfiguration项,仔细观察后不难发现关键配置项即为GatewayAutoConfigurationGatewayReactiveLoadBalancerClientAutoConfiguration(需要配合spring-cloud-loadbalancer一起使用)。 那么我们分别来看看这两个配置类都做了什么。

GatewayAutoConfiguration

该配置类中主要装配了如下几种类型的对象:

  • RouteDefinitionLocator(Properties)
  • RouteDefinitionRepository(Redis、InMemory)
  • RouteLocator(RouteDefinition)
  • RouteRefreshListener
  • HandlerMapping(RoutePredicateHandlerMapping)
  • WebHandler(FilteringWebHandler)
  • GlobalFilters
  • Predicate Factory Beans
  • GatewayFilter Factory Beans

下面我们依次介绍上述各对象的作用

RouteDefinitionLocator

可以将名称拆开看,即RouteDefinitionLocator,其中RouteDefinitionSpring Beans中的BeanDefinition类似,从名字上也能看出其实就是用来定义Route的,用来记录Route的关键属性,例如PredicatesFiltersurl等。

Locator则是用来从特定的位置读取RouteDefinition,目前Spring Cloud Gateway默认是从Properties来读取RouteDefinition。读取后交给RouteLocator实例化为Route对象。

RouteDefinitionRepository

Spring Cloud Gateway提供InMemoryRedis等的RouteDefinitionRepository,主要用来动态添加RouteDefinition,需要注意的是InMemory通常在Spring Actuator中打开routes端点即可使用,在添加成功后需要发出RouteRefresh事件即可更新内存中的路由。

RouteLocator

默认为RouteDefinitionRouteLocator,主要作用是根据RouteDefinitionLocator中返回的RouteDefinition创建Route对象,核心操作是将RouteDefinition中定义的Predicate FactoryFilter Factory实例化,最终封装在Route对象中,以供请求进来时筛选路由。

RouteRefreshListener

路由发生更新时需要发布RouteRefresh事件,该监听器负责更新内存中的路由列表。

HandlerMapping

DispatcherHandler分发请求时调用HandlerMapping.getHandler方法来获取HandlerAdapter以供后续链式调用,Spring Cloud Gateway默认是由RoutePredicateHandlerMapping处理。在该处理器继承自AbstractHandlerMapping,并实现抽象方法getHandlerInternal。当有请求进来时,通过lookupRoute寻找内存中所有的Route,并通过路由的Predicate寻找与当前请求相匹配的路由,将其放进exchange后,最终返回FilteringWebHandler

WebHandler

DispatcherHandlerHandlerMapping中获取到了HandlerAdapter后,随即立即调用HandlerAdapter来处理请求,上述RoutePredicateHandlerMapping返回的FilteringWebHandler是一种WebHandler,由SimpleHandlerAdapter负责处理,在FilteringWebHandler中会将Global FiltersRoute中定义的Gateway Filters合并,按照Order排序后封装成DefaultGatewayFilterChain依次后调用filter方法。

GlobalFilters

在纯Spring Cloud Gateway环境下存在9个全局过滤器,他们按照执行顺序分别是:

名称Order作用
RemoveCachedBodyFilterInteger.MIN_VALUE
AdaptCachedBodyGlobalFilterInteger.MIN_VALUE + 1000
NettyWriteResponseFilter-1用来写响应给客户端
ForwardPathFilter0若Route中定义的uri是forward类型,则将exchange中的request修改为forward类型。
RouteToRequestUrlFilter10000取出Route中定义的uri,将其设置在exchange中
NoLoadBalancerClientFilter10150在GatewayNoLoadBalancerClientAutoConfiguration中定义,不使用loadBalance。
WebsocketRoutingFilterInteger.MAX_VALUE - 1从exchange中取出RouteToRequestUrlFilter中设置的uri,处理websocket协议下的路由
NettyRoutingFilterInteger.MAX_VALUE从exchange中取出RouteToRequestUrlFilter中设置的uri,处理http、https协议下的路由,主要作用是创建新的httpclient,根据uri发送请求并增加request及response处理,同时超时处理也在这个位置。
ForwardRoutingFilterInteger.MAX_VALUE如果是forward类型请求,则交给dispatcherhandler重新处理。

Predicate Factory Beans

内置的Predicate工厂处理类,用来根据RouteDefinition中的配置生成对应的Predicate。在HandlerMapping中通过调用Predicate.test方法匹配请求与路由。

PS.这里有个性能瓶颈,默认策略是循环遍历每一个路由的Predicate.test方法进行匹配,当路由数量越来越多时性能急剧下降,可根据实际业务中路由的Predicate类型进行优化。例如全都是PathRoutePredicate时,可根据固有逻辑建立路由标识与路由的缓存,在请求进来时快速查找,找不到时由默认逻辑兜底。

GatewayFilter Factory Beans

内置的路由级别GatewayFilter工厂处理类,用来根据RouteDefinition中的配置生成对应的GatewayFilter。在

FilteringWebHandler中会与GlobalFilter合并后对请求进行处理。

GatewayReactiveLoadBalancerClientAutoConfiguration

当引入了spring-cloud-loadbalancer后,该配置类会自动注入ReactiveLoadBalancerClientFilter从而替代默认的NoLoadBalancerClientFilter。当前版本的Spring Cloud Gateway原生支持RandomRoundRobin两种负载策略,默认使用RoundRobin策略。

注意,ReactiveLoadBalancerClientFilterOrderNoLoadBalancerClientFilter相同,都为10150。

ReactiveLoadBalancerClientFilter的处理流程

ReactiveLoadBalancerClientFilter在处理时仅处理lb://类型的uri,其原理为从uri中解析出的host后,通过利用NamedContextFactory创建一个新的以Route idnameApplicationContext,由LoadBalancerClientConfiguration自动注入RoundRobinLoadBalancer到新建的ApplicationContext中,随后通过LoadBalancerServiceInstanceListSupplier中查找出指定host的所有实例,根据负载均衡算法选取一个示例后返回给ReactiveLoadBalancerClientFilter,接着将实例的uri与原有请求的uri合并后替换exchange中的GATEWAY_REQUEST_URL_ATTR以供后续NettyRoutingFilter使用。

大体上的Spring Cloud Gateway的初始化及处理流程就是这样,至于每个Filter的细节可以根据项目中使用到的情况来继续研读。