Nacos配置中心学习03-SpringBoot示例

本示例仅介绍 Nacos 作为配置中心的功能，本系列的后续示例也是如此。

我们先了解下 Nacos 配置的相关概念，对后面的示例会有更深入的理解。

一、Nacos 配置相关概念

1. 命名空间

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

2. 配置

在系统开发过程中，开发者通常会将一些需要变更的参数、变量等从代码中分离出来独立管理，以独立的配置文件的形式存在。目的是让静态的系统工件或者交付物（如 WAR，JAR 包等）更好地和实际的物理运行环境进行适配。配置管理一般包含在系统部署的过程中，由系统管理员或者运维人员完成。配置变更是调整系统运行时的行为的有效手段。

3. 配置管理

系统配置的编辑、存储、分发、变更管理、历史版本管理、变更审计等所有与配置相关的活动。

4. 配置项

一个具体的可配置的参数与其值域，通常以 param-key=param-value 的形式存在。例如我们常配置系统的日志输出级别（logLevel=INFO|WARN|ERROR） 就是一个配置项。

5. 配置集

一组相关或者不相关的配置项的集合称为配置集。在系统中，一个配置文件通常就是一个配置集，包含了系统各个方面的配置。例如，一个配置集可能包含了数据源、线程池、日志级别等配置项。

6. 配置集 ID

Nacos 中的某个配置集的 ID。配置集 ID 是组织划分配置的维度之一。Data ID 通常用于组织划分系统的配置集。一个系统或者应用可以包含多个配置集，每个配置集都可以被一个有意义的名称标识。Data ID 通常采用类 Java 包（如 com.taobao.tc.refund.log.level）的命名规则保证全局唯一性。此命名规则非强制。

7. 配置分组

Nacos 中的一组配置集，是组织配置的维度之一。通过一个有意义的字符串（如 Buy 或 Trade ）对配置集进行分组，从而区分 Data ID 相同的配置集。当您在 Nacos 上创建一个配置时，如果未填写配置分组的名称，则配置分组的名称默认采用 DEFAULT_GROUP 。配置分组的常见场景：不同的应用或组件使用了相同的配置类型，如 database_url 配置和 MQ_topic 配置。

8. 配置快照

Nacos 的客户端 SDK 会在本地生成配置的快照。当客户端无法连接到 Nacos Server 时，可以使用配置快照显示系统的整体容灾能力。配置快照类似于 Git 中的本地 commit，也类似于缓存，会在适当的时机更新，但是并没有缓存过期（expiration）的概念。

二、Nacos Spring Boot 示例

1. 创建一个 Spring Boot 工程

2. pom 文件加入 Nacos 依赖

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

3. 在 application.properties 中配置 Nacos server 的地址

nacos.config.server-addr=127.0.0.1:8848

4. 使用 @NacosPropertySource 加载 dataId 为 nacos-demo-springboot 的配置源，并开启自动更新

@SpringBootApplication
@NacosPropertySource(dataId = "nacos-demo-springboot", autoRefreshed = true)
public class NacosDemoApplication {

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

5. 通过 Nacos 的 @NacosValue 注解设置属性值

@RestController
@RequestMapping("/demo")
public class DemoController {

    @NacosValue(value = "${test.name}", autoRefreshed = true)
    private String name;

    @NacosValue(value = "${test.name2}")
    private String name2;

    @RequestMapping("/name")
    public String getName() {
        return this.name;
    }

    @RequestMapping("/name2")
    public String getName2() {
        return this.name2;
    }
}

6. 设置配置

登录到 Nacos 新建配置，Data ID 设置为 nacos-demo-springboot ，添加2个配置项

test.name=zhangsan
test.name2=lisi

7. 启动应用进行验证

首先能获取到配置项的值
访问 http://localhost:8080/demo/name 值为 zhangsan
访问 http://localhost:8080/demo/name2 值为 lisi

在 Nacos 页面修改配置项的值为

test.name=zhangsansan
test.name2=lisisi

再次调用验证
发现 http://localhost:8080/demo/name 获取的值为 zhangsansan，说明已经更新为最新值，而 http://localhost:8080/demo/name2 获取的值 仍为 lisi

返回看源码，发现注解没有加 autoRefreshed = true ，可能是这个原因

@NacosValue(value = "${test.name2}")
private String name2;

加上后再试

@NacosValue(value = "${test.name2}", autoRefreshed = true)
private String name2;

问题解决。看来如果想要配置项的值自动刷新，仅在 @NacosPropertySource 加 autoRefreshed = true 是不够的，在 @NacosValue 上面也得加 autoRefreshed = true

那如果本地也有同样的配置项呢，会以哪个为准
在 application.properties 中加一个配置项

test.name2=lisi

然后改配置中心的配置项

test.name2=lisi2

访问 http://localhost:8080/demo/name2 结果为 lisi2，说明如果本地和配置中心的配置项有冲突时，则以配置中心的值为准。这也比较好理解，既然配置中心化了，就得以中心的为准。

如果使用 Spring 支持的 @Value 注解，是否也支持自动刷新呢

@Value(value = "${test.name2}")
private String name2;

经过验证，能获取到 name2 的值，但是不会自动刷新。如果想要自动刷新，需要使用 Nacos 的 Spring Cloud 使用方式，下节再介绍。

三、 参考文档

[1] https://nacos.io/zh-cn/docs/quick-start-spring-boot.html
[2] https://nacos.io/zh-cn/docs/concepts.html