基于Nacos配置服务的SpringCloudGateway动态路由实现

Spring Cloud Gateway配置路由的方式主要有两种方式,其一是在yml文件中配置,其二是通过硬编码创建RouteLocator实例,但是这两种方式都不支持动态配置,我们的需求是通过Nacos配置中心变更路由规则,Gateway能够实时刷新然后立即生效,基于这种需求,我的思路是通过注册Nacos配置服务的监听器,待收到服务端配置变更的事件后主动刷新Gateway的路由缓存。

image.png

通过源码Gateway自动配置类GatewayAutoConfiguration发现(如上图),RouteDefinitionRepository的实现类是用来存储路由信息的,唯一的实现类是InMemoryRouteDefinitionRepository,根据条件判断注解,在实例化过程中首先查找Spring上下文有没有自定义的RouteDefinitionRepository实现类,如果没有默认用InMemoryRouteDefinitionRepository,所以做动态路由只要实现RouteDefinitionRepository接口即可,具体实现如下:
引入nacos客户端pom依赖:

        <!-- https://mvnrepository.com/artifact/com.alibaba.nacos/nacos-api -->
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-client</artifactId>
            <version>1.1.4</version>
        </dependency>

Nacos服务的配置类,主要为了实例化ConfigService:

@Component
@ConfigurationProperties(prefix = "nacos")
@Data
public class NacosConfig {

    /* 服务地址 */
    private String serverAddr;

    /* 命名空间 */
    private String namespace;

    /**
     * encode for nacos config content.
     */
    private String encode = "UTF-8";

    /**
     * nacos maximum number of tolerable server reconnection errors.
     */
    private String maxRetry = "3";

    /**
     * nacos get config long poll timeout.
     */
    private String configLongPollTimeout;

    /**
     * nacos get config failure retry time.
     */
    private String configRetryTime;

    /**
     * If you want to pull it yourself when the program starts to get the configuration
     * for the first time, and the registered Listener is used for future configuration
     * updates, you can keep the original code unchanged, just add the system parameter:
     * enableRemoteSyncConfig = "true" ( But there is network overhead); therefore we
     * recommend that you use {@link ConfigService#getConfigAndSignListener} directly.
     */
    private boolean enableRemoteSyncConfig = false;

    /**
     * endpoint for Nacos, the domain name of a service, through which the server address
     * can be dynamically obtained.
     */
    private String endpoint;

    /**
     * access key for namespace.
     */
    private String accessKey;

    /**
     * secret key for namespace.
     */
    private String secretKey;

    /**
     * context path for nacos config server.
     */
    private String contextPath;

    /**
     * nacos config cluster name.
     */
    private String clusterName;


    /**
     * 组装配置参数
     * @return
     */
    public Properties assembleConfigServiceProperties() {
        Properties properties = new Properties();
        properties.put(SERVER_ADDR, Objects.toString(this.serverAddr, ""));
        properties.put(ENCODE, Objects.toString(this.encode, ""));
        properties.put(NAMESPACE, Objects.toString(this.namespace, ""));
        properties.put(ACCESS_KEY, Objects.toString(this.accessKey, ""));
        properties.put(SECRET_KEY, Objects.toString(this.secretKey, ""));
        properties.put(CONTEXT_PATH, Objects.toString(this.contextPath, ""));
        properties.put(CLUSTER_NAME, Objects.toString(this.clusterName, ""));
        properties.put(MAX_RETRY, Objects.toString(this.maxRetry, ""));
        properties.put(CONFIG_LONG_POLL_TIMEOUT,
                Objects.toString(this.configLongPollTimeout, ""));
        properties.put(CONFIG_RETRY_TIME, Objects.toString(this.configRetryTime, ""));
        properties.put(ENABLE_REMOTE_SYNC_CONFIG,
                Objects.toString(this.enableRemoteSyncConfig, ""));
        String endpoint = Objects.toString(this.endpoint, "");
        if (endpoint.contains(":")) {
            int index = endpoint.indexOf(":");
            properties.put(ENDPOINT, endpoint.substring(0, index));
            properties.put(ENDPOINT_PORT, endpoint.substring(index + 1));
        } else {
            properties.put(ENDPOINT, endpoint);
        }

        return properties;
    }


    /**
     * 实例化Nacos配置服务
     * @return
     */
    @Bean
    public ConfigService configService() throws NacosException {
        return NacosFactory.createConfigService(this.assembleConfigServiceProperties());
    }

    /**
     * 实例化Nacos路由定义存储器
     * @return
     */
    @Bean
    public NacosRouteDefinitionRepository nacosRouteDefinitionRepository(ApplicationEventPublisher publisher,
                                                                         ConfigService configService) {
        return new NacosRouteDefinitionRepository(publisher, configService);
    }
}

自定义Nacos路由存储器:

/**
 * Nacos路由定义存储器
 */
@Slf4j
public class NacosRouteDefinitionRepository implements RouteDefinitionRepository {
    /* nacos配置属性 */
    private static final String NACOS_DATA_ID  =  "gateway";
    private static final String NACOS_GROUP    =  "DEFAULT_GROUP";

    private final Map<String, RouteDefinition> routes = Maps.newHashMap();

    private ApplicationEventPublisher publisher;

    private ConfigService configService;

    public NacosRouteDefinitionRepository(ApplicationEventPublisher publisher,
                                          ConfigService configService) {
        this.publisher      =  publisher;
        this.configService  =  configService;

        initRouteDefinitions();
        registerNacosListener();
    }

    @Override
    public Flux<RouteDefinition> getRouteDefinitions() {
        return Flux.fromIterable(routes.values());
    }

    @Override
    public Mono<Void> save(Mono<RouteDefinition> route) {
        return null;
    }

    @Override
    public Mono<Void> delete(Mono<String> routeId) {
        return null;
    }


    /**
     *  初始化路由
     */
    private void initRouteDefinitions() {
        this.loadRouteDefinitions();
    }

    /**
     * 注册Nacos监听
     */
    private void registerNacosListener() {
        try {
            this.configService.addListener(NACOS_DATA_ID, NACOS_GROUP, new NacosListener());
        } catch (NacosException e) {
            log.error("register nacos listener error:{}", ExceptionUtils.getStackTrace(e));
        }
    }

    /**
     * 加载路由
     */
    private void loadRouteDefinitions() {
        try {
            String content = configService.getConfig(NACOS_DATA_ID, NACOS_GROUP,5000);
            List<RouteDefinition> routeDefinitions = convert(content);
            routeDefinitions.forEach(routeDefinition -> {
                routes.put(routeDefinition.getId(), routeDefinition);
            });
        } catch (Exception e) {
            if (e instanceof NacosException) {
                log.error("loadRouteDefinitions from nacos error:{}", ExceptionUtils.getStackTrace(e));
            } else {
                log.error("loadRouteDefinitions error:{}", ExceptionUtils.getStackTrace(e));
            }
        }
    }

    /**
     * 转换路由
     * @param content 路由内容
     * @return
     */
    private List<RouteDefinition> convert(String content) throws IOException {
        if (StringUtils.isNotBlank(content)) {
            String result = PropertiesUtil.getKey(content, "gateway.routes");
            if (StringUtils.isNotBlank(result) ) {
                return JSONObject.parseArray(result, RouteDefinition.class);
            }
        }
        return Lists.newArrayList();
    }

    /* Nacos配置事件监听 */
    private class NacosListener implements Listener {

        @Override
        public Executor getExecutor() {
            return null;
        }

        @Override
        public void receiveConfigInfo(String configInfo) {
            synchronized (NacosListener.class) {
                loadRouteDefinitions();
            }
            // 发布刷新路由事件
            publisher.publishEvent(new RefreshRoutesEvent(this));
        }
    }
}

自定义路由存储器,注册自定义的Nacos监听器,实现receiveConfigInfo方法,当收到Nacos服务端配置变更事件后,会调用receiveConfigInfo方法,然后去加载最新的路由配置信息并存入Map中(参考了InMemoryRouteDefinitionRepository实现,将路由信息用Map存储,通过路由ID去重),最后发布刷新路由事件(RefreshRoutesEvent),缓存路由定位器CachingRouteLocator会监听该事件,并重新拉取最新的路由配置信息,实时生效。

最后编辑于
?著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,128评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,316评论 3 388
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事?!?“怎么了?”我有些...
    开封第一讲书人阅读 159,737评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,283评论 1 287
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,384评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,458评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,467评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,251评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,688评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,980评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,155评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,818评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,492评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,142评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,382评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,020评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,044评论 2 352