spring cloud gateway 鉴权_Gateway网关源码解析—路由（1.1）之RouteDefinitionLocator一览...

一、概述

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

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

RouteDefinitionLocator 负责读取路由配置( org.springframework.cloud.gateway.route.RouteDefinition ) 。从上图中我们可以看到，RouteDefinitionLocator 接口有四种实现 ：

1、PropertiesRouteDefinitionLocator ，从配置文件( 例如，YML / Properties 等 ) 读取。在 《Spring-Cloud-Gateway 源码解析 —— 路由(1.2)之 PropertiesRouteDefinitionLocator 配置文件》「2.PropertiesRouteDefinitionLocator」 详细解析。

2、RouteDefinitionRepository ，从存储器( 例如，内存 / Redis / MySQL 等 )读取。在 《Spring-Cloud-Gateway 源码解析 —— 路由(1.3)之 RouteDefinitionRepository 存储器》 详细解析。

3、DiscoveryClientRouteDefinitionLocator ，从注册中心( 例如，Eureka / Consul / Zookeeper / Etcd 等 )读取。在 《Spring-Cloud-Gateway 源码解析 —— 路由(1.4)之 DiscoveryClientRouteDefinitionLocator 注册中心》 详细解析。

4、CompositeRouteDefinitionLocator ，组合多种 RouteDefinitionLocator 的实现，为 RouteDefinitionRouteLocator 提供统一入口。在 本文 详细解析。

另外，CachingRouteDefinitionLocator 也是 RouteDefinitionLocator 的实现类，已经被 CachingRouteLocator 取代。

RouteLocator 可以直接自定义路由( org.springframework.cloud.gateway.route.Route ) ，也可以通过 RouteDefinitionRouteLocator 获取 RouteDefinition ，并转换成 Route 。

重要，对于上层调用者 RoutePredicateHandlerMapping ，使用的是 RouteLocator 和 Route 。而 RouteDefinitionLocator 和 RouteDefinition 用于通过配置定义路由。那么自定义 RouteLocator 呢？通过代码定义路由。

二、 RouteDefinition

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

@Validatedpublic class RouteDefinition { @NotEmpty private String id = UUID.randomUUID().toString(); /** * 谓语定义数组 */ @NotEmpty @Valid private List predicates = new ArrayList<>(); /** * 过滤器定义数组 */ @Valid private List 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 + "'" +