springcloud gateway动态路由设计（SpringCloudGateway动态路由之Nacos）

欢迎关注头条号：老顾聊技术

精品原创技术分享，知识的组装工

前言

当我们的网关Gateway程序开发完成之后，需要部署到生产环境，这个时候你的程序不能是单点运行的，肯定是多节点启动(独立部署或者docker等容器部署)，防止单节点故障导致整个服务不能访问，网关是对客户端的入口与出口，在生产运行中极为重要，哪怕是简单的重启也会导致部分请求的丢失。

网关的路由配置这个时候就是一个大问题，是代码里面编写还是配置文件配置？他们都有一个致命的缺点，当有新的程序需要接入到网关进行路由或者有服务需要下线时候需要修改代码或者配置，然后重启整个网关程序，导致其他正常的服务路由受到了影响。

所以在实际生产环境中为了保证高可靠和高可用，是尽量要避免重启网关，所以实现动态路由是非常有必要的；

本文主要介绍 Spring Cloud Gateway 实现的思路，并且把路由信息存放在外部源中，这粒以Nacos为数据源来讲解

实现要点

要实现动态路由只需关注下面4个点

1. 网关启动时，动态路由的数据怎样加载进来
2. 静态路由与动态路由以那个为准
3. 监听动态路由的数据源变化
4. 数据有变化时怎样通知gateway刷新路由

ps：静态路由指的是配置文件里写死的路由配置

具体实现

Spring Cloud Gateway 中加载路由信息分别由以下几个类负责

1. PropertiesRouteDefinitionLocator：从配置文件中读取路由信息(如YML、Properties等)
2. RouteDefinitionRepository：从存储器中读取路由信息(如内存、配置中心、Redis、MySQL等)
3. DiscoveryClientRouteDefinitionLocator：从注册中心中读取路由信息(如Nacos、Eurka、Zookeeper等)

我们可以通过自定义 RouteDefinitionRepository 的实现类来实现动态路由的目的

实现动态路由的数据加载

我们可以查看源码RouteDefinitionRepository的存储的实现类，只有InMemoryRouteDefinitionRepository，此实现类是存放在内存中的。

我们可以重新定义一个nacos作为存储的实现，看下面的代码

上面代码核心的是 重写 getRouteDefinitions 方法实现路由信息的读取 ；这个方法中涉及到了ConfigService对象Api的方法。

管理Api方法，这个老顾这里不详细说了；小伙伴们可以理解为就是操作nacos config的对象

配置Nacos监听器，监听路由配置信息的变化，也是利用api方法，也就是addListener方法；此方法一看就知道，就是用来监听config信息变化的。

此addListener方法中路由变化只需要往 ApplicationEventPublisher 推送一个 RefreshRoutesEvent 事件，即刻gateway会自动监听该事件并调用 getRouteDefinitions 方法更新路由信息 。

这样就达到了动态更新路由了。

配置类

为了更好的把此动态路由作为公共core，我们需要利用配置类，达到是否启用的方式；可以让开发者自行配置。

上面的配置类，有两个重要的@ConditionalOnProperty，这个就是用来控制是否启用动态路由，以及是否用nacos作为存储。

里面还有@Value注解定义我们存储路由信息的DataId和Group，application.yml如果不配置默认值为scg-routes和SCG_GATEWAY

添加Nacos路由配置

在同一个namespace中创建scg-routes和SCG_GATEWAY

格式选择json，json体里面的格式其实就是RouteDefinition类的属性

注意上面的配置的json是数组格式哦，也就是可以有很多路由哦

[{ "id": "baidu", "order": 0, "predicates": [{ "args": { "pattern": "/baidu/**" }, "name": "Path" }], "uri": "https://www.baidu.com" },{ "id": "sina", "order": 2, "predicates": [{ "args": { "pattern": "/sina/**" }, "name": "Path" }], "uri": "http://www.sina.com.cn" }]

测试

在网关项目中的application.yml中配置

rainbow: gateway: dynamicRoute: enabled: true

启动网关，就可以了；为了方便看到网关当前的路由信息，我们需要引入

<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency>

并且在application.yml中配置

management: endpoints: web: exposure: include: '*' endpoint: gateway: enabled: true health: show-details: always

这样我们就可以访问http://localhost:8081/actuator/gateway/routes，就可以看到路由信息

小伙伴们可以尝试修改一下nacos中的dataId为scg-routes，我们可以发现路由及时得到了更改。

老顾只修改了route_id的名称，路由就及时更新了

我们也看到了控制台日志也有相应的变化

总结

gateway的动态路由是非常实用的功能，在生产环境中是必备功能，小伙伴们一定要掌握哦，当然小伙伴们也可以用其他的数据源。谢谢！！！

---End---

---

老顾的微服务网关分享课程，请大家多多支持

推荐阅读

Sharding-jdbc的实战入门之水平分表（一）

Sharding-Jdbc之水平分库和读写分离（二）

a、dubbo如何处理业务异常，这个一定要知道哦！

b、企业级SpringBoot应用多个子项目配置文件规划、多环境支持（一）

c、企业级SpringBoot应用多个子项目配置文件规划、多环境支持（二）

d、企业级SpringBoot应用多个子项目配置文件之配置中心（三）

e、利用阿里开源工具进行排查线上CPU居高问题

f、阿里二面：如何快速排查死锁？如何避免死锁？

g、微服务分布式架构中，如何实现日志链路跟踪？

h、网关如何聚合各个微服务的接口文档？

i、Kubernetes之POD、容器之间的网络通信

j、K8S中的Service的存在理由

k、企业微服务项目如何进入K8S的全过程

l、阿里开源项目Sentinel限流、降级的统一处理

m、大厂二面：Redis的分布式布隆过滤器是什么原理？

1、基于RocketMq的SpringCloud Stream框架实战入门

2、如何搭建消息中间件应用框架之SpringCloud Stream

3、面试必备：网关异常了怎么办？如何做全局异常处理？

4、Gateway网关系列(二)：SpringCloud Gateway入门实战，路由规则

5、Gateway网关系列开篇：SpringCloud的官方网关Gateway介绍

6、API网关在微服务架构中的应用，这一篇就够了

7、学习Lambda表达式看这篇就够了，不会让你失望的哦（续篇）

8、Lambda用在哪里？几种场景？

9、为什么会出现Lambda表达式，你知道吗？

10、不说“分布式事务”理论，直接上大厂阿里的解决方案，绝对实用

11、女程序员问到这个问题，让我思考了半天，Mysql的“三高”架构

12、大厂二面：CAP原则为什么只能满足其中两项？而不能同时满足

13、阿里P7二面：聊聊零拷贝的原理

14、秒杀系统的核心点都在这里，快来取

15、你了解如何利用token方式实现分布式Session吗？

16、Mysql索引结构演变，为什么最终会是那个结构呢？让你一看就懂

17、一场比赛涉及到的知识，用通俗易通的方式介绍并发协调

18、企业实战Redis全方面思考，你思考了吗？

19、面试题：Thread的start和run的区别

20、面试题：什么是CAS？CAS的作用以及缺点

21、如何访问redis中的海量数据？避免事故产生

22、如何解决Redis热点问题？以及如何发现热点？

23、如何设计API接口，实现统一格式返回？

24、你真的知道在生产环境下如何部署tomcat吗？

25、分享一线互联网大厂分布式唯一ID设计 之 snowflake方案

26、分享大厂分布式唯一ID设计方案，快来围观

27、你想了解一线大厂的分布式唯一ID生成方案吗？

28、你知道如何处理大数据量吗？(数据拆分篇)

29、如何永不迁移数据和避免热点? 根据服务器指标分配数据量(揭秘篇)

30、你知道怎么分库分表吗？如何做到永不迁移数据和避免热点吗？

31、你了解大型网站的页面静态化吗？

32、你知道如何更新缓存吗？如何保证缓存和数据库双写一致性？

33、你知道怎么解决DB读写分离，导致数据不一致问题吗？

34、DB读写分离情况下，如何解决缓存和数据库不一致性问题？

35、你真的知道怎么使用缓存吗？

36、如何利用锁，防止缓存击穿？重构思想的重要性

37、海量订单产生的业务高峰期，如何避免消息的重复消费？

38、你知道如何保障生产端100%消息投递成功吗？

39、微服务下的分布式session该如何管理？

40、阿里二面：filter、interceptor、aspect应如何选择？很多人中招

41、互联网架构重要组员CDN，很多高级开发都没有实操过，来看这里

42、阿里二面：CDN缓存控制原理，看看能不能难住你

43、SpringCloud Alibaba之Nacos多环境多项目管理

44、SpringCloud Alibaba系列之Nacos配置中心玩法

45、SpringCloud Alibaba之Nacos注册中心

46、SpringCloud Plus版本之SpringCloud Alibaba

47、SpringCloud Alibaba之Nacos集群、持久化

48、SpringCloud Alibaba之Nacos共享配置、灰度配置

49、SpringCloud Alibaba之Sentinel工作原理

50、SpringCloud Alibaba之Sentinel流控管理

51、SpringCloud Alibaba之Sentinel降级管理

52、SpringCloud Alibaba之Sentinel热点参数限流

53、SpringCloud Alibaba之Sentinel的API实战

,