网关 Spring-Cloud-Gateway 源码解析 —— 路由(1.1)之RouteDefinitionLocator一览

1. 概述

本文主要对 路由定义定位器 RouteDefinitionLocator 做整体的认识

在 《Spring-Cloud-Gateway 源码解析 —— 网关初始化》 中,我们看到路由相关的组件 RouteDefinitionLocator / RouteLocator 的初始化。涉及到的类比较多,我们用下图重新梳理下 :

  • RouteDefinitionLocator 负责读取路由配置( org.springframework.cloud.gateway.route.RouteDefinition ) 。从上图中我们可以看到,RouteDefinitionLocator 接口有四种实现 :
    • PropertiesRouteDefinitionLocator ,从配置文件( 例如,YML / Properties 等 ) 读取。在 《Spring-Cloud-Gateway 源码解析 —— 路由(1.2)之 PropertiesRouteDefinitionLocator 配置文件》「2. PropertiesRouteDefinitionLocator」 详细解析。
    • RouteDefinitionRepository ,从存储器( 例如,内存 / Redis / MySQL 等 )读取。在 《Spring-Cloud-Gateway 源码解析 —— 路由(1.3)之 RouteDefinitionRepository 存储器》 详细解析。
    • DiscoveryClientRouteDefinitionLocator ,从注册中心( 例如,Eureka / Consul / Zookeeper / Etcd 等 )读取。在 《Spring-Cloud-Gateway 源码解析 —— 路由(1.4)之 DiscoveryClientRouteDefinitionLocator 注册中心》 详细解析。
    • CompositeRouteDefinitionLocator ,组合多种 RouteDefinitionLocator 的实现,为 RouteDefinitionRouteLocator 提供统一入口。在 本文 详细解析。
    • 另外,CachingRouteDefinitionLocator 也是 RouteDefinitionLocator 的实现类,已经被 CachingRouteLocator 取代。
  • RouteLocator 可以直接自定义路由( org.springframework.cloud.gateway.route.Route ) ,也可以通过 RouteDefinitionRouteLocator 获取 RouteDefinition ,并转换成 Route 。
  • 重要,对于上层调用者 RoutePredicateHandlerMapping ,使用的是 RouteLocator 和 Route 。而 RouteDefinitionLocator 和 RouteDefinition 用于通过配置定义路由那么自定义 RouteLocator 呢?通过代码定义路由

推荐 Spring Cloud 书籍

  • 请支持正版。下载盗版,等于主动编写低级 BUG
  • 程序猿DD —— 《Spring Cloud微服务实战》
  • 周立 —— 《Spring Cloud与Docker微服务架构实战》
  • 两书齐买,京东包邮。

推荐 Spring Cloud 视频

  • Java 微服务实践 - Spring Boot
  • Java 微服务实践 - Spring Cloud
  • Java 微服务实践 - Spring Boot / Spring Cloud

2. RouteDefinition

org.springframework.cloud.gateway.route.RouteDefinition ,路由定义。代码如下 :

@Validated
public class RouteDefinition {

    @NotEmpty
    private String id = UUID.randomUUID().toString();
    /**
     * 谓语定义数组
     */
    @NotEmpty
    @Valid
    private List<PredicateDefinition> predicates = new ArrayList<>();
    /**
     * 过滤器定义数组
     */
    @Valid
    private List<FilterDefinition> filters = new ArrayList<>();
    /**
     * 路由向的 URI
     */
    @NotNull
    private URI uri;
    /**
     * 顺序
     */
    private int order = 0;
}    
  • id 属性,ID 编号,唯一
  • predicates 属性,谓语定义数组。请求通过 predicates 判断是否匹配。在 Route 里,PredicateDefinition 转换成 Predicate 。
  • filters 属性,过滤器定义数组。在 Route 里,FilterDefinition 转换成 GatewayFilter 。
  • uri 属性,路由向的 URI 。
  • order 属性,顺序。当请求匹配到多个路由时,使用顺序的。

RouteDefinition 提供 text 字符串创建对象,代码如下 :

/**
 * 根据 text 创建 RouteDefinition
 *
 * @param text 格式 ${id}=${uri},${predicates[0]},${predicates[1]}...${predicates[n]}
 *             例如 route001=http://127.0.0.1,Host=**.addrequestparameter.org,Path=/get
 */
public RouteDefinition(String text) {
    int eqIdx = text.indexOf("=");
    if (eqIdx <= 0) {
        throw new ValidationException("Unable to parse RouteDefinition text '" + text + "'" +
                ", must be of the form name=value");
    }
    // id
    setId(text.substring(0, eqIdx));
    // predicates
    String[] args = tokenizeToStringArray(text.substring(eqIdx+1), ",");
    // uri
    setUri(URI.create(args[0]));

    for (int i=1; i < args.length; i++) {
        this.predicates.add(new PredicateDefinition(args[i]));
    }
}
  • text 参数,格式为 ${id}=${uri},${predicates[0]},${predicates[1]}...${predicates[n]} 。举个例子, "route001=http://127.0.0.1,Host=**.addrequestparameter.org,Path=/get" 。创建的 RouteDefinition 如下图 :
  • filters 属性,需要通过调用 RouteDefinition#setFilters(filters) 方法进行设置。
  • order 属性,需要通过调用 RouteDefinition#setOrder(order) 方法进行设置。
  • predicates 属性,支持解析,但是如果此处单个 PredicateDefinition 的 args[i] 存在逗号( , ) ,会被错误的分隔,例如说,"Query=foo,bz"

3. PredicateDefinition

org.springframework.cloud.gateway.handler.predicate.PredicateDefinition ,谓语定义。请求通过 predicates 判断是否匹配。代码如下 :

@Validated
public class PredicateDefinition {

    /**
     * 谓语定义名字
     */
    @NotNull
    private String name;
    /**
     * 参数数组
     */
    private Map<String, String> args = new LinkedHashMap<>();
}
  • name 属性,谓语定义名字。通过 name 对应到 org.springframework.cloud.gateway.handler.predicate.RoutePredicateFactory实现类。例如说,name=Query 对应到 QueryRoutePredicateFactory 。
  • args 属性,参数数组。例如,name=Host / args={"_genkey_0" : "iocoder.cn"} ,匹配请求的 hostnameiocoder.cn

PredicateDefinition 提供 text 字符串创建对象,代码如下 :

/**
 * 根据 text 创建 PredicateDefinition
 *
 * @param text 格式 ${name}=${args[0]},${args[1]}...${args[n]}
 *             例如 Host=iocoder.cn
 */
public PredicateDefinition(String text) {
    int eqIdx = text.indexOf("=");
    if (eqIdx <= 0) {
        throw new ValidationException("Unable to parse PredicateDefinition text '" + text + "'" +
                ", must be of the form name=value");
    }
    // name
    setName(text.substring(0, eqIdx));
    // args
    String[] args = tokenizeToStringArray(text.substring(eqIdx+1), ",");
    for (int i=0; i < args.length; i++) {
        this.args.put(NameUtils.generateName(i), args[i]);
    }
}
  • text 参数,格式为 ${name}=${args[0]},${args[1]}...${args[n]} 。举个例子, "Host=iocoder.cn" 。创建的 PredicateDefinition 如下图 :

4. FilterDefinition

FilterDefinition 和 PredicateDefinition 的代码实现上基本一致

org.springframework.cloud.gateway.filter.FilterDefinition ,过滤器定义。代码如下 :

@Validated
public class FilterDefinition {

    /**
     * 过滤器定义名字
     */
    @NotNull
    private String name;
    /**
     * 参数数组
     */
    private Map<String, String> args = new LinkedHashMap<>();
}
  • name 属性,过滤器定义名字。通过 name 对应到 org.springframework.cloud.gateway.filter.factory.GatewayFilterFactory实现类。例如说,name=AddRequestParameter 对应到 AddRequestParameterGatewayFilterFactory 。
  • args 属性,参数数组。例如,name=AddRequestParameter / args={"_genkey_0": "foo", "_genkey_1": "bar"} ,添加请求参数 foobar

FilterDefinition 提供 text 字符串创建对象,代码如下 :

/**
 * 根据 text 创建 FilterDefinition
 *
 * @param text 格式 ${name}=${args[0]},${args[1]}...${args[n]}
 *             例如 AddRequestParameter=foo, bar
 */
public FilterDefinition(String text) {
    int eqIdx = text.indexOf("=");
    if (eqIdx <= 0) {
        setName(text);
        return;
    }
    // name
    setName(text.substring(0, eqIdx));
    // args
    String[] args = tokenizeToStringArray(text.substring(eqIdx+1), ",");
    for (int i=0; i < args.length; i++) {
        this.args.put(NameUtils.generateName(i), args[i]);
    }
}
  • text 参数,格式为 ${name}=${args[0]},${args[1]}...${args[n]} 。举个例子, "AddRequestParameter=foo, bar" 。创建的 FilterDefinition 如下图 :

5. RouteDefinitionLocator

org.springframework.cloud.gateway.route.RouteDefinitionLocator ,路由定义定位器接口,定义获得路由定义数组的方法。代码如下 :

public interface RouteDefinitionLocator {

    Flux<RouteDefinition> getRouteDefinitions();
}
  • 对 Reactor Flux 暂时不熟悉的同学,可以阅读完本文 Google 进行学习。随着 Spring 5 对响应式编程的推广,厉害如你一定要去掌握。

在上文中,我们也看到了 RouteDefinitionLocator 的多个实现类,类图如下 :

  • 本文只解析 CompositeRouteDefinitionLocator 的源码实现。其他的实现类会在后面文章详细解析。

6. CompositeRouteDefinitionLocator

org.springframework.cloud.gateway.route.CompositeRouteDefinitionLocator ,组合多种RouteDefinitionLocator 的实现,为 RouteDefinitionRouteLocator 提供统一入口。代码如下 :

public class CompositeRouteDefinitionLocator implements RouteDefinitionLocator {

    /**
     * RouteDefinitionLocator 数组
     */
    private final Flux<RouteDefinitionLocator> delegates;

    public CompositeRouteDefinitionLocator(Flux<RouteDefinitionLocator> delegates) {
        this.delegates = delegates;
    }

    @Override
    public Flux<RouteDefinition> getRouteDefinitions() {
        return this.delegates.flatMap(RouteDefinitionLocator::getRouteDefinitions);
    }

}
  • #getRouteDefinitions() 方法,提供统一方法,将组合的 delegates 的路由定义全部返回。

原文发布于微信公众号 - 芋道源码(YunaiV)

原文发表时间:2018-05-07

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏LeoXu的博客

Tapestry 教程(四)探索项目结构 原

l Web应用程序文件放在 src/main/webapp(包括src/main/webapp/WEB-INF)

9320
来自专栏冷冷

【jfinal修仙系列】修改ShiroPlugin支持jfinal3.0

在升级到jfinal3.0 以后,原有的shiroplugin不兼容,原来的 routes 是用通过JfinalConfig 注入 new ShiroPlugi...

218100
来自专栏Golang语言社区

linux 内核同步机制使用

Linux 内核中的同步机制:原子操作、信号量、读写信号量、自旋锁的API、大内核锁、读写锁、大读者锁、RCU和顺序锁。 1、介绍 在现代操作系统里,同一时间...

48150
来自专栏Ryan Miao

在dropwizard中使用feign,使用hystrix

前言 用惯了spring全家桶之后,试试dropwizard的Hello World也别有一帆风味。为了增强对外访问API的能力,需要引入open feign...

430120
来自专栏SDNLAB

OpenDaylight Carbon二次开发实用指南

通过本文你将知道: Maven Archetype的基本原理以及如何使用Maven Archetype生成适用于不同版本的ODL子项目。 本文将着重讲解cli命...

466150
来自专栏Java后端技术

Java代码简化神器-Lombok

  前段时间在开源社区中发现了一个比较牛逼的简化Java代码的神器-Lombok,接着自己写了demo进行测试和练习,感觉真的很不错,特此分享给需要的小伙伴们~

14050
来自专栏玩转JavaEE

Spring Cloud中Hystrix的请求合并

在微服务架构中,我们将一个项目拆分成很多个独立的模块,这些独立的模块通过远程调用来互相配合工作,但是,在高并发情况下,通信次数的增加会导致总的通信时间增加,同时...

40970
来自专栏王磊的博客

Spring Boot 最佳实践(四)模板引擎Thymeleaf集成

Thymeleaf是一种Java XML / XHTML / HTML5模板引擎,可以在Web和非Web环境中使用。它更适合在基于MVC的Web应用程序的视图层...

34920
来自专栏林欣哲

单元测试JUnit4 知识点速查

JUnit4的变化 JUnit4的测试类不再需要继承测试类。 只要用了@Test注解,方法名不再需要test开头 直接IDE支持用JUnit测试。 测试用例的目...

35680
来自专栏Android 研究

Android系统启动——4 zyogte进程 (C篇)

我们大家都是知道"一鼎三足"和"三角形的稳定性",那么支撑Android系统的三个"足"是什么?即init进程、SystemServer进程和Zygote进程。...

43010

扫码关注云+社区

领取腾讯云代金券