跨项目配置，nacos的动态更新配置,如何才能生效

小民有话说

已于 2023-11-07 14:16:27 修改

阅读量772

点赞数

分类专栏： Java 文章标签： 1024程序员节

于 2023-10-24 17:12:57 首次发布

本文链接：https://blog.youkuaiyun.com/u013367040/article/details/134016599

版权

Java 专栏收录该内容

30 篇文章

订阅专栏

本文介绍了在SpringCloud项目中，如何通过Nacos的refreshable-dataids和SpringBoot的@RefreshScope实现跨项目配置的动态更新。方法包括在Nacos设置refreshable-dataids以及在SpringBoot中使用@RefreshScope注解以监听配置变化并自动刷新Bean。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

在SpringCloud项目中，有时会出现多个项目读取同一配置的场景，那么这种跨项目的动态更新配置，如何才能生效。

方案1.使用refreshable-dataids

如果配置文件是使用如下方式获取配置，只需要使用refreshable-dataids
在这里插入图片描述

在Nacos中，refreshable-dataids（可刷新的数据ID）是用于动态更新配置的一种机制。通过配置refreshable-dataids，你可以指定需要动态刷新的配置项，在配置更新时自动通知应用程序进行刷新。

下面是一个示例，展示了如何在Nacos中使用refreshable-dataids：

在Nacos控制台创建或编辑配置。

在配置的元数据（Metadata）中添加refreshable-dataids属性，并指定需要刷新的数据ID。例如：

refreshable-dataids = dataId1,dataId2,dataId3

这里的dataId1、dataId2、dataId3是需要刷新的配置文件ID，多个ID之间使用逗号分隔。

保存配置并发布。

当你在Nacos控制台修改了指定的数据ID对应的配置内容后，Nacos会自动通知应用程序进行刷新。应用程序可以通过监听配置变化的事件来实现刷新逻辑，并获取最新的配置内容。

方案2.使用@RefreshScope

当你使用如下方式获取配置时，需要在方案1的基础上，同时使用该注解
在这里插入图片描述

@RefreshScope注解用于标记一个Bean，表示该Bean可以在运行时动态刷新配置。当使用Spring Cloud Config等外部配置中心时，使用@RefreshScope注解可以使应用程序在配置更改时自动重新加载Bean。

以下是一个示例，展示了如何在Spring Boot中使用@RefreshScope注解：

@RestController
@RequestMapping("/example")
@RefreshScope
public class ExampleController {
    
    @Value("${example.property}")
    private String exampleProperty;
    
    @GetMapping("/property")
    public String getProperty() {
        return exampleProperty;
    }
}

在上面的例子中，我们创建了一个ExampleController类，并在类上使用了@RefreshScope注解。该注解告诉Spring容器，该Bean可以在运行时动态刷新。

我们还在ExampleController类中注入了一个名为exampleProperty的属性，并使用@Value注解从配置文件中获取其值。当配置文件中的example.property属性发生更改时，使用@RefreshScope注解的Bean会自动重新加载，从而更新exampleProperty属性的值。

需要注意的是，要使@RefreshScope注解生效，需要在应用程序中使用Spring Cloud Config等外部配置中心，并在配置中心中配置相应的刷新端点。具体的实现方式取决于你使用的配置中心和版本。

注意，参数声明方式必须为private