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

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

来源：责编：时间：2023-08-14 22:01:30 269观看

导读环境：springcloud Hoxton.SR11本节主要了解系统中的谓词与配置的路由信息是如何进行初始化关联生成路由对象的。每个谓词工厂中的Config对象又是如何被解析配置的。所有的谓词工厂中的Config中属性值是如何被配置的。

环境：springcloud Hoxton.SR11

本节主要了解系统中的谓词与配置的路由信息是如何进行初始化关联生成路由对象的。每个谓词工厂中的Config对象又是如何被解析配置的。

所有的谓词工厂中的Config中属性值是如何被配置的。

在SpringCloud Gateway中的所有谓词工厂如下：

图片

命名规则：XxxRoutePredicateFactory。所有的这些谓词工厂都是如下的继承关系

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

所有的谓词工厂继承的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<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起到缓存的作用，将配置的所有路由信息保存。

注意：这里的路由信息是在容器启动后就会被初始化的。

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信息。最终的会委托给RouteDefinitionRouteLocator

RouteDefinitionRouteLocator构造函数中的initFactories方法用来映射路由工厂的XxxRoutePredicateFactory。

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 集合中。

factory.name()方法解析谓词名称。

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

CachingRouteLocator是个缓存路由定位器，是个首选的RouteLocator（@Primary）,这里将RouteDefinitionRouteLocator进行了合并。

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

getRoutes---》convertToRoute---》combinePredicates---》lookup。

根据上面的自动配置也知道了在服务启动时就进行初始化所有路由信息了。

获取路由信息

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

合并谓词(链式调用)

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中

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)中定义的相对应的属性关联。

进入factory.applyAsync方法

@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-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<ServerWebExchange> predicate;     private final List<GatewayFilter> gatewayFilters;     private final Map<String, Object> metadata;}

这些Route对象会被保存在上面说的
CachingRouteLocator.routes中。

6.3 定位路由

根据上面的配置RouteLocator 该类用来定位路由（查找具体的使用哪个路由）；当一个请求过来会查找是哪个路由。

RouteLocator中定义了一个方法

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

查看这个getRoutes方法是谁调用的

图片

看到这个RoutePredicateHandlerMapping是不是想起了Spring MVC中的HandlerMapping（我们所有的Controller都会被 RequestMappingHanlderMapping 匹配）。通过名称也就知道了该HandlerMapping用来匹配我们的路由谓词的谁来处理路由。

接下来回到前面说的RequestMappingHanlderMapping 对象，当我们请求一个路由地址时会执行该类中的lookup方法查找路由

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)

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）。

调用GatewayPredicate.test返回判断当前请求的路由是否匹配。

整体的一个流程：

1、系统先初始化所有的Predicate(谓词)和Filter(过滤器)

2、根据配置的路由信息（过滤器，谓词）包装返回Route对象

3、根据请求路由路径查找匹配的路由

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

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

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

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

标签：

热门焦点

直屏旗舰来了 iQOO 12和K70 Pro同台竞技

旗舰机基本上使用的都是双曲面屏幕，这就让很多喜欢直屏的爱好者在苦等一款直屏旗舰，这次，你们等到了。据博主数码闲聊站带来的最新爆料称，Redmi下代旗舰K70 Pro和iQOO 12两款手
7月安卓手机好评榜：三星S23Ultra好评率第一

性能榜和性价比榜之后，我们来看最后的安卓手机好评榜，数据来源安兔兔评测，收集时间2023年7月1日至7月31日，仅限国内市场。第一名：三星Galaxy S23 Ultra好评率：95.71%在即将迎来新
在线图片编辑器，支持PSD解析、AI抠图等

自从我上次分享一个人开发仿造稿定设计的图片编辑器到现在，不知不觉已过去一年时间了，期间我经历了裁员失业、面试找工作碰壁，寒冬下一直没有很好地履行计划.....这些就放在日
使用LLM插件从命令行访问Llama 2

最近的一个大新闻是Meta AI推出了新的开源授权的大型语言模型Llama 2。这是一项非常重要的进展：Llama 2可免费用于研究和商业用途。(几小时前，swyy发现它已从LLaMA 2更名为Lla
Python异步IO编程的进程/线程通信实现

这篇文章再讲3种方式，同时讲4中进程间通信的方式一、 Python 中线程间通信的实现方式共享变量共享变量是多个线程可以共同访问的变量。在Python中，可以使用threading模块中的L
2023年，我眼中的字节跳动

此时此刻（2023年7月），字节跳动从未上市，也从未公布过任何官方的上市计划；但是这并不妨碍它成为中国最受关注的互联网公司之一。从2016-17年的抖音强势崛起，到2018年的“头腾
造车两年股价跌六成，小米的估值逻辑变了吗？

如果从小米官宣造车后的首个交易日起持有小米集团的股票，那么截至2023年上半年最后一个交易日，投资者将浮亏59.16%，同区间的恒生科技指数跌幅为52.78%
三星电子Q2营收60万亿韩元存储业务营收同比仍下滑超过50%

7月27日消息，据外媒报道，从三星电子所发布的财报来看，他们主要利润来源的存储芯片业务在今年二季度仍不乐观，营收同比仍在大幅下滑，所在的设备解决方案
iQOO 11S或7月上市：搭载“鸡血版”骁龙8Gen2 史上最强5G Soc

去年底，iQOO推出了“电竞旗舰”iQOO 11系列，作为一款性能强机，iQOO 11不仅全球首发2K 144Hz E6全感屏，搭载了第二代骁龙8平台及144Hz电竞屏，同时在快充