java动态修改nacos的yml配置_yml格式文件中的配置代码修改

本文只介绍修改方案，没有对方案的可靠性进一步分析。如果涉及的nacos配置项很多，更建议采用数据库表单独存储，并对其进行增删改查。

1、需求

假设nacos上有一个test-dev.yml配置文件，其内容如下：

# 快递相关配置，accessToken每月需要更新一次
express:
  appKey: xxx
  appSecret: xxx
  accessToken: 123456789
1
2
3
4
5

现在需要把accessToken字段的值修改成1234。

2、实现方式一

第一种方式使用snakeyaml

<dependency>
	<groupId>org.yaml</groupId>
	<artifactId>snakeyaml</artifactId>
	<version>2.0</version>
</dependency>
1
2
3
4
5

这种方式有个弊端就是会把配置的注释行给忽略掉

@Value("${spring.profiles.active}")
private String profile;
@Value("${spring.cloud.nacos.config.server-addr}")
private String serverAddr;
private final String group = "DEFAULT_GROUP";

/**
 * 更新Nacos配置
 *
 * @param newAccessToken 
 * @return
 */
private Boolean updateCofig(String newAccessToken) {
   try {
       String dataId = String.format("test-%s.yml", profile);
       Properties properties = new Properties();
       properties.put("serverAddr", serverAddr);
       // 非public时需要设置
       properties.put("namespace", "test");
       // 读取nacos配置
       // 推荐使用NacosConfigManager获取当前ConfigService
       ConfigService configService = NacosFactory.createConfigService(properties);
       String content = configService.getConfig(dataId, group, 5000);
       
       Yaml yaml = new Yaml();
       // 字符串转换成map，这里会把注释行丢弃
       Map<String, Object> data = yaml.load(content);
       // 字段覆盖
       Map<String, Object> express = (Map<String, Object>) data.get("express");
       express.put("accessToken", newAccessToken);
       String yamlStr = yaml.dumpAsMap(data);
       //更新nacos配置
       return configService.publishConfig(dataId, group, yamlStr, ConfigType.YAML.getType());
   } catch (NacosException e) {
       e.printStackTrace();
   }
   return Boolean.FLASE;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

执行成功后，文件内容被修改成

express:
  appKey: xxx
  appSecret: xxx
  accessToken: 1234
1
2
3
4

3、实现方式二

如果需要保留注释，则可以用eo-yaml

<dependency>
    <groupId>com.amihaiemil.web</groupId>
    <artifactId>eo-yaml</artifactId>
    <version>7.0.8</version>
</dependency>
1
2
3
4
5

详细代码

@Autowired
private NacosConfigManager nacosConfigManager;
@Value("${spring.profiles.active}")
private String profile;
private final String group = "DEFAULT_GROUP";

/**
 * 更新Nacos配置
 *
 * @param newAccessToken
 * @return
 */
private Boolean updateConfig(String newAccessToken) {
    try {
        String dataId = String.format("test-%s.yml", profile);
        //读取nacos配置
        ConfigService configService = nacosConfigManager.getConfigService();
        String content = configService.getConfig(dataId, group, 5000);
        //修改对应的配置
        YamlMapping mapping = Yaml.createYamlInput(content).readYamlMapping();
        // log.info("{}", mapping.toString());
        YamlMapping express = mapping.value("express").asMapping();
        String accessToken = express.string("accessToken");
        // 如果两个token一样则忽略修改
        if(newAccessToken.equals(accessToken)){
            log.warn("token未变化，忽略");
            return true;
        }
        YamlMapping edited = new MergedYamlMapping(
        		// 原有配置
        		mapping,
        		// 需要更新的字段
                () -> Yaml.createYamlMappingBuilder()
                        .add("express", Yaml.createYamlMappingBuilder()
                                .add("accessToken", newAccessToken)
                                .build()
                        ).build(),
                // true-标识覆盖已有值，false则为追加新的字段
                true
        );
        //更新nacos配置
        return configService.publishConfig(dataId, group, edited.toString(), ConfigType.YAML.getType());
    } catch (NacosException | IOException e) {
       e.printStackTrace();
    }
    return Boolean.FALSE;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

采用这种方式回写后的配置会给字符串加上双引号，并且空行会被移除。如：

# mybatis配置
mybatis:
  # 搜索指定包别名
  typeAliasesPackage: com.text.mapper
  # 配置mapper的扫描，找到所有的mapper.xml映射文件
  mapperLocations: classpath:mapper/**/*.xml

# 快递相关配置，accessToken每月需要更新一次
express:
  appKey: xxx
  appSecret: xxx
  accessToken: 123456789

1
2
3
4
5
6
7
8
9
10
11
12
13

以上配置会被修改成

# mybatis配置
mybatis:
  # 搜索指定包别名
  typeAliasesPackage: com.text.mapper
  # 配置mapper的扫描，找到所有的mapper.xml映射文件
  mapperLocations: "classpath:mapper/**/*.xml"
# 快递相关配置，accessToken每月需要更新一次
express:
  appKey: xxx
  appSecret: xxx
  accessToken: 1234
1
2
3
4
5
6
7
8
9
10
11

通常这些操作是不会受影响，但在实际应用中还是要充分的评估和充足的测试，以保证万无一失。