【Nacos】@NacosValue的使用与原理

news2024/11/22 20:14:15

在这里插入图片描述

在SpringCloud工程中，可以使用@RefreshScope+@Value实现配置文件内容变更后的动态刷新。

在SpringBoot工程中，可以使用@NacosValue来实现配置文件内容变更后的动态刷新。

@NacosValue的使用

引入依赖：

<dependency>
	<groupId>com.alibaba.boot</groupId>
	<artifactId>nacos-config-spring-boot-starter</artifactId>
	<version>0.2.12</version>
</dependency>

配置文件增加配置：

nacos:
  config:
    server-addr: 127.0.0.1:8848
    bootstrap:
      enable: true
      log:
        enable: true
    data-id: order-service
    type: yaml
    auto-refresh: true # 开启自动刷新

@NacosValue的例子：

package com.morris.order.controller;

import com.alibaba.nacos.api.config.annotation.NacosValue;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("order")
public class NacosValueController {

    @NacosValue(value = "${user.age}", autoRefreshed = true)
    private Integer age2;

    @GetMapping("age2")
    public Integer getAge2() {
        return age2;
    }

}

注意在SpringCloud项目中不能使用@NacosValue注解，虽然这个注解存在，但是其源码的实现不存在。

@NacosValue源码分析

NacosConfigEnvironmentProcessor

NacosConfigEnvironmentProcessor实现了EnvironmentPostProcessor，会在SpringBoot项目启动时调用postProcessEnvironment()方法，去Nacos配置中心拉取配置。

需要在配置文件中开启预加载nacos.config.bootstrap.enable=true。

com.alibaba.boot.nacos.config.autoconfigure.NacosConfigEnvironmentProcessor#postProcessEnvironment

public void postProcessEnvironment(ConfigurableEnvironment environment,
								   SpringApplication application) {
	application.addInitializers(new NacosConfigApplicationContextInitializer(this));
	nacosConfigProperties = NacosConfigPropertiesUtils
		.buildNacosConfigProperties(environment);
	if (enable()) {
		// nacos.config.bootstrap.enable=true
		System.out.println(
			"[Nacos Config Boot] : The preload log configuration is enabled");
		loadConfig(environment);
		NacosConfigLoader nacosConfigLoader = NacosConfigLoaderFactory.getSingleton(nacosConfigProperties, environment, builder);
		LogAutoFreshProcess.build(environment, nacosConfigProperties, nacosConfigLoader, builder).process();
	}
}

com.alibaba.boot.nacos.config.autoconfigure.NacosConfigEnvironmentProcessor#loadConfig

private void loadConfig(ConfigurableEnvironment environment) {
	NacosConfigLoader configLoader = new NacosConfigLoader(nacosConfigProperties,
														   environment, builder);
	configLoader.loadConfig();
	// set defer NacosPropertySource
	deferPropertySources.addAll(configLoader.getNacosPropertySources());
}

从配置中心拉取配置加入到Environment。
com.alibaba.boot.nacos.config.util.NacosConfigLoader#loadConfig

public void loadConfig() {
	MutablePropertySources mutablePropertySources = environment.getPropertySources();
	List<NacosPropertySource> sources = reqGlobalNacosConfig(globalProperties,
															 nacosConfigProperties.getType());
	for (NacosConfigProperties.Config config : nacosConfigProperties.getExtConfig()) {
		List<NacosPropertySource> elements = reqSubNacosConfig(config,
															   globalProperties, config.getType());
		sources.addAll(elements);
	}
	if (nacosConfigProperties.isRemoteFirst()) {
		// 默认为false，默认本地的配置优先级高
		for (ListIterator<NacosPropertySource> itr = sources.listIterator(sources.size()); itr.hasPrevious();) {
			mutablePropertySources.addAfter(
				StandardEnvironment.SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME, itr.previous());
		}
	} else {
		for (NacosPropertySource propertySource : sources) {
			mutablePropertySources.addLast(propertySource);
		}
	}
}

NacosConfigApplicationContextInitializer

NacosConfigApplicationContextInitializer注册负责监听Nacos配置，实现自动刷新配置

com.alibaba.boot.nacos.config.autoconfigure.NacosConfigApplicationContextInitializer#initialize

public void initialize(ConfigurableApplicationContext context) {
	singleton.setApplicationContext(context);
	environment = context.getEnvironment();
	nacosConfigProperties = NacosConfigPropertiesUtils
		.buildNacosConfigProperties(environment);
	final NacosConfigLoader configLoader = NacosConfigLoaderFactory.getSingleton(
		nacosConfigProperties, environment, builder);
	if (!enable()) {
		logger.info("[Nacos Config Boot] : The preload configuration is not enabled");
	}
	else {

		// If it opens the log level loading directly will cache
		// DeferNacosPropertySource release

		if (processor.enable()) {
			// nacos.config.bootstrap.enable=true
			processor.publishDeferService(context);
			// 添加监听器
			configLoader
				.addListenerIfAutoRefreshed(processor.getDeferPropertySources());
		}
		else {
			configLoader.loadConfig();
			configLoader.addListenerIfAutoRefreshed();
		}
	}

	final ConfigurableListableBeanFactory factory = context.getBeanFactory();
	if (!factory
		.containsSingleton(NacosBeanUtils.GLOBAL_NACOS_PROPERTIES_BEAN_NAME)) {
		factory.registerSingleton(NacosBeanUtils.GLOBAL_NACOS_PROPERTIES_BEAN_NAME,
								  configLoader.getGlobalProperties());
	}
}

遍历所有的Nacos配置文件，每个配置文件都添加一个监听器。
com.alibaba.boot.nacos.config.util.NacosConfigLoader#addListenerIfAutoRefreshed(java.util.List<com.alibaba.boot.nacos.config.util.NacosConfigLoader.DeferNacosPropertySource>)

public void addListenerIfAutoRefreshed(
	final List<DeferNacosPropertySource> deferNacosPropertySources) {
	for (DeferNacosPropertySource deferNacosPropertySource : deferNacosPropertySources) {
		NacosPropertySourcePostProcessor.addListenerIfAutoRefreshed(
			deferNacosPropertySource.getNacosPropertySource(),
			deferNacosPropertySource.getProperties(),
			deferNacosPropertySource.getEnvironment());
	}
}

要实现配置的自动刷新，需要在配置文件中开启nacos.config.auto-refresh=true。
com.alibaba.nacos.spring.core.env.NacosPropertySourcePostProcessor#addListenerIfAutoRefreshed

public static void addListenerIfAutoRefreshed(
	final NacosPropertySource nacosPropertySource, final Properties properties,
	final ConfigurableEnvironment environment) {

	// nacos.config.auto-refresh=true
	if (!nacosPropertySource.isAutoRefreshed()) { // Disable Auto-Refreshed
		return;
	}

	final String dataId = nacosPropertySource.getDataId();
	final String groupId = nacosPropertySource.getGroupId();
	final String type = nacosPropertySource.getType();
	final NacosServiceFactory nacosServiceFactory = getNacosServiceFactoryBean(
		beanFactory);

	try {

		ConfigService configService = nacosServiceFactory
			.createConfigService(properties);

		Listener listener = new AbstractListener() {

			@Override
			public void receiveConfigInfo(String config) {
				String name = nacosPropertySource.getName();
				NacosPropertySource newNacosPropertySource = new NacosPropertySource(
					dataId, groupId, name, config, type);
				newNacosPropertySource.copy(nacosPropertySource);
				MutablePropertySources propertySources = environment
					.getPropertySources();
				// replace NacosPropertySource
				// 监听事件的处理，直接替换Environment中的配置
				propertySources.replace(name, newNacosPropertySource);
			}
		};

		if (configService instanceof EventPublishingConfigService) {
			// 通过EventPublishingConfigService进行代理
			((EventPublishingConfigService) configService).addListener(dataId,
																	   groupId, type, listener);
		}
		else {
			configService.addListener(dataId, groupId, listener);
		}

	}
	catch (NacosException e) {
		throw new RuntimeException(
			"ConfigService can't add Listener with properties : " + properties,
			e);
	}
}

通过EventPublishingConfigService添加监听器，里面对监听器做了一层包装。
com.alibaba.nacos.spring.context.event.config.EventPublishingConfigService#addListener(java.lang.String, java.lang.String, java.lang.String, com.alibaba.nacos.api.config.listener.Listener)

public void addListener(String dataId, String group, String type, Listener listener)
	throws NacosException {
	Listener listenerAdapter = new DelegatingEventPublishingListener(configService,
																	 dataId, group, type, applicationEventPublisher, executor, listener);
	addListener(dataId, group, listenerAdapter);
}

当配置中心的配置变更后，首先会回调DelegatingEventPublishingListener的receiveConfigInfo()，这里会调用被代理的监听器的receiveConfigInfo()，还会发布NacosConfigReceivedEvent事件。
com.alibaba.nacos.spring.context.event.config.DelegatingEventPublishingListener#receiveConfigInfo

public void receiveConfigInfo(String content) {
	// 调用被代理的监听器的receiveConfigInfo()
	onReceived(content);
	// 发布NacosConfigReceivedEvent事件
	publishEvent(content);
}

private void publishEvent(String content) {
	NacosConfigReceivedEvent event = new NacosConfigReceivedEvent(configService,
																  dataId, groupId, content, configType);
	applicationEventPublisher.publishEvent(event);
}

private void onReceived(String content) {
	delegate.receiveConfigInfo(content);
}

NacosValueAnnotationBeanPostProcessor

postProcessPropertyValues()

NacosValueAnnotationBeanPostProcessor实现了InstantiationAwareBeanPostProcessorAdapter，其postProcessBeforeInitialization()方法会在Bean实例化之后和初始化之前执行，对Bean上加了@NacosValue注解的属性进行设置。

com.alibaba.spring.beans.factory.annotation.AbstractAnnotationBeanPostProcessor#postProcessPropertyValues

public PropertyValues postProcessPropertyValues(PropertyValues pvs, PropertyDescriptor[] pds, Object bean, String beanName) throws BeanCreationException {
	// 查找@NacosVaLue注解的属性和方法
	InjectionMetadata metadata = this.findInjectionMetadata(beanName, bean.getClass(), pvs);

	try {
		// 为属性设置值
		metadata.inject(bean, beanName, pvs);
		return pvs;
	} catch (BeanCreationException var7) {
		throw var7;
	} catch (Throwable var8) {
		throw new BeanCreationException(beanName, "Injection of @" + this.getAnnotationType().getSimpleName() + " dependencies is failed", var8);
	}
}

postProcessBeforeInitialization()

NacosValueAnnotationBeanPostProcessor实现了BeanPostProcessor，其postProcessBeforeInitialization()方法会在Bean实例化之后和初始化之前执行，主要负责收集带有@NacosValue注解且需要自动刷新的属性。

如果属性需要自动刷新，需要设置@NacosValue的autoRefreshed为true。

com.alibaba.nacos.spring.context.annotation.config.NacosValueAnnotationBeanPostProcessor#postProcessBeforeInitialization

public Object postProcessBeforeInitialization(Object bean, final String beanName)
	throws BeansException {

	// 对Bean所有的属性进行处理
	doWithFields(bean, beanName);

	// 对Bean所有的方法进行处理
	doWithMethods(bean, beanName);

	return super.postProcessBeforeInitialization(bean, beanName);
}

private void doWithFields(final Object bean, final String beanName) {
	ReflectionUtils.doWithFields(bean.getClass(),
								 new ReflectionUtils.FieldCallback() {
									 @Override
									 public void doWith(Field field) throws IllegalArgumentException {
										 NacosValue annotation = getAnnotation(field, NacosValue.class);
										 doWithAnnotation(beanName, bean, annotation, field.getModifiers(),
														  null, field);
									 }
								 });
}

private void doWithAnnotation(String beanName, Object bean, NacosValue annotation,
							  int modifiers, Method method, Field field) {
	if (annotation != null) {
		if (Modifier.isStatic(modifiers)) {
			return;
		}

		if (annotation.autoRefreshed()) {
			String placeholder = resolvePlaceholder(annotation.value());

			if (placeholder == null) {
				return;
			}

			NacosValueTarget nacosValueTarget = new NacosValueTarget(bean, beanName,
																	 method, field, annotation.value());
			// 将带有@NacosValue注解的属性加入到一个Map中
			put2ListMap(placeholderNacosValueTargetMap, placeholder,
						nacosValueTarget);
		}
	}
}

监听NacosConfigReceivedEvent

收到NacosConfigReceivedEvent事件时，通过反射调用上面收集好的属性和方法从而实现自动刷新。

com.alibaba.nacos.spring.context.annotation.config.NacosValueAnnotationBeanPostProcessor#onApplicationEvent

public void onApplicationEvent(NacosConfigReceivedEvent event) {
	// In to this event receiver, the environment has been updated the
	// latest configuration information, pull directly from the environment
	// fix issue #142
	for (Map.Entry<String, List<NacosValueTarget>> entry : placeholderNacosValueTargetMap
		 .entrySet()) {
		String key = environment.resolvePlaceholders(entry.getKey());
		String newValue = environment.getProperty(key);

		if (newValue == null) {
			continue;
		}
		List<NacosValueTarget> beanPropertyList = entry.getValue();
		for (NacosValueTarget target : beanPropertyList) {
			String md5String = MD5Utils.md5Hex(newValue, "UTF-8");
			boolean isUpdate = !target.lastMD5.equals(md5String);
			if (isUpdate) {
				target.updateLastMD5(md5String);
				Object evaluatedValue = resolveNotifyValue(target.nacosValueExpr, key, newValue);
				if (target.method == null) {
					setField(target, evaluatedValue);
				}
				else {
					setMethod(target, evaluatedValue);
				}
			}
		}
	}
}

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/378393.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

网页打印与导出word实现在A4纸上相同效果

网页打印与导出word实现在A4纸上相同效果

在工作中遇到这样一个需求&#xff0c;客户要求&#xff1a; 1、实现在浏览器中打印和导出到word中&#xff0c;要求浏览器打印出来的效果和word中打印的效果基本一致。2、打印的内容要自动分页&#xff0c;第一页的顶部有文件头&#xff0c;最后一页的底部有页尾。 这里记录一…
阅读更多...
GitHub 下载超过 28W 次的 Java 面试题库来袭，面面俱到太全了

GitHub 下载超过 28W 次的 Java 面试题库来袭，面面俱到太全了

“金三银四”、“金九银十” 一直被称为是跳槽的旺季&#xff0c;最近也有不少小伙伴找我咨询一些面试相关的问题。刚好小编最近获得一份收费 Java 面试题库&#xff01; 这些面试题都是互联网大厂真实流出的面试内容&#xff0c;每个问题都附带完整详细的答案&#xff0c;不像…
阅读更多...
React（三）：脚手架、组件化、生命周期、父子组件通信、插槽

React（三）：脚手架、组件化、生命周期、父子组件通信、插槽

React&#xff08;三&#xff09;一、脚手架安装和创建1.安装脚手架2.创建脚手架3.看看脚手架目录4.运行脚手架二、脚手架下从0开始写代码三、组件化1.类组件2.函数组件四、React的生命周期1.认识生命周期2.图解生命周期&#xff08;1&#xff09;Constructor&#xff08;2&…
阅读更多...
SpringMvc+Spring+JPA+Hibernate实现的增删改查

SpringMvc+Spring+JPA+Hibernate实现的增删改查

SpringMvcSpringJPAHibernate实现的增删改查 基于SSJ 12.1目录图 完整项目目录 12.2创建步骤 1.选择目录 2.选择基于的包结构 3.设置坐标。不能和已有的重复。 4.创建出来的包结构 5.自己配置tomcat&#xff0c;设置构建路径 下面进行依赖坐标导入。 12.3pom依赖 可以全设置5.3…
阅读更多...
自学5个月Java找到了9K的工作，我的方式值得大家借鉴 第一部分

自学5个月Java找到了9K的工作，我的方式值得大家借鉴 第一部分

我是去年9月22日才正式学习Java的&#xff0c;因为在国营单位工作了4年&#xff0c;在天津一个月工资只有5000块&#xff0c;而且看不到任何晋升的希望&#xff0c;如果想要往上走&#xff0c;那背后就一定要有关系才行。而且国营单位的气氛是你干的多了&#xff0c;领导觉得你…
阅读更多...
java基础之线程池

java基础之线程池

线程池1.线程池1.1 线程状态介绍1.2 线程池-基本原理1.3 线程池-Executors默认线程池1.4 线程池-Executors创建指定上限的线程池1.5 线程池-ThreadPoolExecutor1.6 线程池-参数详解1.7 线程池-非默认任务拒绝策略2. 原子性2.1 volatile-问题2.2 volatile解决2.3 synchronized解…
阅读更多...
你真的懂动态库吗？一文详解动态库的方方面

你真的懂动态库吗？一文详解动态库的方方面

这里写目录标题创建动态库创建静态库动态库与静态库的区别动态链接与静态链接的区别动态库的加载过程dll的创建以及应用程序隐式链接到dll的过程dll的创建以及应用程序显示链接到dll的过程动态库的二进制兼容性创建动态库 1.【新建】-》【项目】-》【动态链接库】 新建的动态…
阅读更多...
Elasticsearch入门之Http操作（高级查询）

Elasticsearch入门之Http操作（高级查询）

Elasticsearch 基本操作 Http操作&#xff1a; 高级查询&#xff1a; 高级查询&#xff1a;Elasticsearch 提供了基于 JSON 提供完整的查询 DSL 来定义查询 初始化数据&#xff1a; 查询所有文档&#xff1a; 在 Postman 中&#xff0c;向 ES 服务器发 GET 请求 &#xff1a…
阅读更多...
docker的逃逸复现（CVE-2020-15257-host模式容器逃逸漏洞）

docker的逃逸复现（CVE-2020-15257-host模式容器逃逸漏洞）

host模式下的docker逃逸的概述因为docker所使用的是隔离技术&#xff0c;就导致了容器内的进程无法看到外面的进程&#xff0c;但外面的进程可以看到里面&#xff0c;所以如果一个 Docker 容器内部可以操作该容器的外部资源&#xff0c;一般理解为操作宿主机的行为。叫做docker…
阅读更多...
【组织架构】中国铁路太原局集团有限公司

【组织架构】中国铁路太原局集团有限公司

1 公司简介 中国铁路太原局集团有限公司&#xff0c;是中国国家铁路集团有限公司管理的18个铁路局集团有限公司之一&#xff0c;简称“太局”。成立于2005年3月18日&#xff0c;共有职工11.5万人。 管辖南同蒲铁路、北同蒲铁路、大秦铁路、侯月铁路、石太铁路、侯西&#xff08…
阅读更多...
Confluence 安装

Confluence 安装

Confluence 安装 一、购买一台服务器 推荐使用 Ubuntu 版本服务器。 二、安装宝塔面板 官方安装地址 安装地址 Centos 安装脚本 yum install -y wget && wget -O install.sh https://download.bt.cn/install/install_6.0.sh && sh install.sh ed8484bec…
阅读更多...
7个好用到爆的音频、配乐素材网站，BGM都在这里了

7个好用到爆的音频、配乐素材网站，BGM都在这里了

现在只要有一部手机&#xff0c;人人都能成为视频创作者。一个好的视频不能缺少的就是内容、配乐&#xff0c;越来越注重版权的当下&#xff0c;音效素材使用不当造成侵权的案例层出不穷。为了避免侵权&#xff0c;找素材让很多创作者很头疼。 今天我就整理了7个可以免费下载&…
阅读更多...
一步打通多渠道服务场景 中电金信源启移动开发平台MADP功能“上新”

一步打通多渠道服务场景 中电金信源启移动开发平台MADP功能“上新”

日前&#xff0c;中电金信源启移动开发平台MADP功能迭代升级&#xff0c;“上新”源启小程序开发平台。定位“为金融业定制”的移动PaaS平台&#xff0c;源启小程序开发平台为银行、互联网金融、保险、证券客户提供一站式小程序的开发、运营、营销全生命周期管理技术支撑&#…
阅读更多...
经验 // 通用又好用的思维工具

经验 // 通用又好用的思维工具

有很多管理或思维小工具&#xff0c;非常通用&#xff0c;各行各业都用的到&#xff0c;工作用的到&#xff0c;生活也用的到。掌握这些工具&#xff0c;让你在工作上很专业&#xff0c;在生活上很认真。 1-【MECE原则】 MECE法则&#xff0c;是麦肯锡公司的巴巴拉明托&#…
阅读更多...
06--WXS 脚本

06--WXS 脚本

1、简介WXS&#xff08;WeiXin Script&#xff09;是小程序的一套脚本语言&#xff0c;结合 WXML &#xff0c;可以构建出页面的结构。 注意事项WXS 不依赖于运行时的基础库版本&#xff0c;可以在所有版本的小程序中运行。WXS 与 JavaScript 是不同的语言&#xff0c;有自己的…
阅读更多...
Spring与Dubbo整合原理与源码分析

Spring与Dubbo整合原理与源码分析

EnableDubbo注解中有两个注解 EnableDubboConfig是用来解析配置文件的 DubboComponentScan是用来扫描Service和Refrence的 1.Dubbo中propertie⽂件解析以及处理原理 我们看到引入了DubboConfigConfigurationRegistrar&#xff0c;一看就知道干嘛了&#xff0c;老套路 我们看下…
阅读更多...
【UE4 】制作螺旋桨飞机

【UE4 】制作螺旋桨飞机

一、素材资源链接&#xff1a;https://pan.baidu.com/s/1xPVYYw05WQ6FABq_ZxFifg提取码&#xff1a;ivv8二、课程视频链接https://www.bilibili.com/video/BV1Bb411h7qw/?spm_id_from333.337.search-card.all.click&vd_source36a3e35639c44bb339f59760641390a8三、最终效果…
阅读更多...
CVE-2022-42889 Apache Commons Text 漏洞

CVE-2022-42889 Apache Commons Text 漏洞

0x00 前言 所幸遇到&#xff0c;就简单看看&#xff0c;其中没有啥比较难的地方&#xff0c;仅做记录。10月13日的漏洞。 cve链接可以看下面这个&#xff1a; https://cve.mitre.org/cgi-bin/cvename.cgi?nameCVE-2022-42889 git地址&#xff1a; https://github.com/apache…
阅读更多...
AcWing蓝桥杯辅导课：第二讲 二分与前缀和

AcWing蓝桥杯辅导课：第二讲 二分与前缀和

AcWing 789. 数的范围 思路&#xff1a; 二分模板一共有两个&#xff0c;分别适用于不同情况。 算法思路&#xff1a;假设目标值在闭区间[l, r]中&#xff0c; 每次将区间长度缩小一半&#xff0c;当l r时&#xff0c;我们就找到了目标值。 版本1 当我们将区间[l, r]划分成[…
阅读更多...
基于蚂蚁优化算法的柔性车间调度研究（Python代码实现）

基于蚂蚁优化算法的柔性车间调度研究（Python代码实现）

&#x1f468;‍&#x1f393;个人主页&#xff1a;研学社的博客&#x1f4a5;&#x1f4a5;&#x1f49e;&#x1f49e;欢迎来到本博客❤️❤️&#x1f4a5;&#x1f4a5;&#x1f3c6;博主优势&#xff1a;&#x1f31e;&#x1f31e;&#x1f31e;博客内容尽量做到思维缜密…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023