Spring Cloud Gateway 动态路由加载：使用 Nacos 实现动态路由配置

背景介绍

在日常开发中，经常遇到运行时动态管理路由配置的需求。传统方式通常需要重启网关服务，这显然不够优雅且效率较低。为了解决这个问题，我们可以借助 Nacos 配置中心功能，结合 Spring Cloud Gateway，实现动态路由的加载和更新。

代码实现

以下是动态路由加载的关键实现代码：

package ***.hmall.gateway.routers;

import ***.hutool.json.JSONUtil;
import ***.alibaba.cloud.nacos.NacosConfigManager;
import ***.alibaba.nacos.api.config.listener.Listener;
import ***.alibaba.nacos.api.exception.NacosException;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.gateway.route.RouteDefinition;
import org.springframework.cloud.gateway.route.RouteDefinitionWriter;
import org.springframework.stereotype.***ponent;
import reactor.core.publisher.Mono;

import javax.annotation.PostConstruct;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.concurrent.Executor;

/**
 * @since 2024/7/28
 */
@Slf4j
@***ponent
@RequiredArgsConstructor
public class DynamicRouteLoader {
    private final NacosConfigManager nacosConfigManager;
    private final RouteDefinitionWriter writer;
    private final String dataId = "gateway-routes.json";
    private final String group = "DEFAULT_GROUP";
    private final Set<String> routeIds = new HashSet<>();

    @PostConstruct
    public void initRouteConfigListener() throws NacosException {
        // 1. 项目启动时，先拉取一次配置，并添加配置监听器
        String configInfo = nacosConfigManager.getConfigService()
                                              .getConfigAndSignListener(dataId, group, 500, new Listener() {
                                                  @Override
                                                  public Executor getExecutor() {
                                                      return null;
                                                  }

                                                  @Override
                                                  public void receiveConfigInfo(String s) {
                                                      // 2. 监听到配置变更时，更新路由表
                                                      updateConfigInfo(s);
                                                  }
                                              });
        // 3. 第一次读取到配置时，初始化路由表
        updateConfigInfo(configInfo);
    }

    public void updateConfigInfo(String configInfo) {
        log.debug("监听到路由配置信息：{}", configInfo);
        // 1. 解析配置信息，转换为RouteDefinition对象
        List<RouteDefinition> routeDefinitions = JSONUtil.toList(configInfo, RouteDefinition.class);
        // 2. 删除旧的路由表
        for (String routeId : routeIds) {
            writer.delete(Mono.just(routeId)).subscribe();
        }
        routeIds.clear();
        // 3. 更新路由表
        for (RouteDefinition routeDefinition : routeDefinitions) {
            // 3.1 更新路由表
            writer.save(Mono.just(routeDefinition)).subscribe();
            // 3.2 记录路由id，便于下次更新时删除
            routeIds.add(routeDefinition.getId());
        }
    }
}

关键步骤解析

1. 初始化配置监听器：在项目启动时，initRouteConfigListener 方法会从 Nacos 配置中心拉取当前的路由配置，并添加配置变更监听器。该监听器会监控 Nacos 配置的更新。

2. 更新路由配置：当监听器检测到配置变更时，updateConfigInfo 方法会被调用，更新路由配置。具体操作包括：

   • 解析新的路由配置信息，将其转换为 RouteDefinition 对象。
   • 删除旧的路由配置，确保不会有遗留的路由规则。
   • 保存新的路由配置，并记录新的路由 ID 以便于后续更新时能正确删除。

3. 日志记录：在更新路由配置的过程中，使用日志记录每个关键操作，便于后续调试与监控。

总结

通过以上实现，我们成功在 Spring Cloud Gateway 中利用 Nacos 实现了动态路由的配置。这大大提升了路由管理的灵活性和效率，无需重启服务即可动态地增删改路由。实际项目中，你还可以根据需求进一步扩展功能，例如添加异常处理机制、优化性能等。

这种动态路由配置的方式，在微服务架构中尤为适用，使得系统在保持高可用的同时，能够快速响应变化需求。