SpringCloud Gateway动态路由之Nacos

2020-10-19

前言

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

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

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

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

实现要点

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

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

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

具体实现

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

PropertiesRouteDefinitionLocator：从配置文件中读取路由信息(如YML、Properties等)
RouteDefinitionRepository：从存储器中读取路由信息(如内存、配置中心、redis、MySQL等)
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的动态路由是非常实用的功能，在生产环境中是必备功能，小伙伴们一定要掌握哦，当然小伙伴们也可以用其他的数据源。谢谢！！！