java动态修改nacos的yml配置方式

 更新时间:2025年08月06日 16:46:05   作者:左边的天堂  
文章介绍修改Nacos配置文件的两种方式:snakeyaml忽略注释但修改直接,eo-yaml保留注释但格式变化,建议配置项多时用数据库存储,强调实际应用需充分评估和测试以确保可靠性

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

1、需求

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

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

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

2、实现方式一

第一种方式使用snakeyaml

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

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

@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;
}

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

express:
  appKey: xxx
  appSecret: xxx
  accessToken: 1234

3、实现方式二

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

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

详细代码

@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;
}

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

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

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

以上配置会被修改成

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

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

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • JAVA如何判断上传文件后缀名是否符合规范MultipartFile

    JAVA如何判断上传文件后缀名是否符合规范MultipartFile

    这篇文章主要介绍了JAVA判断上传文件后缀名是否符合规范MultipartFile,文中通过实例代码介绍了java实现对上传文件做安全性检查,需要的朋友可以参考下
    2023-11-11
  • Java中实现String.padLeft和String.padRight的示例

    Java中实现String.padLeft和String.padRight的示例

    本篇文章主要介绍了Java中实现String.padLeft和String.padRight,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-09-09
  • Spring框架花式创建Bean的n种方法(小结)

    Spring框架花式创建Bean的n种方法(小结)

    这篇文章主要介绍了Spring框架花式创建Bean的n种方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-03-03
  • Jmeter访问需要登录的接口如何处理问题

    Jmeter访问需要登录的接口如何处理问题

    这篇文章主要介绍了Jmeter访问需要登录的接口如何处理问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-11-11
  • SpringBoot的异常处理流程是什么样的?

    SpringBoot的异常处理流程是什么样的?

    今天给大家带来的是Java的相关知识,文章围绕着SpringBoot的异常处理流程展开,文中有非常详细的介绍及代码示例,需要的朋友可以参考下
    2021-06-06
  • 解读nextLine().split(“[\\s]“)的意思

    解读nextLine().split(“[\\s]“)的意思

    这篇文章主要介绍了解读nextLine().split(“[\\s]“)的意思,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-04-04
  • springboot后台session的存储与取出方式

    springboot后台session的存储与取出方式

    这篇文章主要介绍了springboot后台session的存储与取出方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-06-06
  • Java获取登录用户的IP地址示例代码

    Java获取登录用户的IP地址示例代码

    在开发中我们经常需要获取用户IP地址,通过地址来实现一些功能,下面这篇文章主要给大家介绍了关于Java获取登录用户的IP地址的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2023-05-05
  • mybatis批量update时报错multi-statement not allow的问题

    mybatis批量update时报错multi-statement not allow的问题

    这篇文章主要介绍了mybatis批量update时报错multi-statement not allow的问题及解决方案,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-10-10
  • Java实现上传文件图片到指定服务器目录

    Java实现上传文件图片到指定服务器目录

    本文通过实例代码给大家介绍了java上传文件图片到指定服务器目录的相关知识,代码简单易懂,非常不错,具有一定的参考借鉴价值,需要的朋友可以参考下
    2018-06-06

最新评论