当前位置:首页 > 科技  > 软件

SpringCloud Gateway 路由如何定位从底层源码分析

来源: 责编: 时间:2023-08-14 22:01:30 534观看
导读环境:springcloud Hoxton.SR11本节主要了解系统中的谓词与配置的路由信息是如何进行初始化关联生成路由对象的。每个谓词工厂中的Config对象又是如何被解析配置的。所有的谓词工厂中的Config中属性值是如何被配置的。

环境:springcloud Hoxton.SR11PTi28资讯网——每日最新资讯28at.com

本节主要了解系统中的谓词与配置的路由信息是如何进行初始化关联生成路由对象的。每个谓词工厂中的Config对象又是如何被解析配置的。PTi28资讯网——每日最新资讯28at.com

所有的谓词工厂中的Config中属性值是如何被配置的。PTi28资讯网——每日最新资讯28at.com

在SpringCloud Gateway中的所有谓词工厂如下:PTi28资讯网——每日最新资讯28at.com

图片图片PTi28资讯网——每日最新资讯28at.com

命名规则:XxxRoutePredicateFactory。所有的这些谓词工厂都是如下的继承关系PTi28资讯网——每日最新资讯28at.com

public class MethodRoutePredicateFactory extends   AbstractRoutePredicateFactory<MethodRoutePredicateFactory.Config>// public class PathRoutePredicateFactory extends AbstractRoutePredicateFactory<PathRoutePredicateFactory.Config>// ...

所有的谓词工厂继承的AbstractRoutePredicateFactory中的泛型都是内部类的Config。这个是如何被配置上值的呢?PTi28资讯网——每日最新资讯28at.com

1.1 gateway自动配置

在下面这个类中配置了所有的Predicate和Filter。PTi28资讯网——每日最新资讯28at.com

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<GatewayFilterFactory> gatewayFilters, List<RoutePredicateFactory> predicates, RouteDefinitionLocator routeDefinitionLocator, ConfigurationService configurationService) {    return new RouteDefinitionRouteLocator(routeDefinitionLocator, predicates,            gatewayFilters, properties, configurationService);  }  @Bean  @Primary  @ConditionalOnMissingBean(name = "cachedCompositeRouteLocator")  public RouteLocator cachedCompositeRouteLocator(List<RouteLocator> routeLocators) {    return new CachingRouteLocator(new CompositeRouteLocator(Flux.fromIterable(routeLocators)));  }}

这里会层层委托最终查找查找路由定位会交给RouteDefinitionRouteLocator。CachingRouteLocator起到缓存的作用,将配置的所有路由信息保存。PTi28资讯网——每日最新资讯28at.com

注意:这里的路由信息是在容器启动后就会被初始化的。PTi28资讯网——每日最新资讯28at.com

public class CachingRouteLocator {  private final RouteLocator delegate;  private final Flux<Route> routes;  private final Map<String, List> 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<Route> fetch() {    return this.delegate.getRoutes().sort(AnnotationAwareOrderComparator.INSTANCE);  }}

实例化CachingRouteLocator就开始查找所有配置的Route信息。最终的会委托给RouteDefinitionRouteLocatorPTi28资讯网——每日最新资讯28at.com

RouteDefinitionRouteLocator构造函数中的initFactories方法用来映射路由工厂的XxxRoutePredicateFactory。PTi28资讯网——每日最新资讯28at.com

private void initFactories(List<RoutePredicateFactory> 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 集合中。PTi28资讯网——每日最新资讯28at.com

factory.name()方法解析谓词名称。PTi28资讯网——每日最新资讯28at.com

default String name() {  return NameUtils.normalizeRoutePredicateName(getClass());}

CachingRouteLocator是个缓存路由定位器,是个首选的RouteLocator(@Primary),这里将RouteDefinitionRouteLocator进行了合并。PTi28资讯网——每日最新资讯28at.com

1.2 生成路由对象Route及Config配置

getRoutes---》convertToRoute---》combinePredicates---》lookup。PTi28资讯网——每日最新资讯28at.com

根据上面的自动配置也知道了在服务启动时就进行初始化所有路由信息了。PTi28资讯网——每日最新资讯28at.com

获取路由信息PTi28资讯网——每日最新资讯28at.com

public Flux<Route> getRoutes() {  Flux<Route> routes = this.routeDefinitionLocator.getRouteDefinitions() .map(this::convertToRoute);  routes = routes.onErrorContinue((error, obj) -> {    return routes.map(route -> {            return route;  });}

合并谓词(链式调用)PTi28资讯网——每日最新资讯28at.com

private AsyncPredicate<ServerWebExchange> combinePredicates(            RouteDefinition routeDefinition) {  // other code  for (PredicateDefinition andPredicate : predicates.subList(1, predicates.size())) {    AsyncPredicate<ServerWebExchange> found = lookup(routeDefinition, andPredicate);    predicate = predicate.and(found);  }  return predicate;}

进入lookup中PTi28资讯网——每日最新资讯28at.com

private AsyncPredicate<ServerWebExchange> lookup(RouteDefinition route, PredicateDefinition predicate) {  RoutePredicateFactory<Object> factory = this.predicates.get(predicate.getName());  if (factory == null) {    throw new IllegalArgumentException("Unable to find RoutePredicateFactory with name " + predicate.getName());  }  // 这里将配置中(yml文件)配置的name,args和谓词工厂中的Config进行关联设置值  Object config = this.configurationService.with(factory)    .name(predicate.getName())    .properties(predicate.getArgs())    .eventFunction((bound, properties) -> new PredicateArgsEvent(        RouteDefinitionRouteLocator.this, route.getId(), properties))    .bind();  // 最终调用谓词工厂(XxxRoutePredicateFactory的apply方法返回RoutePredicate该对象继承Predicate)  return factory.applyAsync(config);}

lookup方法中查找,也就是在这里将对应的谓词Config与RouteDefinition(Predicate)中定义的相对应的属性关联。PTi28资讯网——每日最新资讯28at.com

进入factory.applyAsync方法PTi28资讯网——每日最新资讯28at.com

@FunctionalInterfacepublic interface RoutePredicateFactory<C> extends ShortcutConfigurable, Configurable<C> {  default AsyncPredicate<ServerWebExchange> applyAsync(C config) {    return toAsyncPredicate(apply(config)); // 查看下面的6.2-1图当前apply所有的实现就是系统内部定义的XxxRoutePredicateFactory  }}// apply(config),如这里配置了Path谓词,那么就会进入PathRoutePredicateFactory中的apply方法public Predicate<ServerWebExchange> apply(Config config) {  // other code      return new GatewayPredicate() {    public boolean test() {      // todo        }  }}// 最后返回一个异步的谓词public static AsyncPredicate<ServerWebExchange> toAsyncPredicate(Predicate<? super ServerWebExchange> predicate) {  Assert.notNull(predicate, "predicate must not be null");  // 这里from就是返回一个DefaultAsyncPredicate默认的异步谓词  return AsyncPredicate.from(predicate);}static AsyncPredicate<ServerWebExchange> from( Predicate<? super ServerWebExchange> predicate) {  return new DefaultAsyncPredicate<>(GatewayPredicate.wrapIfNeeded(predicate));}

图6.2-1PTi28资讯网——每日最新资讯28at.com

图片图片PTi28资讯网——每日最新资讯28at.com

最后在combinePredicates方法中将当前路由中配置的所有谓词进行了and操作返回。最终回到convertToRoute方法中将当前路由中配置的谓词,过滤器进行了整合包装返回Route(一个路由对象)PTi28资讯网——每日最新资讯28at.com

public class Route implements Ordered {  private final String id;     private final URI uri;     private final int order;     private final AsyncPredicate<ServerWebExchange> predicate;     private final List<GatewayFilter> gatewayFilters;     private final Map<String, Object> metadata;}

这些Route对象会被保存在上面说的
CachingRouteLocator.routes中。PTi28资讯网——每日最新资讯28at.com

6.3 定位路由

根据上面的配置RouteLocator 该类用来定位路由(查找具体的使用哪个路由);当一个请求过来会查找是哪个路由。PTi28资讯网——每日最新资讯28at.com

RouteLocator中定义了一个方法PTi28资讯网——每日最新资讯28at.com

public interface RouteLocator {  Flux<Route> getRoutes();}

查看这个getRoutes方法是谁调用的PTi28资讯网——每日最新资讯28at.com

图片图片PTi28资讯网——每日最新资讯28at.com

看到这个RoutePredicateHandlerMapping是不是想起了Spring MVC中的HandlerMapping(我们所有的Controller都会被 RequestMappingHanlderMapping 匹配)。通过名称也就知道了该HandlerMapping用来匹配我们的路由谓词的谁来处理路由。PTi28资讯网——每日最新资讯28at.com

接下来回到前面说的RequestMappingHanlderMapping 对象,当我们请求一个路由地址时会执行该类中的lookup方法查找路由PTi28资讯网——每日最新资讯28at.com

protected Mono<Route> 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)PTi28资讯网——每日最新资讯28at.com

public interface AsyncPredicate<T> extends Function<T, Publisher<Boolean>> {  static AsyncPredicate<ServerWebExchange> from(Predicate<? super ServerWebExchange> predicate) {  return new DefaultAsyncPredicate<>(GatewayPredicate.wrapIfNeeded(predicate));  }  class DefaultAsyncPredicate<T> implements AsyncPredicate<T> {    private final Predicate<T> delegate;    public DefaultAsyncPredicate(Predicate<T> delegate) {      this.delegate = delegate;    }    @Override    public Publisher<Boolean> apply(T t) {      return Mono.just(delegate.test(t));    }    @Override    public String toString() {      return this.delegate.toString();    }  }}

这里会调用Predicate.test方法(XxxRoutePredicateFactory中的apply方法返回的GatewayPredicate)。PTi28资讯网——每日最新资讯28at.com

调用GatewayPredicate.test返回判断当前请求的路由是否匹配。PTi28资讯网——每日最新资讯28at.com

整体的一个流程:PTi28资讯网——每日最新资讯28at.com

1、系统先初始化所有的Predicate(谓词)和Filter(过滤器)PTi28资讯网——每日最新资讯28at.com

2、根据配置的路由信息(过滤器,谓词)包装返回Route对象PTi28资讯网——每日最新资讯28at.com

3、根据请求路由路径查找匹配的路由PTi28资讯网——每日最新资讯28at.com


PTi28资讯网——每日最新资讯28at.com

本文链接:http://www.28at.com/showinfo-26-5745-0.htmlSpringCloud Gateway 路由如何定位从底层源码分析

声明:本网页内容旨在传播知识,若有侵权等问题请及时与本网联系,我们将在第一时间删除处理。邮件:2376512515@qq.com

上一篇: 18 个高级工程师必须会的强大JavaScript 技巧

下一篇: 代码的未来洞察:程序员们对技术趋势的解读

标签:
  • 热门焦点
  • 一加Ace2 Pro真机揭晓 钛空灰配色质感拉满

    终于,在经过了几波预热之后,一加Ace2 Pro的外观真机图在网上出现了。还是博主数码闲聊站曝光的,这次的外观设计还是延续了一加11的方案,只是细节上有了调整,例如新加入了钛空灰
  • 印度登月最关键一步!月船三号今晚进入环月轨道

    8月5日消息,据印度官方消息,月船三号将于北京时间今晚21时30分左右开始近月制动进入环月轨道。这是该探测器能够成功的最关键步骤之一,如果成功将开始围
  • 每天一道面试题-CPU伪共享

    前言:了不起:又到了每天一到面试题的时候了!学弟,最近学习的怎么样啊 了不起学弟:最近学习的还不错,每天都在学习,每天都在进步! 了不起:那你最近学习的什么呢? 了不起学弟:最近在学习C
  • 腾讯盖楼,字节拆墙

    来源 | 光子星球撰文 | 吴坤谚编辑 | 吴先之&ldquo;想重温暴刷深渊、30+技能搭配暴搓到爽的游戏体验吗?一起上晶核,即刻暴打!&rdquo;曾凭借直播腾讯旗下代理格斗游戏《DNF》一
  • 冯提莫签约抖音公会 前“斗鱼一姐”消失在直播间

    来源:直播观察提起&ldquo;冯提莫&rdquo;这个名字,很多网友或许听过,但应该不记得她是哪位主播了。其实,作为曾经的&ldquo;斗鱼一姐&rdquo;,冯提莫在游戏直播的年代影响力不输于现
  • iQOO Neo8 Pro抢先上架:首发天玑9200+ 安卓性能之王

    经过了一段时间的密集爆料,昨日iQOO官方如期对外宣布:将于5月23日推出全新的iQOO Neo8系列新品,官方称这是一款拥有旗舰级性能调校的作品。随着发布时
  • 联想的ThinkBook Plus下一版曝光,键盘旁边塞个平板

    ThinkBook Plus 是联想的一个特殊笔记本类别,它在封面放入了一块墨水屏,也给人留下了较为深刻的印象。据有人爆料,联想的下一款 ThinkBook Plus 可能更特殊,它
  • AI艺术欣赏体验会在上海梅赛德斯奔驰中心音乐俱乐部上演

    光影交错的镜像世界,虚实幻化的视觉奇观,虚拟偶像与真人共同主持,这些场景都出现在2019世界人工智能大会的舞台上。8月29日至31日,“AI艺术欣赏体验会”在上海
  • 荣耀Magic4 至臻版 首创智慧隐私通话 强劲影音系统

    2022年第一季度临近尾声,在该季度内,许多品牌陆续发布自己的最新产品,让大家从全新的角度来了解当今的手机技术。手机是电子设备中,更新迭代十分迅速的一款产品,基
Top