Spring Cloud Gateway源码导读

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 作用
RemoveCachedBodyFilter Integer.MIN_VALUE
AdaptCachedBodyGlobalFilter Integer.MIN_VALUE + 1000
NettyWriteResponseFilter -1 用来写响应给客户端
ForwardPathFilter 0 若Route中定义的uri是forward类型,则将exchange中的request修改为forward类型。
RouteToRequestUrlFilter 10000 取出Route中定义的uri,将其设置在exchange中
NoLoadBalancerClientFilter 10150 在GatewayNoLoadBalancerClientAutoConfiguration中定义,不使用loadBalance。
WebsocketRoutingFilter Integer.MAX_VALUE - 1 从exchange中取出RouteToRequestUrlFilter中设置的uri,处理websocket协议下的路由
NettyRoutingFilter Integer.MAX_VALUE 从exchange中取出RouteToRequestUrlFilter中设置的uri,处理http、https协议下的路由,主要作用是创建新的httpclient,根据uri发送请求并增加request及response处理,同时超时处理也在这个位置。
ForwardRoutingFilter Integer.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的细节可以根据项目中使用到的情况来继续研读。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,496评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,407评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,632评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,180评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,198评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,165评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,052评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,910评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,324评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,542评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,711评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,424评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,017评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,668评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,823评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,722评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,611评论 2 353

推荐阅读更多精彩内容