Nacos的自动刷新和多环境管理

最新推荐文章于 2024-08-20 16:39:37 发布
置顶 最新推荐文章于 2024-08-20 16:39:37 发布
阅读量1w 收藏 6
点赞数
分类专栏： SpringCloud Alibaba 文章标签： SpringCloudAlibaba
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/ooyhao/article/details/102745398
版权

Nacos的自动刷新和多环境管理

☞ 博客导航，带你有序的阅读和学习！

文章目录

自动刷新

所谓自动刷新，通俗说就是指当我们在Nacos配置中心管理界面修改之后，相应服务会自动读取到修改后的配置。

自动刷新的功能是默认开启的，测试如下：

修改主程序

@SpringBootApplication
public class NacosConfigSimpleApplication {
    public static void main(String[] args) throws InterruptedException {
        ConfigurableApplicationContext applicationContext =
          		SpringApplication.run(NacosConfigSimpleApplication.class, args);
        //取到Spring的配置环境
        while(true){
            ConfigurableEnvironment environment = applicationContext.getEnvironment();
            String username = environment.getProperty("user.name");
            String age = environment.getProperty("user.age");
            System.out.println("username:"+username+" | age:"+age);
            TimeUnit.SECONDS.sleep(1);
        }
    }
}

测试结果

然后我们修改相应的配置文件的age字段的数据，可以看到Idea的控制输出信息：

在这里插入图片描述

关闭自动刷新

spring.cloud.nacos.config.refresh.enabled = false 
# 关闭动态刷新

可以通过上述配置来关闭配置自动刷新。

我们可以看看源码：[默认为true]。

@Component
public class NacosRefreshProperties {

	@Value("${spring.cloud.nacos.config.refresh.enabled:true}")
	private boolean enabled = true;

	public boolean isEnabled() {
		return enabled;
	}

	public void setEnabled(boolean enabled) {
		this.enabled = enabled;
	}
}

Nacos的配置类：NacosConfigProperties

@ConfigurationProperties(NacosConfigProperties.PREFIX)
public class NacosConfigProperties {

	public static final String PREFIX = "spring.cloud.nacos.config";

	private String serverAddr;
	private String encode;
	private String group = "DEFAULT_GROUP";
	private String prefix;
	private String fileExtension = "properties";
	private int timeout = 3000;
	private String endpoint;
	private String namespace;
	private String accessKey;
	private String secretKey;
	private String contextPath;
	private String clusterName;
	private String name;
	private String sharedDataids;
	private String refreshableDataids;
	private List<Config> extConfig;
	private ConfigService configService;
  
	//getter & setter

  public static class Config {
		private String dataId;
		private String group = "DEFAULT_GROUP";
		private boolean refresh = false;
		//getter & setter
	}
	//toString

	public ConfigService configServiceInstance() {...}
}

NacosConfig 自动配置：NacosConfigAutoConfiguration

@Configuration
@ConditionalOnProperty(name = "spring.cloud.nacos.config.enabled", matchIfMissing = true)
public class NacosConfigAutoConfiguration {}
//即如果没有在配置文件中配置spring.cloud.nacos.config.enabled，则默认为条件满足。所以不配置，我们依旧启用了配置功能。

多环境profile管理

profile粒度控制

首先我们在Nocos控制页面配置两个不同环境的配置，如下：

在这里插入图片描述

nacos-config-develop.yaml:

current.env: develop-env

nacos-config-product.yaml:

current.env: product-env

修改主程序，增加读取环境类型的属性：

public static void main(String[] args) throws InterruptedException {
        ConfigurableApplicationContext applicationContext = SpringApplication.run(NacosConfigSimpleApplication.class, args);
        //取到Spring的配置环境
//        while(true){
            ConfigurableEnvironment environment = applicationContext.getEnvironment();
            String username = environment.getProperty("user.name");
            String age = environment.getProperty("user.age");
            String env = environment.getProperty("current.env");
            System.out.println("username:"+username+" | age:"+age +" | env:"+env);
            TimeUnit.SECONDS.sleep(1);
//        }
}

然后在配置bootstrap.properties配置文件指定激活环境：

几种激活方式可以查看：https://blog.csdn.net/ooyhao/article/details/100939089#Profile_176

spring.application.name=nacos-config
# 配置文件的格式
spring.cloud.nacos.config.file-extension=yaml
# 禁用配置自动刷新功能
#spring.cloud.nacos.config.refresh.enabled = false
# 配置中心的地址:端口
spring.cloud.nacos.config.server-addr=127.0.0.1:8848
# 激活环境 *
spring.profiles.active=develop

注意：${spring.profiles.active}当通过配置文件来指定的时候，必须放在bootstrap.properties文件中。

通过结果可以看出，读取到的配置有nacos-config.yaml和nacos-config-develop.yaml。

在这里插入图片描述

注意：此示例中我们通过spring.profile.active= <profilename> 的方式写死在配置文件中，而在真正的项目实施过程中，这个变量的值需要不同环境而有不同的值。这个时候通常的做法是通过 -Dspring.profiles.active=<profile> 参数指定其配置来达到环境间灵活的切换。 具体可以参考上述链接内容

在这里插入图片描述

总结：文件匹配规则如下（dataId），${spring.cloud.nacos.config.prefix}-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension} 我们可以看看源码：

加载配置源码分析

NacosConfigProperties类

@ConfigurationProperties(NacosConfigProperties.PREFIX)
public class NacosConfigProperties {

	public static final String PREFIX = "spring.cloud.nacos.config";

	private String serverAddr;
	private String encode;
	private String group = "DEFAULT_GROUP";
	private String prefix;
	private String fileExtension = "properties";
	private int timeout = 3000;
	private String endpoint;
	private String namespace;
	private String accessKey;
	private String secretKey;
	private String contextPath;
	private String clusterName;
	private String name;
	private String sharedDataids;
	private String refreshableDataids;
}

上述删除了部分代码，但是我们可以看到，fileExtension的默认值是properties.所以，在前一节中，我们使用properties格式的配置文件时，是没有配置文件扩展类型的。

注意：上面的配置类中有prefix，并且按上述的文件匹配规则来看，我们应该加载不到nacos-config.yaml文件的，但是测试结果是加载到了这个文件，而我们并没有配置前缀，所以可以推断出，模式是使用spring.application 属性。 我们查看源码可以看到原因：

NacosPropertySourceLocator类：我们粗略的看一下（源码恐怖，后续深入研究）

@Order(0)
public class NacosPropertySourceLocator implements PropertySourceLocator {

	private static final String NACOS_PROPERTY_SOURCE_NAME = "NACOS";
	private static final String SEP1 = "-";
	private static final String DOT = ".";
	private static final String SHARED_CONFIG_SEPARATOR_CHAR = "[,]";
  //配置文件类型
	private static final List<String> SUPPORT_FILE_EXTENSION =
      							Arrays.asList("properties","yaml", "yml");

	@Override
	public PropertySource<?> locate(Environment env) {

      	//删除了部分无关内容
         //spring.cloud.nacos.config.name
		String name = nacosConfigProperties.getName();
		//spring.cloud.nacos.config.prefix
		String dataIdPrefix = nacosConfigProperties.getPrefix();
         //如果没有配置prefix，则使用name属性作为prefix
		if (StringUtils.isEmpty(dataIdPrefix)) {
			dataIdPrefix = name;
		}
		//如果没有配置prefix,并且也没有配置name属性，则使用spring.application.name属性
         //作为prefix的值
		if (StringUtils.isEmpty(dataIdPrefix)) {
			dataIdPrefix = env.getProperty("spring.application.name");
		}

		CompositePropertySource composite = new CompositePropertySource(
				NACOS_PROPERTY_SOURCE_NAME);

		loadSharedConfiguration(composite);
		loadExtConfiguration(composite);
      	//我们再看一下这个方法，如下
		loadApplicationConfiguration(composite, dataIdPrefix,
                                     nacosConfigProperties, env);
		return composite;
	}

	private void loadApplicationConfiguration(
			CompositePropertySource compositePropertySource, String dataIdPrefix,
			NacosConfigProperties properties, Environment environment) {
		//spring.cloud.nacos.config.prefix
		String fileExtension = properties.getFileExtension();
      	//spring.cloud.nacos.config.group 默认DEFAULT_GROUP
		String nacosGroup = properties.getGroup();
		//dataId=${prefix}-${profile}.${file-extension}
      	// 上面的例子中的nacos-config.yaml
		loadNacosDataIfPresent(compositePropertySource,
				dataIdPrefix + DOT + fileExtension, nacosGroup, fileExtension,
                               true);
      	 //加载激活了的profile的配置文件
      	// 上例中的nacos-config-develop.yaml
 		for (String profile : environment.getActiveProfiles()) {
			String dataId = dataIdPrefix + SEP1 + profile + DOT + fileExtension;
			loadNacosDataIfPresent(compositePropertySource, dataId, nacosGroup,
					fileExtension, true);
		}
	}
}

注意：通过上述代码分析，就知道为什么加载了nacos-config.yaml 和 nacos-config-develop.yaml.

多环境Group管理

在没有自定义${spring.cloud.nacos.config.group} 配置的情况下，默认使用的是DEFAULT_GROUP, 如果需要自定义，可以通过下面的配置来实现：

spring.cloud.nacos.config.group=DEVELOP_GROUP

注意：该配置必须放在bootstrap.properties文件中，并且在添加配置时的值一定要和spring.cloud.nacos.config.group 的属性值一致。

默认配置

在这里插入图片描述

Develop配置

在这里插入图片描述

测试结果

//: Loading nacos data, dataId: 'nacos-config.yaml', group: 'DEVELOP_GROUP'
//: Loading nacos data, dataId: 'nacos-config-develop.yaml', group: 'DEVELOP_GROUP'
username:欧阳 | age:23 | env:DEV

多环境namespace管理

概述

我们看一下官方时如何介绍namespace的：

用户进行租户粒度的配置隔离。不同的命名空间下，可以存在相同的Group或Data ID的配置。Namespace的常用场景之一是不同环境的配置的区分隔离，例如开发测试环境和生产环境的资源（如配置、服务）隔离等。

在配置文件中没有自定义namespace的时候，模式使用的是Nacos上Public作为namespace，如果我们希望自定义，可以通过${spring.cloud.nacos.config.namespace} 来配置。

默认命名空间

我们先看之前的默认namespace。

在这里插入图片描述

在这里插入图片描述

自定义命名空间

spring.cloud.nacos.config.namespace= dc7fb953-fab6-4f98-95b9-e777d02cd683

注意：这个配置必须放在bootstrap.properties文件中。并且spring.cloud.nacos.config.namespace 配置的是namespace Id。而不是命名空间名称。并且这个命名空间id是不用自己生成的，只要在Nacos新建一个命名空间，管理页面就会自动产生一个字符串。在配置文件中配置时要注意选择相应的namespace，否则会读不到正确的配置。

在这里插入图片描述

这里为了保证配置的干净，我新建一个项目来测试。

完整配置

# DataId
spring.application.name=nacos-config-namespace
# group
spring.cloud.nacos.config.group=ouYangGroup
# namespace
spring.cloud.nacos.config.namespace=dc7fb953-fab6-4f98-95b9-e777d02cd683
spring.cloud.nacos.config.file-extension=yaml
spring.cloud.nacos.config.server-addr=192.168.1.104:8848

Nacos配置

在这里插入图片描述

测试结果

主程序：

@SpringBootApplication
public class NacosConfigNamespaceApplication {

    public static void main(String[] args) {
        ConfigurableApplicationContext applicationContext      
          = SpringApplication.run(NacosConfigNamespaceApplication.class, args);
        //环境
        ConfigurableEnvironment environment = applicationContext.getEnvironment();
        String username = environment.getProperty("user.username");
        String password = environment.getProperty("user.password");
        System.out.println("username:"+username+" | password:"+password);
    }
}

测试结果：

username:admin | password:123456
ooyhao
关注
专栏目录
SpringCloudAlibaba-Nacos配置中心和动态刷新的使用
DoDo222333的博客
05-03 2042
SpringCloudAlibaba-Nacos配置中心的使用，动态刷新的使用
Nacos 自助刷新
lqbz的总结
11-30 225
在上一篇中，直接修改Nacos中的配置内容，将-替换成年月日，但对应服务并不会自动更新，原因是还缺少相关配置。 pattern: dateformat: yyyy年MM月dd日 HH:mm:ss 方式一 在@Value注入的变量所在类上添加注解@RefreshScope 修改配置后对应控制台会打印对应 yaml修改通知 方式二 使用@ConfigurationProperties注解（推荐使用） 添加一个PatternProperties.java package com.yy.config; i
nacos配置自动刷新
weixin_59266315的博客
03-25 415
Nacos配置更改后，微服务可以实现热更新，方式：①通过@Value注解注入，结合来刷新②通过注入，自动刷新注意事项：•不是所有的配置都适合放到配置中心，维护起来比较麻烦•建议将一些关键参数，需要运行时调整的参数放到nacos配置中心，一般都是自定义配置。
使用阿里nacos做服务发现与配置管理，配置更改不自动刷新的问题
u013078871的博客
11-16 4529
1.问题描述：在使用nacos做配置中心，在测试nacos配置修改，应用不重启自动刷新配置的时候，发现配置使用@Value取值和使用配置bean，@Configuration取值时，nacos的配置更改，服务不生效，查看本地缓存的配置文件，已更改为最新 2.解决办法如下，在需要配置热更新的配置bean上加springCloud的动态加载配置注解@RefreshScope 3.@RefreshScope可用在类上也可用在方法上，当用在方法上时，如果是想加载配置bean中使用前缀注入的属性时（@Configu
Nacos配置中心组件学习
最新发布
liushangzaibeijing的博客
08-20 1199
本篇博文是博主 springCloud alibaba 全家桶的nacos配置中心组件学习，主要讲述了nacos是什么、怎么使用、以及配置加载、配置刷新的原理，是一篇不错的nacos配置中心学习文章。
SpringCloud 使用 nacos配置中心，nacos属性值自动刷新
z69183787的专栏
11-03 9259
方式一：standalone使用，@NacosValue获取最新值nacos配置信息需要写在配置类上 方式二：结合springcloud ，@Value获取最新值一定要加@RefreshScope注解，配置文件中配置refresh: true 1.@NacosValue获取最新值 <dependency> <groupId>com.alibaba.boot</groupId> <artifactId>nacos-config-sprin
nacos之配置文件实时刷新
万事俱备，就差一个程序员了
12-06 1212
nacos之配置文件实时刷新 当初为了解决nacos配置文件实时刷新问题，搜索了很多资料，仍无效，最后不经意间的尝试却解决了这个问题。 我的SpringCloud版本为:Hoxton.SR4； 我的SpringCloud Alibaba版本为:2.2.1.RELEASE； 我的Nacos版本为:1.3.1。 一、核心配置文件(一定要是bootstrap.yml，而非application.yml) cloud: nacos: discovery: # 服务注册地.
通过Nacos配置刷新进行RabbitMQ消费者在线启停
Throwable
02-12 536
前提公司在做一些金融相关业务，某些时候由于数据提供商定期维护或者特殊原因需要暂停某些服务的消费者。之前选用的消息队列技术栈是RabbitMQ，用于微服务之间的消息投递，对于这类需要暂停消费者的场景是选用注释掉消费者Bean中的相应Spring(Boot)注解重新发布来实现，后面需要重新启动消费就是解开对应的注释再发布一次。这样的处理流程既繁琐，也显得没有技术含量，所以笔者就这个问题结合已有的配置中...
nacos配置不自动刷新
热门推荐
u010507775的博客
12-20 3万+
nacos配置不自动刷新
SpringCloud学习笔记day3：Nacos使用实战（配置+配置更改时自动刷新的方法+多环境配置共享）
qq_26849881的博客
07-04 438
SpringCloud+RabbitMQ+Docker+Redis+搜索+分布式 第三天学习笔记
nacos2.1.0安装包
08-03
Nacos提供RESTful API和各种语言的SDK，方便开发者集成到现有项目中，进行服务管理和配置操作。 通过以上步骤，你已经了解了Nacos 2.1.0的安装及基本使用。随着对Nacos的深入理解和实践，你将能更好地利用它来优化...
nacos配置和使用案例
01-19
Nacos 是一个由阿里巴巴开发的云原生中间件，它主要包含了服务发现、配置管理和服务管理三大核心功能，为现代分布式系统提供了基础架构支持。在本文中，我们将深入探讨 Nacos 的基本概念、使用方法以及如何将其融入...
Springcloud-nacos实现配置和注册中心的方法
08-25
Springcloud-nacos实现配置和注册...使用@RefreshScope注解来刷新配置，以便在环境变量发生变化时自动刷新配置。 使用Nacos实现配置和注册中心可以极大地简化微服务架构的开发和维护，提高开发效率和系统的可靠性。
nacos属性自动刷新的问题
vcj1009784814的博客
05-06 1793
关于属性自动刷新 两种方案，参考https://juejin.cn/post/6876810580993245197 @RefreshScope + @Value @RefreshScope + @ConfigurationProperties 问题：在nacos上修改配置文件，程序成功刷新，但刷新一次后，报错longPolling Error，导致后续的修改无法刷新到。解决方案：将 2.2.4版本升级到2.2.5。 <!-- nacos 服务注册与发现 -->
nacos-config服务配置及动态刷新
weixin_43903629的博客
12-02 739
这里写自定义目录标题相关依赖配置测试 相关依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>com.alibaba.cloud</groupId&gt
是时候抛弃 ConfigServer 了，试试 Nacos 统一配置中心动态刷新机制真香
03-30 1933
原文 《nacos统一配置中心源码解析》|https://u.nu/mm1i7配置文件想必大家都很熟悉，无论什么架构 都离不开配置，虽然spring boot已经大大简化了配置，但如果服...
Nacos Config动态刷新原理
半山腰太挤了，你要去山顶看看
10-28 3025
微服务中的配置 在我们的微服务的运行环境中，每一个微服务往往不会只有一套环境，在企业中往往存在至少三套运行环境：开发、测试、生产 在这套微服务系统中，会存在三个问题： 配置文件的数量会随着微服务的增多而增多 单个配置文件无法区分多个运行环境 配置文件无法动态更新，修改配置文件后需要重启对应的微服务 当我们引入配置中心，它能解决什么问题？ 统一的配置文件的管理 提供统一的服务标准接口，服务根据标准接口拉去对应的配置，也就是常见pull/push模型 支持配置文件动态更新到对应的服务 业界常见的配置
SpringBoot整合Nacos自动刷新配置
陈明亮的博客
01-28 3254
目的 Nacos作为SpringBoot服务的注册中心和配置中心。 在NacosServer中修改配置文件，在SpringBoot不重启的情况下，获取到修改的内容。 本例将在配置文件中配置一个 cml.age=100 的配置项，程序中编写一个方法读取配置文件，并通过 Get—>/test/age 接口提供给浏览器访问。 若配置文件中的 age 修改为 200 ，不用重新启动程序，直接访问 /test/age 接口，将获取到最新的值 200 若配置文件中没有age 的配置项，或干脆没有 cml 的配置
spring boot + nacos 解决数据源动态修改 不用刷新的问题
linhaihai0202的专栏
08-20 848
2、采用 DruidDataSource 数据源。
整合Nacos动态刷新数据源
08-17
当Nacos中的配置项发生变化时，监听器会自动刷新数据源的配置，从而实现动态刷新数据源。 整合Nacos动态刷新数据源可以让我们在运行时动态地修改数据源的配置，而无需重新启动应用程序。这对于多环境部署、灰度发布...
评论 5
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值