Spring Cloud Gateway的动态路由怎样做？集成Nacos实现很简单

一、说明

网关的核心概念就是路由配置和路由规则，而作为所有请求流量的入口，在实际生产环境中为了保证高可靠和高可用，是尽量要避免重启的，所以实现动态路由是非常有必要的；本文主要介绍 spring cloud gateway 实现的思路，并且以nacos为数据源来讲解

ps：关于 spring cloud zuul 的动态路由请看文章《spring cloud zuul的动态路由怎样做？集成nacos实现很简单》

 

二、实现要点

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

1. 网关启动时，动态路由的数据怎样加载进来
2. 静态路由与动态路由以那个为准，ps：静态路由指的是配置文件里写死的路由配置
3. 监听动态路由的数据源变化
4. 数据有变化时怎样通知gateway刷新路由

 

三、具体实现

spring cloud gateway 中加载路由信息分别由以下几个类负责

1. propertiesroutedefinitionlocator：从配置文件中读取路由信息(如yml、properties等)
2. routedefinitionrepository：从存储器中读取路由信息(如内存、配置中心、redis、mysql等)
3. discoveryclientroutedefinitionlocator：从注册中心中读取路由信息(如nacos、eurka、zookeeper等)

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

 

3.1. 实现动态路由的数据加载

创建一个nacos的routedefinitionrepository实现类

nacosroutedefinitionrepository类可查看：nacosroutedefinitionrepository.java

重写 getroutedefinitions 方法实现路由信息的读取

 
配置nacos监听器，监听路由配置信息的变化

路由变化只需要往 applicationeventpublisher 推送一个 refreshroutesevent 事件即刻，gateway会自动监听该事件并调用 getroutedefinitions 方法更新路由信息

 

3.2. 创建配置类

dynamicrouteconfig类可查看：dynamicrouteconfig.java

 

3.3. 添加nacos路由配置

新增配置项：

• data id：scg-routes
• group：scg_gateway
• 配置内容：

[
    {
        "id": "csdn",
        "predicates": [{
            "name": "path",
            "args": {
                    "pattern": "/csdn/**"
            }
        }],
        "uri": "https://www.csdn.net/",
        "filters": []
    },
    {
        "id": "github",
        "predicates": [{
            "name": "path",
            "args": {
                    "pattern": "/github/**"
            }
        }],
        "uri": "http://github.com/",
        "filters": []
    }
]

添加两条路由数据

 

四、测试

启动网关通过 /actuator/gateway/routes 端点查看当前路由信息

可以看到 nacos 里配置的两条路由信息

 
完整的spring cloud gateway代码请查看

 

推荐阅读

• 日志排查问题困难？分布式日志链路跟踪来帮你
• zuul集成sentinel最新的网关流控组件
• spring cloud zuul的动态路由怎样做？集成nacos实现很简单
• spring cloud开发人员如何解决服务冲突和实例乱窜？
• spring cloud同步场景分布式事务怎样做？试试seata
• spring cloud异步场景分布式事务怎样做？试试rocketmq

 
扫码关注有惊喜！