转载

Spring-Cloud-Gateway 源码解析 —— 网关管理 HTTP API

本文主要基于 Spring-Cloud-Gateway 2.0.X M4

1. 概述
- 2. 过滤器 HTTP API
- 2.1 全局过滤器列表
- 2.2 路由过滤器工厂列表
- 3. 路由 HTTP API
- 2.1 路由列表
- 2.2 单个路由信息
- 2.3 单个路由的过滤器
- 2.4 添加/修改单个路由
- 2.5 删除单个路由
- 2.6 刷新路由缓存
666. 彩蛋

��关注 微信公众号：【芋道源码】 有福利：

RocketMQ / MyCAT / Sharding-JDBC 所有源码分析文章列表
RocketMQ / MyCAT / Sharding-JDBC 中文注释源码 GitHub 地址
您对于源码的疑问每条留言都将得到认真回复。 甚至不知道如何读源码也可以请教噢 。
新的源码解析文章实时收到通知。 每周更新一篇左右 。
认真的 源码交流微信群。

1. 概述

本文主要分享 网关管理 HTTP API 。

org.springframework.cloud.gateway.actuate.GatewayWebfluxEndpoint ，提供管理网关的 HTTP API 。 构造方法 ，代码如下：

@RestController
@RequestMapping("${management.context-path:/application}/gateway")
public class GatewayWebfluxEndpoint implements ApplicationEventPublisherAware{

 private static final Log log = LogFactory.getLog(GatewayWebfluxEndpoint.class);

 /**
* 路由定义定位器
*/
 private RouteDefinitionLocator routeDefinitionLocator;
 /**
* 全局过滤器
*/
 private List<GlobalFilter> globalFilters;
 /**
* 网关过滤器工厂
*/
 private List<GatewayFilterFactory> gatewayFilters;
 /**
* 存储器 RouteDefinitionLocator 对象
*/
 private RouteDefinitionWriter routeDefinitionWriter;
 /**
* 路由定位器
*/
 private RouteLocator routeLocator;
 /**
* 应用事件发布器
*/
 private ApplicationEventPublisher publisher;

 public GatewayWebfluxEndpoint(RouteDefinitionLocator routeDefinitionLocator, List<GlobalFilter> globalFilters,
List<GatewayFilterFactory> GatewayFilters, RouteDefinitionWriter routeDefinitionWriter,
RouteLocator routeLocator){
 this.routeDefinitionLocator = routeDefinitionLocator;
 this.globalFilters = globalFilters;
 this.gatewayFilters = GatewayFilters;
 this.routeDefinitionWriter = routeDefinitionWriter;
 this.routeLocator = routeLocator;
 }
}

@RequestMapping 注解，HTTP API 以 "${management.context-path:/application}/gateway" 。
routeDefinitionLocator 属性，路由定义定位器。在《Spring-Cloud-Gateway 源码解析 —— 路由（2.2）之 RouteDefinitionRouteLocator 路由配置》有详细解析。
globalFilters 属性，全局过滤器。在《Spring-Cloud-Gateway 源码解析 —— 过滤器 (4.1) 之 GatewayFilter 一览》有详细解析。
gatewayFilters 属性，网关过滤器工厂。在《Spring-Cloud-Gateway 源码解析 —— 过滤器 (4.2) 之 GatewayFilterFactory 过滤器工厂》
routeLocator 属性，路由定位器。在《Spring-Cloud-Gateway 源码解析 —— 路由（2.1）之 RouteLocator 一览》有详细解析。
publisher 属性，应用事件发布器。在《Spring5源码解析-Spring框架中的事件和监听器》有相关解析。

GatewayWebfluxEndpoint 提供两类 HTTP API ：

过滤器 HTTP API
路由 HTTP API

2. 过滤器 HTTP API

2.1 全局过滤器列表

@GetMapping("/globalfilters")
public Mono<HashMap<String, Object>> globalfilters() {
 return getNamesToOrders(this.globalFilters);
}

private <T> Mono<HashMap<String, Object>> getNamesToOrders(List<T> list) {
 return Flux.fromIterable(list).reduce(new HashMap<>(), this::putItem);
}

private HashMap<String, Object> putItem(HashMap<String, Object> map, Object o){
 Integer order = null;
 if (o instanceof Ordered) {
 order = ((Ordered)o).getOrder();
 }
 //filters.put(o.getClass().getName(), order);
 map.put(o.toString(), order);
 return map;
}

2.2 路由过滤器工厂列表

@GetMapping("/routefilters")
public Mono<HashMap<String, Object>> routefilers() {
 return getNamesToOrders(this.gatewayFilters);
}

3. 路由 HTTP API

2.1 路由列表

@GetMapping("/routes")
public Mono<Map<String, List>> routes() {
 Mono<List<RouteDefinition>> routeDefs = this.routeDefinitionLocator.getRouteDefinitions().collectList();
 Mono<List<Route>> routes = this.routeLocator.getRoutes().collectList();
 return Mono.zip(routeDefs, routes).map(tuple -> {
 Map<String, List> allRoutes = new HashMap<>();
 allRoutes.put("routeDefinitions", tuple.getT1());
 allRoutes.put("routes", tuple.getT2());
 return allRoutes;
 });
}

2.2 单个路由信息

@GetMapping("/routes/{id}")
public Mono<ResponseEntity<RouteDefinition>> route(@PathVariable String id) {
 //TODO: missing RouteLocator
 return this.routeDefinitionLocator.getRouteDefinitions()
 .filter(route -> route.getId().equals(id))
 .singleOrEmpty()
 .map(route -> ResponseEntity.ok(route))
 .switchIfEmpty(Mono.just(ResponseEntity.notFound().build()));
}

从 TODO: missing RouteLocator ，我们可以看到，目前不支持从 RouteLocator 获取 Route ，只返回 RouteDefinition 。等待未来的版本支持。

2.3 单个路由的过滤器

@GetMapping("/routes/{id}/combinedfilters")
public Mono<HashMap<String, Object>> combinedfilters(@PathVariable String id) {
 //TODO: missing global filters
 return this.routeLocator.getRoutes()
 .filter(route -> route.getId().equals(id))
 .reduce(new HashMap<>(), this::putItem);
}