初始化安装后 Nacos 动态路由配置不生效

一、问题描述

1、每次初始化安装整套项目，包括安装 Nacos 和其他服务还有mysql,redis等其他中间件，安装后 Nacos 获取不到 nacos 路由信息（包括后续新写入动态路由配置）！只有手动重启 Nacos 服务后，才会生效，后续更新的动态路由配置也会正常；

二、版本

Nacos： 2.1.0

spring-boot：2.6.14

spring-cloud：2021.0.1

spring-cloud-alibaba：2021.0.1.0

三、动态路由实现代码（只是其中一种方式，也可用其他）

1、需要引入的pom依赖

		<!--gateway--><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-gateway</artifactId></dependency><!--SpringCloud ailibaba nacos --><dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId></dependency><!-- SpringCloud Ailibaba Nacos Config --><dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId></dependency>

2、动态刷新路由service

package com.cherf.flow.gateway.nacosconfig;

import java.util.ArrayList;
import java.util.List;
import java.util.Properties;
import java.util.concurrent.Executor;
import javax.annotation.PostConstruct;

import com.alibaba.nacos.api.PropertyKeyConst;
import com.cherf.flow.gateway.config.RoutesConfig;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.gateway.event.RefreshRoutesEvent;
import org.springframework.cloud.gateway.route.RouteDefinition;
import org.springframework.cloud.gateway.route.RouteDefinitionWriter;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.context.ApplicationEventPublisherAware;
import org.springframework.stereotype.Component;
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.alibaba.nacos.api.NacosFactory;
import com.alibaba.nacos.api.config.ConfigService;
import com.alibaba.nacos.api.config.listener.Listener;
import com.alibaba.nacos.api.exception.NacosException;
import reactor.core.publisher.Mono;

@ComponentpublicclassNacosDynamicRouteServiceimplementsApplicationEventPublisherAware {

    privatestaticfinalLoggerlog= LoggerFactory.getLogger(NacosDynamicRouteService.class);


    publicstaticfinallongDEFAULT_TIMEOUT=30000;

    @Value("${spring.cloud.nacos.discovery.server-addr}")private String serverAddr;

    /**
     * 配置 ID
     */@Value("${flowGateway.dataId}")private String dataId;

    /**
     * 配置 分组
     */@Value("${flowGateway.group}")private String group;

    /**
     * 静态路由地址
     */@Autowiredprivate RoutesConfig routesConfig;

    @Autowiredprivate RouteDefinitionWriter routeDefinitionWriter;

    private ApplicationEventPublisher applicationEventPublisher;

    privatestaticfinal List<String> ROUTE_LIST = newArrayList<>();

    // 增加网关启动时，更新一次配置@PostConstructpublicvoidinit() {
        log.info("gateway route init...");
        try {
            List<RouteDefinition> definitionList = newArrayList<>();
            definitionList.addAll(routesConfig.getRoutes());
            Propertiesproperties=newProperties();
            // nacos服务器地址，127.0.0.1:8848
            properties.put(PropertyKeyConst.SERVER_ADDR, serverAddr);
            ConfigServiceconfigService= NacosFactory.createConfigService(properties);
            if (configService != null) {
                StringconfigInfo= configService.getConfig(dataId, group, DEFAULT_TIMEOUT);
                if (StringUtils.isNotBlank(configInfo)) {
                    definitionList.addAll(JSON.parseArray(configInfo, RouteDefinition.class));
                }
            }
            log.info("update route : {}", definitionList);
            for (RouteDefinition definition : definitionList) {
                addRoute(definition);
            }
        } catch (Exception e) {
            log.error("初始化网关路由时发生错误", e);
        }
    }

    @PostConstructpublicvoiddynamicRouteByNacosListener() {
        try {
            Propertiesproperties=newProperties();
            // nacos服务器地址，127.0.0.1:8848
            properties.put(PropertyKeyConst.SERVER_ADDR, serverAddr);
            ConfigServiceconfigService= NacosFactory.createConfigService(properties);
            if (configService != null) {
                configService.getConfig(dataId, group, 5000);
                configService.addListener(dataId, group, newListener() {
                    @OverridepublicvoidreceiveConfigInfo(String configInfo) {
                        if (StringUtils.isNotBlank(configInfo)) {
                            // 手动新配置以后，先清除原来的配置
                            clearRoute();
                            try {
                                List<RouteDefinition> gatewayRouteDefinitions = JSONObject.parseArray(configInfo, RouteDefinition.class);
                                gatewayRouteDefinitions.addAll(routesConfig.getRoutes());
                                for (RouteDefinition routeDefinition : gatewayRouteDefinitions) {
                                    addRoute(routeDefinition);
                                }
                                publish();
                            } catch (Exception e) {
                                log.error("加载网关路由时发生错误", e);
                            }
                        }
                    }

                    @Overridepublic Executor getExecutor() {
                        returnnull;
                    }
                });
            }
        } catch (NacosException e) {
            log.error("加载网关路由时发生错误", e);
        }
    }


    privatevoidclearRoute() {
        for (String id : ROUTE_LIST) {
            this.routeDefinitionWriter.delete(Mono.just(id)).subscribe();
        }
        ROUTE_LIST.clear();
    }

    privatevoidaddRoute(RouteDefinition definition) {
        try {
            routeDefinitionWriter.save(Mono.just(definition)).subscribe();
            ROUTE_LIST.add(definition.getId());
        } catch (Exception e) {
            log.error("初始化网关路由时发生错误", e);
        }
    }

    privatevoidpublish() {
        this.applicationEventPublisher.publishEvent(newRefreshRoutesEvent(this.routeDefinitionWriter));
    }

    @OverridepublicvoidsetApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {
        this.applicationEventPublisher = applicationEventPublisher;
    }
}

3、配置文件中的路由信息配置

package com.cherf.flow.gateway.config;


import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.cloud.gateway.route.RouteDefinition;
import org.springframework.stereotype.Component;
import java.util.List;

/**
 * @author
 */@ConfigurationProperties(prefix = "spring.cloud.gateway")@Data@ComponentpublicclassRoutesConfig {

    /**
     * 所有的路由信息
     */private List<RouteDefinition> routes;
}

4、yml配置信息

spring:cloud:nacos:discovery:# 不使用nacos的配置# enabled: falseserver-addr:NACOS_HOSTconfig:# 配置中心地址server-addr:NACOS_HOST# 配置文件格式file-extension:ymlusername:password:gateway:discovery:locator:enabled:true#开启从注册中心动态创建路由的功能，利用微服务名进行路由routes:-id:i-console-api#payment_route    #路由的ID，没有固定规则但要求唯一，建议配合服务名uri:lb://i-console-api#匹配后提供服务的路由地址,lb为负载均衡的其中一种模式predicates:# 断言，路径相匹配的进行路由-Path=/api/**,/oapi/**filters:#redis令牌桶限流功能-name:RequestRateLimiterargs:# 令牌桶每秒填充平均速率redis-rate-limiter.replenishRate:100# 令牌桶的总容量redis-rate-limiter.burstCapacity:100-id:i-system-api#payment_route    #路由的ID，没有固定规则但要求唯一，建议配合服务名uri:lb://i-system-api#匹配后提供服务的路由地址,lb为负载均衡的其中一种模式predicates:# 断言，路径相匹配的进行路由-Path=/sys/**,/user/**filters:#redis令牌桶限流功能-name:RequestRateLimiterargs:# 令牌桶每秒填充平均速率redis-rate-limiter.replenishRate:100# 令牌桶的总容量redis-rate-limiter.burstCapacity:100flowGateway:dataId:gateway-flowgroup:DEFAULT_GROUP

5、Nacos页面

新增配置

路由信息

6、启动类修改

** 在启动类中需要添加注解@EeableDiscoveryClient**

package com.cherf;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

@SpringBootApplication(exclude = {SecurityAutoConfiguration.class})@EnableDiscoveryClientpublicclassFlowGatewayApplication {
    publicstaticvoidmain(String[] args) {
        SpringApplication.run(FlowGatewayApplication.class, args);
    }
}

PS：参考大佬实现代码，实现代码网上很多可自行百度！

四、可能的原因

配置文件不生效的把名字改为bootstrap.yml

仔细看 Data Id 和 Group 配置；

yml 中配置是否开启了；

还有很多可能的原因可以看官方issue去解决

这些都不符合我的情况！

五、定位与解决

后续发现是安装后只有第一次自动更新配置有问题，重启Nacos后消失，不是一直有问题，所以就从nacos刷新配置的代码下手，最终定位问题出在时区上；

使用 show VARIABLES like '%time_zone%'; 查看数据库时区；

原因

/nacos/conf/ 目录下 application.properties 中数据源 url 的时区为 UTC 和数据库不一致导致

解决

将 nacos 配置文件中的 serverTimezone=UTC 改成 serverTimezone=Asia/Shanghai 后解决！

解决了我的问题，但是也可能不适用于其他场景！欢迎大家讨论！