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

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

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

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

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

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

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

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

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

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

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

1.1 gateway自动配置

在下面这个类中配置了所有的Predicate和Filter。kNh28资讯网——每日最新资讯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起到缓存的作用,将配置的所有路由信息保存。kNh28资讯网——每日最新资讯28at.com

注意:这里的路由信息是在容器启动后就会被初始化的。kNh28资讯网——每日最新资讯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信息。最终的会委托给RouteDefinitionRouteLocatorkNh28资讯网——每日最新资讯28at.com

RouteDefinitionRouteLocator构造函数中的initFactories方法用来映射路由工厂的XxxRoutePredicateFactory。kNh28资讯网——每日最新资讯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 集合中。kNh28资讯网——每日最新资讯28at.com

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

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

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

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

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

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

获取路由信息kNh28资讯网——每日最新资讯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;  });}

合并谓词(链式调用)kNh28资讯网——每日最新资讯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中kNh28资讯网——每日最新资讯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)中定义的相对应的属性关联。kNh28资讯网——每日最新资讯28at.com

进入factory.applyAsync方法kNh28资讯网——每日最新资讯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-1kNh28资讯网——每日最新资讯28at.com

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

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

6.3 定位路由

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

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

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

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

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

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

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

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

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

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

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

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


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

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

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

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

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

标签:
  • 热门焦点
  • 三言两语说透设计模式的艺术-简单工厂模式

    一、写在前面工厂模式是最常见的一种创建型设计模式,通常说的工厂模式指的是工厂方法模式,是使用频率最高的工厂模式。简单工厂模式又称为静态工厂方法模式,不属于GoF 23种设计
  • K8S | Service服务发现

    一、背景在微服务架构中,这里以开发环境「Dev」为基础来描述,在K8S集群中通常会开放:路由网关、注册中心、配置中心等相关服务,可以被集群外部访问;图片对于测试「Tes」环境或者
  • 小红书1周涨粉49W+,我总结了小白可以用的N条涨粉笔记

    作者:黄河懂运营一条性教育视频,被54万人&ldquo;珍藏&rdquo;是什么体验?最近,情感博主@公主是用鲜花做的,火了!仅仅凭借一条视频,光小红书就有超过128万人,为她疯狂点赞!更疯狂的是,这
  • 破圈是B站头上的紧箍咒

    来源 | 光子星球撰文 | 吴坤谚编辑 | 吴先之每年的暑期档都少不了瞄准追剧女孩们的古偶剧集,2021年有优酷的《山河令》,2022年有爱奇艺的《苍兰诀》,今年却轮到小破站抓住了追
  • 年轻人的“职场羞耻感”,无处不在

    作者:冯晓亭 陶 淘 李 欣 张 琳 马舒叶来源:燃次元&ldquo;人在职场,应该选择什么样的着装?&rdquo;近日,在网络上,一个与着装相关的帖子引发关注,在该帖子里,一位在高级写字楼亚洲金
  • 华为HarmonyOS 4.0将于8月4日发布 或搭载AI大模型技术

    华为宣布HarmonyOS4.0将于8月4日正式发布。此前,华为已经针对开发者公布了HarmonyOS4.0,以便于开发者提前进行适配,也因此被曝光出了一些新系统的特性
  • 朋友圈可以修改可见范围了 苹果用户可率先体验

    近日,iOS用户迎来微信8.0.27正式版更新,除了可更换二维码背景外,还新增了多项实用功能。在新版微信中,朋友圈终于可以修改可见范围,简单来说就是已发布的朋友圈
  • onebot M24巧系列一体机采用轻薄机身设计,现已在各平台开售

    onebot M24 巧系列一体机目前已在线上线下各平台同步开售。onebot M24 巧系列采用一体化轻薄机身设计,最薄处为 10.15mm,拥有宝石红、午夜蓝、石墨绿、雅致
  • 世界人工智能大会国际日开幕式活动在世博展览馆开启

    30日上午,世界人工智能大会国际日开幕式活动在世博展览馆开启,聚集国际城市代表、重量级院士专家、国际创新企业代表,共同打造人工智能交流平台。上海市副市
Top