详解Spring Cloud Gateway 数据库存储路由信息的扩展方案

动态路由背景

​ 无论你在使用Zuul还是Spring Cloud Gateway 的时候,官方文档提供的方案总是基于配置文件配置的方式

例如:

 # zuul 的配置形式
 routes:
  pig-auth:
   path: /auth/**
   serviceId: pig-auth
   stripPrefix: true
 # gateway 的配置形式
 routes:
 - id: pigx-auth
   uri: lb://pigx-auth
  predicates:
  - Path=/auth/**
  filters:
  - ValidateCodeGatewayFilter

配置更改需要重启服务,不能满足实际生产过程中的动态刷新、实时变更的业务需求。

​ 基于以上分析 pig已经提供了基于Zuul版本的动态路由功能,附Git 地址传送门,效果如下图可以实时配置修改刷新。

Spring Cloud Gateway 路由加载源码

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

Spring Cloud Gateway 默认动态路由实现

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

// 上图动态路由的信息保存的默认实现是基于内存的实现
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 的背压,同时还可以实现分布式,高性能

扩展思路

  1. 增加一个路由管理模块,参考GatewayControllerEndpoint实现,启动时加载数据库中配置文件到Redis
  2. 网关模块重写RouteDefinitionRepository,getRouteDefinitions()取Redis中读取即可实现
  3. 前端配合 json-view 类似插件,直接修改展示。

具体实现

路由管理模块核心处理逻辑,获取路由和更新路由

/**
 * @author lengleng
 * @date 2018年11月06日10:27:55
 * <p>
 * 动态路由处理类
 */
@Slf4j
@AllArgsConstructor
@Service("sysRouteConfService")
public class SysRouteConfServiceImpl extends ServiceImpl<SysRouteConfMapper, SysRouteConf> implements SysRouteConfService {
  private final RedisTemplate redisTemplate;
  private final ApplicationEventPublisher applicationEventPublisher;

  /**
   * 获取全部路由
   * <p>
   * RedisRouteDefinitionWriter.java
   * PropertiesRouteDefinitionLocator.java
   *
   * @return
   */
  @Override
  public List<SysRouteConf> routes() {
    SysRouteConf condition = new SysRouteConf();
    condition.setDelFlag(CommonConstant.STATUS_NORMAL);
    return baseMapper.selectList(new EntityWrapper<>(condition));
  }

  /**
   * 更新路由信息
   *
   * @param routes 路由信息
   * @return
   */
  @Override
  public Mono<Void> editRoutes(JSONArray routes) {
    // 清空Redis 缓存
    Boolean result = redisTemplate.delete(CommonConstant.ROUTE_KEY);
    log.info("清空网关路由 {} ", result);

    // 遍历修改的routes,保存到Redis
    List<RouteDefinitionVo> routeDefinitionVoList = new ArrayList<>();
    routes.forEach(value -> {
      log.info("更新路由 ->{}", value);
      RouteDefinitionVo vo = new RouteDefinitionVo();
      Map<String, Object> map = (Map) value;

      Object id = map.get("routeId");
      if (id != null) {
        vo.setId(String.valueOf(id));
      }

      Object predicates = map.get("predicates");
      if (predicates != null) {
        JSONArray predicatesArray = (JSONArray) predicates;
        List<PredicateDefinition> predicateDefinitionList =
          predicatesArray.toList(PredicateDefinition.class);
        vo.setPredicates(predicateDefinitionList);
      }

      Object filters = map.get("filters");
      if (filters != null) {
        JSONArray filtersArray = (JSONArray) filters;
        List<FilterDefinition> filterDefinitionList
          = filtersArray.toList(FilterDefinition.class);
        vo.setFilters(filterDefinitionList);
      }

      Object uri = map.get("uri");
      if (uri != null) {
        vo.setUri(URI.create(String.valueOf(uri)));
      }

      Object order = map.get("order");
      if (order != null) {
        vo.setOrder(Integer.parseInt(String.valueOf(order)));
      }

      redisTemplate.setHashValueSerializer(new Jackson2JsonRedisSerializer<>(RouteDefinitionVo.class));
      redisTemplate.opsForHash().put(CommonConstant.ROUTE_KEY, vo.getId(), vo);
      routeDefinitionVoList.add(vo);
    });

    // 逻辑删除全部
    SysRouteConf condition = new SysRouteConf();
    condition.setDelFlag(CommonConstant.STATUS_NORMAL);
    this.delete(new EntityWrapper<>(condition));

    //插入生效路由
    List<SysRouteConf> routeConfList = routeDefinitionVoList.stream().map(vo -> {
      SysRouteConf routeConf = new SysRouteConf();
      routeConf.setRouteId(vo.getId());
      routeConf.setFilters(JSONUtil.toJsonStr(vo.getFilters()));
      routeConf.setPredicates(JSONUtil.toJsonStr(vo.getPredicates()));
      routeConf.setOrder(vo.getOrder());
      routeConf.setUri(vo.getUri().toString());
      return routeConf;
    }).collect(Collectors.toList());
    this.insertBatch(routeConfList);
    log.debug("更新网关路由结束 ");

    this.applicationEventPublisher.publishEvent(new RefreshRoutesEvent(this));
    return Mono.empty();
  }
}

网关自定义RedisRouteDefinitionRepository

 @Slf4j
 @Component
 @AllArgsConstructor
 public class RedisRouteDefinitionWriter implements RouteDefinitionRepository {
   private final RedisTemplate redisTemplate;

   @Override
   public Mono<Void> save(Mono<RouteDefinition> route) {
     return route.flatMap(r -> {
       RouteDefinitionVo vo = new RouteDefinitionVo();
       BeanUtils.copyProperties(r, vo);
       log.info("保存路由信息{}", vo);
       redisTemplate.opsForHash().put(CommonConstant.ROUTE_KEY, r.getId(), vo);
       return Mono.empty();
     });
   }
   @Override
   public Mono<Void> delete(Mono<String> routeId) {
     routeId.subscribe(id -> {
       log.info("删除路由信息{}", id);
       redisTemplate.opsForHash().delete(CommonConstant.ROUTE_KEY, id);
     });
     return Mono.empty();
   }

   @Override
   public Flux<RouteDefinition> getRouteDefinitions() {
     redisTemplate.setHashValueSerializer(new Jackson2JsonRedisSerializer<>(RouteDefinitionVo.class));
     List<RouteDefinitionVo> values = redisTemplate.opsForHash().values(CommonConstant.ROUTE_KEY);
     List<RouteDefinition> definitionList = new ArrayList<>();
     values.forEach(vo -> {
       RouteDefinition routeDefinition = new RouteDefinition();
       BeanUtils.copyProperties(vo, routeDefinition);
       definitionList.add(vo);
     });
     log.debug("redis 中路由定义条数: {}, {}", definitionList.size(), definitionList);
     return Flux.fromIterable(definitionList);
   }
 }

3.库表定义

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持我们。

时间: 2018-11-09

spring cloud如何修复zuul跨域配置异常的问题

前言 本文主要给大家介绍一下在zuul进行跨域配置的时候出现异常该如何解决的方法,分享出来供大家参考学习,下面话不多说了,来一起看看详细的介绍吧. 异常 The 'Access-Control-Allow-Origin' header contains multiple values '*, *', but only one is allowed 实例 Access-Control-Allow-Credentials:true Access-Control-Allow-Credentials:t

springboot2.0和springcloud Finchley版项目搭建(包含eureka,gateWay,Freign,Hystrix)

前段时间spring boot 2.0发布了,与之对应的spring cloud Finchley版本也随之而来了,两者之间的关系和版本对应详见我这边文章:spring boot和spring cloud对应的版本关系 项目地址:spring-cloud-demo spring boot 1.x和spring cloud Dalston和Edgware版本搭建的微服务项目现在已经很流行了,现在很多企业都已经在用了,这里就不多说了. 使用版本说明: spring boot 2.0.x spring

Spring Cloud Gateway使用Token验证详解

引入依赖 <dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-dependencies</artifactId> <version>${spring-cloud.version}</version> <ty

SpringCloud Gateway跨域配置代码实例

这篇文章主要介绍了SpringCloud Gateway跨域配置代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 Springboot版本:2.1.8.RELEASE SpringCloud版本:Greenwich.SR2 yml配置: spring: cloud: gateway: globalcors: cors-configurations: '[/**]': # 允许携带认证信息 # 允许跨域的源(网站域名/ip),设置*为全部

详解SpringCloud Finchley Gateway 统一异常处理

SpringCloud Finchley Gateway 统一异常处理 全文搜索[@@]搜索重点内容标记 1 . 问题:使用SpringCloud Gateway时,会出现各种系统级异常,默认返回HTML. 2 . Finchley版本的Gateway,使用WebFlux形式作为底层框架,而不是Servlet容器,所以常规的异常处理无法使用 翻阅源码,默认是使用DefaultErrorWebExceptionHandler这个类实现结构如下: 可以实现参考DefaultErrorWebExcep

详解SpringCloud Gateway之过滤器GatewayFilter

在Spring-Cloud-Gateway之请求处理流程文中我们了解最终网关是将请求交给过滤器链表进行处理,接下来我们阅读Spring-Cloud-Gateway的整个过滤器类结构以及主要功能 通过源码可以看到Spring-Cloud-Gateway的filter包中吉接口有如下三个,GatewayFilter,GlobalFilter,GatewayFilterChain,下来我依次阅读接口的主要实现功能. GatewayFilterChain 类图 代码 /** * 网关过滤链表接口 * 用

springcloud gateway聚合swagger2的方法示例

问题描述 在搭建分布式应用时,每个应用通过nacos在网关出装配了路由,我们希望网关也可以将所有的应用的swagger界面聚合起来.这样前端开发的时候只需要访问网关的swagger就可以,而不用访问每个应用的swagger. 框架 springcloud+gateway+nacos+swagger 问题分析 swagger页面是一个单页面应用,所有的显示的数据都是通过和springfox.documentation.swagger.web.ApiResponseController进行数据交互,

SpringCloud Finchley Gateway 缓存请求Body和Form表单的实现

在接入Spring-Cloud-Gateway时,可能有需求进行缓存Json-Body数据或者Form-Urlencoded数据的情况. 由于Spring-Cloud-Gateway是以WebFlux为基础的响应式架构设计,所以在原有Zuul基础上迁移过来的过程中,传统的编程思路,并不适合于Reactor Stream的开发. 网络上有许多缓存案例,但是在测试过程中出现各种Bug问题,在缓存Body时,需要考虑整体的响应式操作,才能更合理的缓存数据 下面提供缓存Json-Body数据或者Form

Vue form 表单提交+ajax异步请求+分页效果

废话不多说了,直接给大家贴代码了,具体代码如下所示: <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <meta charset="UTF-

js 提交form表单和设置form表单请求路径的实现方法

如下所示: form表单ID:postform 设置表单请求url document.postform.action = "SaveReturnInfo"; 提交form表单 document.getElementById("postform").submit(); 以上就是小编为大家带来的js 提交form表单和设置form表单请求路径的实现方法全部内容了,希望大家多多支持我们~

layui使用form表单实现post请求页面跳转的方法

如下所示: window.location.href='url?param=' + paramValue; 上面这种方式实现页面跳转附带参数,容易造成信息泄露: layui使用form表单实现post请求,避免信息泄露(设置form表单隐藏,也可以初始化时隐藏): 这里是在数据表格查询数据时的按钮操作,其他操作类似 <table id="myTable" class="layui-table" lay-filter="myTableDetail&qu

Django form表单与请求的生命周期步骤详解

Django中请求的生命周期 HTTP请求及服务端响应中传输的所有数据都是字符串 步骤 用户在浏览器中输入url时,浏览器会生成请求头和请求体发给服务器 url经过wsgi和中间件,到达路由映射表,在路由中一条一条进行匹配 视图函数根据客户端的请求查询响应的数据,返回给 DjangoDjango把客户端想要的数据做为一个字符串返回给客户端 客户端浏览器接收到返回的数据,经过渲染后显示给用户 FBV 一个url对应一个视图函数 在url匹配成功之后,会直接执行对应的视图函数. CBV 一个url对

Spring Cloud使用Feign实现Form表单提交的示例

之前,笔者写了<使用Spring Cloud Feign上传文件>.近日,有同事在对接遗留的Struts古董系统,需要使用Feign实现Form表单提交.其实步骤大同小异,本文附上步骤,算是对之前那篇的补充. 添加依赖: <dependency> <groupId>io.github.openfeign.form</groupId> <artifactId>feign-form</artifactId> <version>

ext form 表单提交数据的方法小结

EXT的form表单ajax提交(默认提交方式) 复制代码 代码如下: 1. function login(item) {    2.    3. if (validatorForm()) {    4. // 登录时将登录按钮设为disabled,防止重复提交    5. this.disabled = true;    6.    7. // 第一个参数可以为submit和load    8. formPanl.form.doAction('submit', {    9.    10. u

angularjs $http实现form表单提交示例

需求:请求第三方后台接口返回一段html字符串如下,由前端去实现form表单的POST提交, 说明:form表单submit()实现自动提交input标签hidden,注意script代码中的document.redirect.submit(); <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> </head

jquery自动将form表单封装成json的具体实现

前端页面: 复制代码 代码如下: <span style="font-size:14px;"> <form action="" method="post" id="tf"> <table width="100%" cellspacing="0" cellpadding="0" border="0"> <tr