java動(dòng)態(tài)修改nacos的yml配置方式

更新時(shí)間：2025年08月06日 16:46:05 作者：左邊的天堂

文章介紹修改Nacos配置文件的兩種方式：snakeyaml忽略注釋但修改直接,eo-yaml保留注釋但格式變化,建議配置項(xiàng)多時(shí)用數(shù)據(jù)庫(kù)存儲(chǔ),強(qiáng)調(diào)實(shí)際應(yīng)用需充分評(píng)估和測(cè)試以確?？煽啃?/div>

1、需求

假設(shè)nacos上有一個(gè)test-dev.yml配置文件，其內(nèi)容如下：

# 快遞相關(guān)配置，accessToken每月需要更新一次
express:
  appKey: xxx
  appSecret: xxx
  accessToken: 123456789

現(xiàn)在需要把accessToken字段的值修改成1234。

2、實(shí)現(xiàn)方式一

第一種方式使用snakeyaml

<dependency>
	<groupId>org.yaml</groupId>
	<artifactId>snakeyaml</artifactId>
	<version>2.0</version>
</dependency>

這種方式有個(gè)弊端就是會(huì)把配置的注釋行給忽略掉

@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時(shí)需要設(shè)置
       properties.put("namespace", "test");
       // 讀取nacos配置
       // 推薦使用NacosConfigManager獲取當(dāng)前ConfigService
       ConfigService configService = NacosFactory.createConfigService(properties);
       String content = configService.getConfig(dataId, group, 5000);
       
       Yaml yaml = new Yaml();
       // 字符串轉(zhuǎn)換成map，這里會(huì)把注釋行丟棄
       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;
}

執(zhí)行成功后，文件內(nèi)容被修改成

express:
  appKey: xxx
  appSecret: xxx
  accessToken: 1234

3、實(shí)現(xiàn)方式二

如果需要保留注釋?zhuān)瑒t可以用eo-yaml

<dependency>
    <groupId>com.amihaiemil.web</groupId>
    <artifactId>eo-yaml</artifactId>
    <version>7.0.8</version>
</dependency>

詳細(xì)代碼

@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);
        //修改對(duì)應(yīng)的配置
        YamlMapping mapping = Yaml.createYamlInput(content).readYamlMapping();
        // log.info("{}", mapping.toString());
        YamlMapping express = mapping.value("express").asMapping();
        String accessToken = express.string("accessToken");
        // 如果兩個(gè)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-標(biāo)識(shí)覆蓋已有值，false則為追加新的字段
                true
        );
        //更新nacos配置
        return configService.publishConfig(dataId, group, edited.toString(), ConfigType.YAML.getType());
    } catch (NacosException | IOException e) {
       e.printStackTrace();
    }
    return Boolean.FALSE;
}

采用這種方式回寫(xiě)后的配置會(huì)給字符串加上雙引號(hào)，并且空行會(huì)被移除。如：

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

# 快遞相關(guān)配置，accessToken每月需要更新一次
express:
  appKey: xxx
  appSecret: xxx
  accessToken: 123456789

以上配置會(huì)被修改成

# mybatis配置
mybatis:
  # 搜索指定包別名
  typeAliasesPackage: com.text.mapper
  # 配置mapper的掃描，找到所有的mapper.xml映射文件
  mapperLocations: "classpath:mapper/**/*.xml"
# 快遞相關(guān)配置，accessToken每月需要更新一次
express:
  appKey: xxx
  appSecret: xxx
  accessToken: 1234

通常這些操作是不會(huì)受影響，但在實(shí)際應(yīng)用中還是要充分的評(píng)估和充足的測(cè)試，以保證萬(wàn)無(wú)一失。