Nacos配置热更新的4种方式、读取项目配置文件的多种方式,@value,@RefreshScope,@NacosConfigurationProperties

已于 2023-06-16 10:39:26 修改
阅读量2.9w 收藏 108
点赞数 38
分类专栏： java spring nacos 文章标签： nacos热更新
于 2022-04-24 17:46:44 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/wang_o_yi/article/details/124387045
版权
java 同时被 3 个专栏收录
34 篇文章 0 订阅
订阅专栏
spring
4 篇文章 0 订阅
订阅专栏
nacos
1 篇文章 0 订阅
订阅专栏

nacos实现配置文件的热更新，服务不用重启即可读取到nacos配置中心修改发布后的最新值，spring，springboot项目读取本地配置文件的各种方式；文章中介绍了一下注解的使用：@NacosConfigurationProperties，@NacosPropertySource，@ConfigurationProperties，@NacosValue，@value，@RefreshScope，@EnableNacosConfig。
使用nacos的企业越来越多，nacos确实很好用，最近就抽时间研究了一下nacos配置文件的热更新的几种方式，顺便复习了一下读取本地配置文件的几种方式。

文章最后提供源码连接，完全自己写的，绝对可用。

一、nacos配置文件热更新的几种方式

热更新，顾名思义就是在不用重启服务的情况下，实现配置的更新，服务的重启可能对项目的影响很大，所以nacos肯定是支持热更新的，我一共总结了4种方式，可以实现nacos的热更新，网上也找了很多，要么那些文章是从别的地方复制粘贴过来的不能用，要么就是pom依赖不对，总之搞不好，很头疼。所以我自己完整弄一遍（首先要安装好nacos服务端，这里就略过了）。

1、新建项目，pom引入

1、父模块引入pom

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.example</groupId>
    <artifactId>NacosConfig</artifactId>
    <packaging>pom</packaging>
    <version>1.0-SNAPSHOT</version>
    <modules>
        <module>NacosValueExample</module>
    </modules>

    <properties>
        <spring-boot.version>2.2.8.RELEASE</spring-boot.version>
        <spring-cloud.version>Hoxton.RELEASE</spring-cloud.version>
        <spring-cloud-alibaba.version>2.2.0.RELEASE</spring-cloud-alibaba.version>
        <nacos-spring-context.version>0.2.2-RC1</nacos-spring-context.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${spring-boot.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>

            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>

            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>${spring-cloud-alibaba.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>

            <dependency>
                <groupId>com.alibaba.nacos</groupId>
                <artifactId>nacos-spring-context</artifactId>
                <version>${nacos-spring-context.version}</version>
            </dependency>
        </dependencies>
    </dependencyManagement>

</project>

2、子模块引入pom

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-spring-context</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-context</artifactId>
        </dependency>
    </dependencies>

3、项目结构
在这里插入图片描述

2、使用@RefreshScope+@Value实现nacos热更新

1、在nacos配置中心新建config-teacher.yaml配置文件
内容如下：

teacher:
  name: 老李
  age: 45

在这里插入图片描述
配置编辑保存：
在这里插入图片描述
配置中心已有配置文件了：
在这里插入图片描述
2、项目中新建bootstrap.yml配置文件，将config-teacher.yaml配置进去

spring:
  application:
    name: test-config
  cloud:
    # nacos 配置
    nacos:
      config:
        file-extension: yaml
        refresh-enabled: true
        enabled: true
        server-addr: 127.0.0.1:8848
        group: DEFAULT_GROUP
        #添加配置时 Group 的值一定要和 spring.cloud.nacos.config.group 的配置值一致。
        #group: NACOS-DEMO
        ## 可以配置多个 Data Id 同时配置时，他的优先级关系是 [n]其中 n 的值越大，优先级越高。
        extension-configs[0]:
          data-id: config-student.yaml
          group: DEFAULT_GROUP
          refresh: true
        extension-configs[1]:
          data-id: config-teacher.yaml
          group: DEFAULT_GROUP
          refresh: true
      discovery:
        server-addr: 127.0.0.1:8848

3、启动类

@SpringBootApplication
// 增加@EnableNacosConfig才能使用@NacosValue注解和@NacosConfigurationProperties注解获取nacos配置中心的配置文件内容
@EnableNacosConfig(globalProperties = @NacosProperties(serverAddr = "127.0.0.1:8848"))
public class ConfigApplication {

    public static void main(String[] args) {
        SpringApplication.run(ConfigApplication.class, args);
    }
}

4、读取配置文件代码

package com.nacos.example.config;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.stereotype.Component;

@Component
@RefreshScope
public class TestValue3 {
    @Value("${teacher.name}")
    private String name;
    @Value("${teacher.age}")
    private Integer age;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }
}

5、controller注入：

@RestController
@RequestMapping("/config")
public class ConfigController {
@Autowired
private TestValue3 testValue3;

@GetMapping(value = "/getValue9")
    public Object getValue9() {
        TestValue3 value3 = new TestValue3();
        value3.setName(testValue3.getName());
        value3.setAge(testValue3.getAge());
        return value3;
    }
 }

6、访问接口效果：
在这里插入图片描述
我们修改nacos配置中心的config-teacher.yaml文件
在这里插入图片描述
然后重新访问刚刚的接口，服务不重启：
在这里插入图片描述
可以看到，修改后的配置已经读取到了，第一种方式成功！

3、使用@RefreshScope+@ConfigurationProperties实现nacos热更新

1、配置文件不变，读取配置文件的代码：

@Component
@RefreshScope
@ConfigurationProperties(prefix = "teacher")
public class TestRefreshScope1 {

    private String name;
    private Integer age;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }
}

2、controller注入：

@RestController
@RequestMapping("/config")
public class ConfigController {
@Autowired
 private TestRefreshScope1 testRefreshScope1;

@GetMapping(value = "/getValue5")
    public Object getValue5() {
        // 因为RefreshScope使用的动态代理，这里直接返回testRefreshScope1会报错，所以重新new对象从testRefreshScope1获取值在返回
        //  No serializer found for class org.springframework.context.expression.StandardBeanExpressionResolver
        TestRefreshScope1 scope1 = new TestRefreshScope1();
        scope1.setName(testRefreshScope1.getName());
        scope1.setAge(testRefreshScope1.getAge());
        return scope1;
    }
 }

3、访问接口：
在这里插入图片描述
然后我们修改配置文件的内容：
在这里插入图片描述然后重新访问刚刚的接口，服务不重启：
在这里插入图片描述
已经成功获取到修改后的值。

4、使用@NacosConfigurationProperties实现nacos热更新

1、读取配置代码

@Component
@NacosConfigurationProperties(dataId = "config-teacher.yaml", prefix = "teacher", autoRefreshed = true)
public class TestNacosConfiguration1 {
    private String name;
    private Integer age;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }
}

2、controller注入：

@RestController
@RequestMapping("/config")
public class ConfigController {
@Autowired
    private TestNacosConfiguration1 testNacosConfiguration1;

@GetMapping(value = "/getValue7")
    public Object getValue7() {
        return testNacosConfiguration1;
    }
 }

3、配置文件不修改，访问接口：
在这里插入图片描述
修改nacos配置文件的内容：
在这里插入图片描述
重新请求接口：
在这里插入图片描述
同样获取到了最新的配置。

5、使用@NacosPropertySource和@ConfigurationProperties实现nacos热更新

1、读取配置的代码：

@Component
@NacosPropertySource(dataId = "config-teacher.yml", autoRefreshed = true)
@ConfigurationProperties(prefix = "teacher")
public class TestConfiguration3 {

    private String name;
    private Integer age;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }
}

2、controller注入：

@RestController
@RequestMapping("/config")
public class ConfigController {
@Autowired
    private TestConfiguration3 testConfiguration3;

@GetMapping(value = "/getValue8")
    public Object getValue8() {
        return testConfiguration3;
    }
 }

3、访问接口：
在这里插入图片描述
然后我们修改nacos配置中的文件：
在这里插入图片描述
我们重新访问刚刚的接口，服务不重启：
在这里插入图片描述
同样，获取到了最新的nacos配置文件内容。以上就是nacos热更新的4种方式。

二、本地项目配置文件读取的几种方式

注意：需要将nacos相关的配置注释，不然会读取nacos配置中心的文件！这里演示的是读取本地项目的配置文件。

1、使用@Value读取本地配置文件内容

1、新建application.yml配置文件，添加内容：

student:
  name: 张三
  age: 20

读取配置文件代码：

@Component
public class TestValue1 {
    @Value("${student.name}")
    private String name;
    @Value("${student.age}")
    private Integer age;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }
}

2、controller接口：

@RestController
@RequestMapping("/config")
public class ConfigController {
@Autowired
    private TestValue1 testValue1;

@GetMapping(value = "/getValue1")
    public Object getValue1() {
        return testValue1;
    }
}

3、访问接口，获取到配置文件内容：
在这里插入图片描述

2、使用@Value+@PropertySource读取指定配置文件内容

1、新建config2.properties配置文件，添加内容：

teacher.name=李维
teacher.age=32

读取配置文件代码：

@Component
@PropertySource(value = "classpath:config2.properties", encoding = "utf-8")
public class TestValue2 {
    @Value("${teacher.name}")
    private String name;
    @Value("${teacher.age}")
    private Integer age;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }
}

2、controller接口：

@RestController
@RequestMapping("/config")
public class ConfigController {
@Autowired
    private TestValue2 testValue2;

@GetMapping(value = "/getValue2")
    public Object getValue2() {
        return testValue2;
    }
}

3、访问接口，获取到配置文件内容：
在这里插入图片描述

3、使用@ConfigurationProperties读取配置文件内容

1、application.yml文件不变：

student:
  name: 张三
  age: 20

读取配置文件代码：

@Component
@ConfigurationProperties(prefix = "student")
public class TestConfiguration1 {
    private String name;
    private Integer age;
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }
}

2、controller接口：

@RestController
@RequestMapping("/config")
public class ConfigController {
@Autowired
    private TestConfiguration1 testConfiguration1;

@GetMapping(value = "/getValue3")
    public Object getValue3() {
        return testConfiguration1;
    }
}

3、访问接口，获取到配置文件内容：
在这里插入图片描述

4、使用@ConfigurationProperties+@PropertySource读取指定配置文件内容

1、config2.properties配置文件不变：

teacher.name=李维
teacher.age=32

读取配置文件代码：

@Component
@PropertySource("classpath:config.properties")
@ConfigurationProperties(prefix = "teacher")
public class TestConfiguration2 {
    private String name;
    private Integer age;
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }
}

2、controller接口：

@RestController
@RequestMapping("/config")
public class ConfigController {
@Autowired
    private TestConfiguration2 testConfiguration2;

@GetMapping(value = "/getValue4")
    public Object getValue4() {
        return testConfiguration2;
    }
}

3、访问接口获取：
在这里插入图片描述

源代码gitee地址：https://gitee.com/wangyi0228/nacos-config.git

wang_yi_l
关注
专栏目录
【微服务】spring读取配置文件多种方式深入详解
congge
04-21 7795
spring读取配置文件多种方式深入详解
Nacos集成Dubbo，通过@NacosConfigurationProperties注解获取配置参数为null
EO_DaRen的博客
09-01 3058
起因是项目使用到了nacos，但是nacos的@nacosvalue 和@NacosConfigurationProperties 注解不生效 ,我百度了许久，还是没有解决，后来去看了注解的源码才知道。当然了，加2个重复的配置还是不够优雅，还是看着很难受，那既然注解的默认值取不到配置文件，那就修改注解的默认值，前面加上spring.cloud.这个地方可以看到 ，这个注解读取的默认配置前面是不带spring.cloud的，（真tm坑，我找了好久），所以额外加一层配置就可以使用了。...
Nacos配置热更新
PaoShan的博客
02-06 296
基于标题
Nacos配置管理——配置热更新
最新发布
weixin_47276069的博客
07-25 363
Nacos配置管理——统一配置管理：https://mp.csdn.net/mp_blog/creation/editor/140469753。Nacos配置管理——配置热更新：https://mp.csdn.net/mp_blog/creation/editor/140469827。Nacos的依赖：https://mp.csdn.net/mp_blog/creation/editor/140469206。2.clean一下项目重新启动。
nacos学习总结一
慕容的博客
06-30 876
1.本地下载nacos，解压如下图 2.执行startup.cmd (windows)/startup.sh(linux)启动命令 当控制台打印：Completed initialization in 18 ms则代表启动成功 3.创建第一个配置文件 server.port=9095 spring.application.name=eshop-server #spring.profiles.active=dev #服务实施查看预约信息地址 service.order.appo...
Nacos配置管理和配置热更新
viperd的博客
03-01 1556
Nacos的配置管理以及热更新
Nacos配置管理-配置热更新
LMGD的博客
12-13 5708
Nacos配置之热更新
Nacos实现配置的热更新
lemonzjk的博客
01-18 1007
我们肯定是希望每次更改Nacos的配置后，无需重启微服务就可以应用配置。
Nacos源码系列之@RefreshScope
技术交流
06-04 3135
文章目录一、背景二、如何实现1、初识RefreshScope（1）ScopedProxyMode（2）@Scope("refresh")2、RefreshScope3、RefreshScope 刷新三、小结 一、背景 我们在使用Nacos做配置自动刷新时，会使用@RefreshScope注解。如： @RefreshScope @Configuration public class AsyncExceptionHandler implements AsyncConfigurer { } @Configur
可能能解决Nacos1.3.0加入注解@RefreshScope没有自动更新配置的办法
叶落雨飘的博客
07-10 2504
事情是这样的： 今天使用nacos1.3.0拉取配置中心的配置，发现拉取成功，读取到了配置。 然后在nacos配置中心页面上更改了几个数据，看看能不能自动更新配置。 在读取配置的Controller上加上了@RefreshScope注解 结果一直刷新也没有更新。 尝试重启微服务，查看控制台日志发现，能够拉取到配置，但是只有开启的时候拉取了配置中心的配置，刷新后控制台也没有任何反正，说明后续没有去配置中心去更新。 最后将Nacos重启，然后再重启微服务，@RefreshScope就可以使用，只要一更新配置就能
Nacos 配置中心 Client 端配置热更新源码分析
weixin_42118323的博客
07-23 1287
作为配置中心，热更新功能是必不可少的，Nacos 配置中心当然也是支持热更新功能的，上一篇我们分析了 Nacos 配置中心配置是如何加载的，本篇我们一起从源码的角度来分析一下 Nacos 配置中心的热更新源码。
nacos2.x客户端与Spring Boot源码解析（@NacosConfigurationProperties怎么实现配置文件热更新的）
qq_17081739的博客
11-24 1468
acos Config客户端与Spring Boot源码解析（@NacosConfigurationProperties怎么实现配置文件热更新的）
nacos 动态刷新@ConfigurationProperties
weixin_30362233的博客
09-21 5274
使用@ConfigurationProperties 可以替换@value @ConfigurationProperties@Value 注解功能 可以批量注入配置文件中的属性 只能一个个指定注入属性 松散语法绑定（Relaxed binding） 支持 不支持 EL表达式 不支持 支持 JSR303数据校验 @Val...
NacosConfigProperties
P17281293的博客
02-26 1710
在编写bootstrap.properties文件之后仍出现该问题create config service error!properties=NacosConfigProperties{serverAddr=‘null‘, encode=‘null‘ 可能是版本依赖问题 更换至 <dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-starter-alibaba-
@ConfigurationProperties结合Nacos配置动态刷新之底层原理分析
1点25的博客
05-28 1530
当Nacos服务端的配置发生改变时，会触发Nacos客户端的配置监听器，从而发布事件，从而更新对象，从而发布事件，从而利用最新的对象更新对象中的属性。
nacos @RefreshScope value 报错
09-07
您好！对于使用了 Spring Cloud 的项目，当使用 Nacos 作为配置中心时，@RefreshScope 注解用于动态刷新配置项。如果您遇到了 "@RefreshScope value" 报错，请确保以下几点： 1. 确认项目中已经正确引入了 Nacos 和 Spring Cloud 相关的依赖。可以检查项目的 pom.xml 或者 build.gradle 文件中是否包含正确的依赖项。 2. 确认 @RefreshScope 注解的使用方式是否正确。@RefreshScope 注解需要在需要动态刷新的 Bean 上进行标注。例如，如果您希望刷新某个配置类的属性值，需要在该配置类上添加 @RefreshScope 注解。 3. 确认配置项的命名是否正确。需要确保在 Nacos 配置中心上存在对应的配置项，并且配置项的命名与代码中使用的名称一致。 如果以上步骤都没有问题，但仍然报错，请提供更详细的错误信息或者代码片段，以便我更好地帮助您解决问题。
评论 16
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值