springboot集成Nacos 实现多环境动态配置

nacos 阿里旗下的开源项目，一个更易于构建云原生应用的动态服务发现、配置管理和服务管理平台。

随着我国科技的进步，越来越多的开源技术来自我骄傲的中国，以前要了解某项技术除了查看国内大佬博主的文章就是硬着头皮去看官方的英文文档。现在好多了，国内的开源项目官方文档首先就得有中文版的，但是，这nacos的手册写的略显敷衍🤔。

最近上线了一个项目，上线之前整理生产环境的配置真是让人头大，生怕有遗漏或者填错的地方，如果在现场配置的有问题，改正后还得重启服务才能生效，这不，对方把我们的端口少写了个数字，某功能出现问题，白天他们又不能重启，只能等到晚上解决。如果能够使用nacos作为动态的配置中心，直接改配置不需要重启就可以解决了。

本章内容介绍的是spring-boot集成nacos ,不是spring-cloud ,导的包不一样使用起来也有点差异。

nacos服务端

首先下载安装nacos服务端
启动方法参考Nacos 快速入门
访问地址 http://127.0.0.1:8848/nacos ; 初始用户名和密码都是nacos

创建命名空间

登陆后左侧导航栏选择命名空间，右上角创建命名空间，分别创建dev 和prod 作为开发和生产环境的配置，不同空间互相隔离。用来区分环境非常合适。

创建配置文件

左侧导航栏>配置管理-配置列表
创建配置文件需要填写DataId 和GroupId,以及配置内容

注意：dataId必须以文件类型结尾

spring-boot集成nacos配置中心

添加nacos配置中心的依赖

<dependency>
    <groupId>com.alibaba.boot</groupId>
    <artifactId>nacos-config-spring-boot-starter</artifactId>
    <version>${latest.version}</version>
</dependency>

springboot 版本 2.3.2.RELEASE
nacos-config 版本 0.2.7

yml配置nacos服务端地址和命名空间

创建配置文件application-dev.yml 和application-prod.yml
根据在nacos服务端控制台创建的两个命名空间的ID分别填写到开发环境和生产环境的yml文件里

• application-dev.yml

nacos:
  config:
    namespace: 133c9c90-6d9c-45cd-8067-06f853607940
    server-addr: 127.0.0.1:8848

• application-prod.yml

nacos:
  config:
    namespace: 72008218-19b0-4960-ab44-a0cbdd8097a0
    server-addr: 127.0.0.1:8848

启动类配置dataId 和 groupId

@NacosPropertySource注解填写dataId 和 groupId ，autoRefreshed = true 表示动态刷新的总开关，ture：开启，默认是false.
读取多个配置文件就写多个注解，如果两个配置文件中有相同的配置，排在上面的注解读取的配置内容优先级最高。
同一个配置文件可以被同空间的应用共享。

@SpringBootApplication
@NacosPropertySource(dataId = "mashu-demo.yaml", autoRefreshed = true, groupId = "USER_GROUP")
@NacosPropertySource(dataId = "dashu-demo.yaml", autoRefreshed = true, groupId = "USER_GROUP")

注入配置内容

@NacosValue注解获取配置内容，autoRefreshed = true 表示开启动态刷新

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

不同环境的启动方法

命令行读取不同环境的配置：

启动参数根据-Dspring.profiles.active=dev或-Dspring.profiles.active=prod切换开发和生产环境
读取application-dev.yml 还是 application-prod.yml 依据是"-"后面的单词，即: dev/prod

开发工具读取不同环境的配置：
idea 开发工具是打开设置Edit configurations 选项，在Actice profile 后面填写dev或者prod

至此多环境动态配置完成。

数据持久化

为了保证数据的安全性，nacos还支持将数据同步到数据库。
这个需要在nacos服务端配置，在下载的nacos安装包里面nacos-server-1.2.1\nacos\conf\nacos-mysql.sql有msyql初始化的sql脚本。
根据实际情况修改配置文件nacos-server-1.2.1\nacos\conf\application.properties

spring.datasource.platform=mysql
### Count of DB:
db.num=1
### Connect URL of DB:
db.url.0=jdbc:mysql://127.0.0.1:3306/nacos?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true
db.user=root
db.password=123456

注意：如果之前没有做持久化，做了持久化之后会把之前的配置干掉。😒

java SDK

nacos还支持java客户端对配置内容的操作和配置变更的监听。

1.导包：

<dependency>
    <groupId>com.alibaba.nacos</groupId>
    <artifactId>nacos-client</artifactId>
    <version>1.2.0</version>
</dependency>

2.根据ip和命名空间获取配置文件对象ConfigService

String serverAddr = "127.0.0.1:8848";
String namespace = "72008218-19b0-4960-ab44-a0cbdd8097a0";
Properties properties = new Properties();
properties.put("serverAddr", serverAddr);
properties.put("namespace", namespace);
ConfigService configService = NacosFactory.createConfigService(properties);

configService对象有几个常用的方法：

1.getConfig()获得配置内容

String dataId = "dashu-demo.yaml";
String groupId = "USER_GROUP";
String content = configService.getConfig(dataId, groupId, 5000);

2.publishConfig()发布配置

String content = "name: mashu";
configService.publishConfig(dataId, group, content);

3.removeConfig()删除配置

configService.removeConfig(dataId, group);

4.addListener()添加监听

Listener listener = new Listener() {
    @Override
    public void receiveConfigInfo(String configInfo) {
        System.out.println("变更后读取到的配置内容：" + "\r\n" + configInfo);
    }
    @Override
    public Executor getExecutor() {
        return null;
    }
configService.addListener(dataId, groupId, listener);

5.removeListener()删除监听

configService.removeListener(dataId, groupId, listener);

以上配置内容的获取，添加，删除，监听都是全量的。

遇到问题

nacos对于已经jasypt加密的数据正常读取但是不能够动态刷新，甚至它父节点以下的兄弟节点没有加密的属性都会丧失动态刷新的功能。重启项目才能读到最新的数据。

猜测：nacos 第一次能够读到加密的数据是解密后的可以理解，启动参数有解密的密钥，应该是解密后naocs读取的，但是更新加密的字段nacos应该做不到，它没有密钥。nacos为了防止更新加密的数据失败，它就让加密的数据失去动态更新的能力。

困惑：我将原本加密的属性包括它父节点下面节点所有加密的属性都改成了非加密，重启项目后发现依然不能动态刷新！不能理解这种"记仇"现象，即使我重启nacos服务端也不能解决。

优缺点：

单说nacos的配置管理功能

优点：

1. 支持动态刷新
2. 支持共享配置文件，相同配置，配置在上面的优先级最高。
3. 有历史记录，可回滚
4. 每次修改有文件对比功能，降低出错率
5. 支持Java代码的配置变更监听，内容的获取，添加，删除，不过都是全量

缺点：

1. 不支持加密属性的动态刷新
2. 对配置变更监听，内容的获取，添加，删除都是全量的

---

对nacos了解甚浅，有些理解可能有误差。如有错误请指出，感激不尽。