SpringCloud Gateway 路由如何定位从底层源码分析
环境:springcloud Hoxton.SR11
本节主要了解系统中的谓词与配置的路由信息是如何进行初始化关联生成路由对象的。每个谓词工厂中的Config对象又是如何被解析配置的。
(相关资料图)
所有的谓词工厂中的Config中属性值是如何被配置的。
在SpringCloud Gateway中的所有谓词工厂如下:
图片
命名规则:XxxRoutePredicateFactory。所有的这些谓词工厂都是如下的继承关系
public class MethodRoutePredicateFactory extends AbstractRoutePredicateFactory// public class PathRoutePredicateFactory extends AbstractRoutePredicateFactory// ...
所有的谓词工厂继承的AbstractRoutePredicateFactory中的泛型都是内部类的Config。这个是如何被配置上值的呢?
1.1 gateway自动配置在下面这个类中配置了所有的Predicate和Filter。
public class GatewayAutoConfiguration { @Bean @ConditionalOnEnabledPredicate public PathRoutePredicateFactory pathRoutePredicateFactory() { return new PathRoutePredicateFactory(); } @Bean @ConditionalOnEnabledPredicate public QueryRoutePredicateFactory queryRoutePredicateFactory() { return new QueryRoutePredicateFactory(); } @Bean public RouteLocator routeDefinitionRouteLocator(GatewayProperties properties, List gatewayFilters, List predicates, RouteDefinitionLocator routeDefinitionLocator, ConfigurationService configurationService) { return new RouteDefinitionRouteLocator(routeDefinitionLocator, predicates, gatewayFilters, properties, configurationService); } @Bean @Primary @ConditionalOnMissingBean(name = "cachedCompositeRouteLocator") public RouteLocator cachedCompositeRouteLocator(List routeLocators) { return new CachingRouteLocator(new CompositeRouteLocator(Flux.fromIterable(routeLocators))); }}
这里会层层委托最终查找查找路由定位会交给RouteDefinitionRouteLocator。CachingRouteLocator起到缓存的作用,将配置的所有路由信息保存。
注意:这里的路由信息是在容器启动后就会被初始化的。
public class CachingRouteLocator { private final RouteLocator delegate; private final Flux routes; private final Map cache = new ConcurrentHashMap<>(); private ApplicationEventPublisher applicationEventPublisher; public CachingRouteLocator(RouteLocator delegate) { this.delegate = delegate; routes = CacheFlux.lookup(cache, CACHE_KEY, Route.class) .onCacheMissResume(this::fetch); } private Flux fetch() { return this.delegate.getRoutes().sort(AnnotationAwareOrderComparator.INSTANCE); }}
实例化CachingRouteLocator就开始查找所有配置的Route信息。最终的会委托给RouteDefinitionRouteLocator
RouteDefinitionRouteLocator构造函数中的initFactories方法用来映射路由工厂的XxxRoutePredicateFactory。
private void initFactories(List predicates) { predicates.forEach(factory -> { String key = factory.name(); if (this.predicates.containsKey(key)) { this.logger.warn("A RoutePredicateFactory named " + key + " already exists, class: " + this.predicates.get(key) + ". It will be overwritten."); } this.predicates.put(key, factory); });}
方法中解析每一个谓词工厂对应的名称然后缓存到predicates 集合中。
factory.name()方法解析谓词名称。
default String name() { return NameUtils.normalizeRoutePredicateName(getClass());}
CachingRouteLocator是个缓存路由定位器,是个首选的RouteLocator(@Primary),这里将RouteDefinitionRouteLocator进行了合并。
1.2 生成路由对象Route及Config配置getRoutes---》convertToRoute---》combinePredicates---》lookup。
根据上面的自动配置也知道了在服务启动时就进行初始化所有路由信息了。
获取路由信息
public Flux getRoutes() { Flux routes = this.routeDefinitionLocator.getRouteDefinitions() .map(this::convertToRoute); routes = routes.onErrorContinue((error, obj) -> { return routes.map(route -> { return route; });}
合并谓词(链式调用)
private AsyncPredicate combinePredicates( RouteDefinition routeDefinition) { // other code for (PredicateDefinition andPredicate : predicates.subList(1, predicates.size())) { AsyncPredicate found = lookup(routeDefinition, andPredicate); predicate = predicate.and(found); } return predicate;}
进入lookup中
private AsyncPredicate lookup(RouteDefinition route, PredicateDefinition predicate) { RoutePredicateFactory
lookup方法中查找,也就是在这里将对应的谓词Config与RouteDefinition(Predicate)中定义的相对应的属性关联。
进入factory.applyAsync方法
@FunctionalInterfacepublic interface RoutePredicateFactory extends ShortcutConfigurable, Configurable { default AsyncPredicate applyAsync(C config) { return toAsyncPredicate(apply(config)); // 查看下面的6.2-1图当前apply所有的实现就是系统内部定义的XxxRoutePredicateFactory }}// apply(config),如这里配置了Path谓词,那么就会进入PathRoutePredicateFactory中的apply方法public Predicate apply(Config config) { // other code return new GatewayPredicate() { public boolean test() { // todo } }}// 最后返回一个异步的谓词public static AsyncPredicate toAsyncPredicate(Predicate super ServerWebExchange> predicate) { Assert.notNull(predicate, "predicate must not be null"); // 这里from就是返回一个DefaultAsyncPredicate默认的异步谓词 return AsyncPredicate.from(predicate);}static AsyncPredicate from( Predicate super ServerWebExchange> predicate) { return new DefaultAsyncPredicate<>(GatewayPredicate.wrapIfNeeded(predicate));}
图6.2-1
图片
最后在combinePredicates方法中将当前路由中配置的所有谓词进行了and操作返回。最终回到convertToRoute方法中将当前路由中配置的谓词,过滤器进行了整合包装返回Route(一个路由对象)
public class Route implements Ordered { private final String id; private final URI uri; private final int order; private final AsyncPredicate predicate; private final List gatewayFilters; private final Map metadata;}
这些Route对象会被保存在上面说的CachingRouteLocator.routes中。
6.3 定位路由根据上面的配置RouteLocator 该类用来定位路由(查找具体的使用哪个路由);当一个请求过来会查找是哪个路由。
RouteLocator中定义了一个方法
public interface RouteLocator { Flux getRoutes();}
查看这个getRoutes方法是谁调用的
图片
看到这个RoutePredicateHandlerMapping是不是想起了Spring MVC中的HandlerMapping(我们所有的Controller都会被 RequestMappingHanlderMapping 匹配)。通过名称也就知道了该HandlerMapping用来匹配我们的路由谓词的谁来处理路由。
接下来回到前面说的RequestMappingHanlderMapping 对象,当我们请求一个路由地址时会执行该类中的lookup方法查找路由
protected Mono lookupRoute(ServerWebExchange exchange) { // 这里的this.routeLocator就是 CachingRouteLocator对象 return this.routeLocator.getRoutes() .concatMap(route -> Mono.just(route).filterWhen(r -> { exchange.getAttributes().put(GATEWAY_PREDICATE_ROUTE_ATTR, r.getId()); // 过滤查找符合的路由 return r.getPredicate().apply(exchange); }).doOnError(e -> logger.error( "Error applying predicate for route: " + route.getId(), e)).onErrorResume(e -> Mono.empty())) .next() .map(route -> { if (logger.isDebugEnabled()) { logger.debug("Route matched: " + route.getId()); } validateRoute(route, exchange); return route; });}
进入r.getPredicate().apply(exchange)
public interface AsyncPredicate extends Function> { static AsyncPredicate from(Predicate super ServerWebExchange> predicate) { return new DefaultAsyncPredicate<>(GatewayPredicate.wrapIfNeeded(predicate)); } class DefaultAsyncPredicate implements AsyncPredicate { private final Predicate delegate; public DefaultAsyncPredicate(Predicate delegate) { this.delegate = delegate; } @Override public Publisher apply(T t) { return Mono.just(delegate.test(t)); } @Override public String toString() { return this.delegate.toString(); } }}
这里会调用Predicate.test方法(XxxRoutePredicateFactory中的apply方法返回的GatewayPredicate)。
调用GatewayPredicate.test返回判断当前请求的路由是否匹配。
整体的一个流程:
1、系统先初始化所有的Predicate(谓词)和Filter(过滤器)
2、根据配置的路由信息(过滤器,谓词)包装返回Route对象
3、根据请求路由路径查找匹配的路由
关键词:
相关阅读
-
SpringCloud Gateway 路由如何定位从底层源码分析
环境:springcloudHoxton SR11本节主要了解系统中的谓词与配置的路由信 -
古装奇幻剧《风月变》收官,主创现身揭...
大象新闻记者吴净净被网友赞为“古装奇幻新突破”的《风月变》,近... -
唐山妇联:“雏凤还巢”暑期社会实践活...
“非常高兴,参加市妇联举办的‘大爱唐山·木兰启航’暑期社会实践... -
鹤山市广旭实验学校校长曾文锦:让孩子...
“老师每天跟学生朝夕相处,带领学生在知识的海洋中遨游,老师是知... -
海南高速:截止8月10日,公司股东户数为...
海南高速(000886)08月11日在投资者关系平台上答复了投资者关心的问题。 -
小米Civi3:超值自拍,1TB厚道价!
了解小米手机的朋友都知道,数字旗舰定位高端市场,Civi系列主打拍照体 -
北京发布暴雨蓝色预警!多区域短时强降...
今天9时20分,北京发布暴雨蓝色预警:预计11日12时至12日6时,本市房山 -
河北:入冬前确保受灾群众能够回家或搬...
8月11日上午,河北省防汛救灾暨灾后重建新闻发布会在石家庄召开。河北 -
前7月铁路完成固定资产投资3713亿元
本报北京8月10日电 (记者李心萍)记者从中国国家铁路集团有限公司( -
中国印刷业迈向高质量发展新征程
“截至2022年,我国印刷业总产值达1 43万亿元,整体规模跃居世界第... -
湾区产融旗下深圳龙岗岳湖岗旧改规划公...
观点网讯:8月11日获悉,深圳城市更新和土地整备局对《坪地街道中心社 -
壮丽铁轨,共筑友谊
8月8日上午9点30分,铺轨机在广西防城港市境内将一组500米长的钢轨成功 -
洪江区桂花园乡:让“方便”的事更方便...
湖南日报·新湖南客户端(通讯员明子琪)“老人家,厕所用着还满意... -
爽爽贵阳避暑季 | 贵阳:避暑游带火酒店业
新闻提示今年入夏以来,“避暑”成了贵阳的热门词,旅游市场热度持... -
维珍银河首次搭载私人乘客游太空
英国维珍银河公司“团结”号太空船10日顺利完成任务,让3名普通乘客... -
2023年8月最佳iRobotRoomba扫地机器人
iRobot,或者更确切地说Roomba,已经成为机器人吸尘器的代名词。类似于 -
豪募30亿!福建老乡干出一个IPO
值得注意的是,福建德尔收到了不少资本递来的橄榄枝,红杉安辰、深创投 -
2023年8月11日上海市锌价格最新行情预测
中国报告大厅2023年8月11日上海市锌价格最新走势监测显示:上海华通有 -
呼吸阀工作原理 储罐呼吸阀工作原理
1、工作原理:当罐内介质的压力在呼吸阀的控制操作压力范围之内时,呼 -
末伏已至 暑热未消 未来一周长沙最高温37℃
长沙晚报8月10日讯(全媒体记者张洋子)末伏已至,暑热未消,长沙依旧是