springboot 中 Nacos 如何开启自动刷新

Spring Boot 中 Nacos 自动刷新配置

在微服务架构中，配置中心是一个重要的组件，用于集中管理和动态刷新配置。Nacos 是阿里巴巴开源的一个动态服务发现、配置管理和服务管理平台。在 Spring Boot 中，可以通过 Nacos 来实现配置的自动刷新。

1. 引入依赖

要在 Spring Boot 项目中使用 Nacos 配置中心，我们需要引入相应的依赖。

1
2
3
4
5
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    <version>2.2.5.RELEASE</version> <!-- 确保版本与 Spring Cloud Alibaba 版本匹配 -->
</dependency>

2. 配置 Nacos

2.1 添加 application.properties 或 application.yml

在 application.properties 或 application.yml 文件中添加 Nacos 的相关配置。

1
2
3
4
5
6
7
8
spring:
  application:
    name: example-service # 服务名称
  cloud:
    nacos:
      config:
        server-addr: localhost:8848 # Nacos 服务器地址
        file-extension: yaml # 配置文件格式（可选：properties、yaml、json）

2.2 在 Nacos 控制台中创建对应的数据集

确保在 Nacos 控制台上创建的数据集与 application.name 对应，并设置好初始的配置信息。

3. 启用自动刷新功能

3.1 使用 @RefreshScope 注解

为了让某个类中的属性能够自动刷新，需要在该类上使用 @RefreshScope 注解。这通常用在需要动态刷新的 Bean 上。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RefreshScope
@RestController
public class ConfigController {

    @Value("${some.config.value}")
    private String configValue;

    @GetMapping("/config")
    public String getConfigValue() {
        return configValue;
    }
}

3.2 使用 @ConfigurationProperties 注解（可选）

如果你有多个相关联的属性，建议使用 @ConfigurationProperties 来绑定整个配置前缀，这样可以更好地组织代码并支持自动刷新。

1
2
3
4
5
6
7
8
9
10
11
12
13
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.stereotype.Component;

@RefreshScope
@Component
@ConfigurationProperties(prefix = "example")
public class ExampleConfig {

    private String someProperty;

    // getters and setters...
}

4. 测试自动刷新功能

可以通过修改 Nacos 控制台上的配置信息来测试自动刷新的功能。修改后，Spring Boot 应用中的对应值会被动态更新，无需重启应用。

注意事项

  • 版本兼容性：确保 Spring Cloud Alibaba 与 Spring Boot 的版本兼容，以免出现不兼容的问题。
  • 性能考虑：频繁的动态刷新可能影响性能，应根据实际情况合理设置监听和刷新的频率。
  • 安全性：确保对 Nacos 的访问是安全的，避免未授权访问导致敏感信息泄露。