网关动态路由实现-SpringCloud Gateway

前言

动态路由背景

在使用 Cloud Gateway 的时候，官方文档提供的方案总是基于配置文件配置的方式

例如：

spring:
      routes:
        - id: auth
          uri: ${gateway.route.url.uaa-service}
          predicates:
            - Path=/api-uaa/**
          filters:
            - StripPrefix=1
            - PreserveHostHeader
        - id: auth-login-page
          uri: ${gateway.route.url.uaa-service}
          predicates:
            - Path=/login.html
          filters:
            - PreserveHostHeader

配置更改需要重启服务，不能满足实际生产过程中的动态刷新、实时变更的业务需求。
基于以上分析，需要根据spring cloud gateway 加载properties属性的机制，将其路由信息保存到支持分布式访问的存储中，以及实现在网关不停服务的情况下更新路由信息。

Spring Cloud Gateway 路由加载源码

DispatcherHandler 接管用户请求
RoutePredicateHandlerMapping 路由匹配
1. 根据RouteLocator获取 RouteDefinitionLocator
2. 返回多个RouteDefinitionLocator.getRouteDefinitions()的路由定义信息
FilteringWebHandler执行路由定义中的filter 最后路由到具体的业务服务中

image

Spring Cloud Gateway 默认动态路由实现

GatewayControllerEndpoint 基于actuate端点的默认实现，支持JVM 级别的动态路由，不能序列化存储

image

// 上图动态路由的信息保存的默认实现是基于内存的实现
public class InMemoryRouteDefinitionRepository implements RouteDefinitionRepository {
  private final Map<String, RouteDefinition> routes = synchronizedMap(new LinkedHashMap<String, RouteDefinition>());
  @Override
  public Mono<Void> save(Mono<RouteDefinition> route){}
  @Override
  public Mono<Void> delete(Mono<String> routeId){} 
  @Override
  public Flux<RouteDefinition> getRouteDefinitions(){}
}

扩展方案

扩展基于Mysql + Redis存储分布式动态组件
为什么使用Mysql的同时，又要使用Redis？

spring cloud gateway 基于webflux 背压，暂时不支持mysql 数据库
Redis-reactive 支持 spring cloudgateway 的背压，同时还可以实现分布式，高性能

扩展思路

image

使用管理后端应用（如：UMS）管理网关路由规则
使用管理后端应用发布路由规则，将发布的路由规则更新到Redis中。
网关模块重写RouteDefinitionRepository接口的getRouteDefinitions方法，实现从Redis中读取并加载路由规则。

实现

后端应用管理路由规则

image.png

网关重写RouteDefinitionRepository

网关默认RouteDefinitionRepository实现是基于内存加载，需要扩展一个基于Redis的实现类。

package org.springframework.cloud.gateway.route;

public interface RouteDefinitionRepository
        extends RouteDefinitionLocator, RouteDefinitionWriter {

}

其它

当路由规则更新到Redis时，网关模块基于Redis的订阅接口获取路由更新消息，重新加载Redis中的最新路由规则。如果技术框架中已经使用消息中间件，也可以基于消息中间件发送路由规则更新消息，通知网关更新路由规则。