通过代码获取nacos中配置的yml或properties（静态项目导个nacos的包也可使用父级的配置）

已于 2024-03-23 19:25:30 修改
阅读量3k 收藏 6
点赞数 1
分类专栏： # nacos 文章标签： java
于 2021-09-13 11:07:17 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/gdkbb/article/details/120262963
版权
  1. 新建个工具类 YamlUtils
package com.baasia.common.utils.utils;

import lombok.Cleanup;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import org.yaml.snakeyaml.DumperOptions;
import org.yaml.snakeyaml.Yaml;

import java.io.FileWriter;
import java.io.InputStream;
import java.util.LinkedHashMap;
import java.util.Map;

/**
 * @author Yuan
 */
@Slf4j
@Component
public class YamlUtils {

    private final static DumperOptions OPTIONS = new DumperOptions();

    static {
        //设置yaml读取方式为块读取
        OPTIONS.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK);
        OPTIONS.setDefaultScalarStyle(DumperOptions.ScalarStyle.PLAIN);
        OPTIONS.setPrettyFlow(false);
    }

    /**
     * 将yaml配置文件转化成map
     * fileName 默认是resources目录下的yaml文件, 如果yaml文件在resources子目录下，需要加上子目录 比如：conf/config.yaml
     *
     * @param fileName
     * @return
     */
    public Map<String, Object> getYamlToMap(String fileName) {
        LinkedHashMap<String, Object> yamls = new LinkedHashMap<String, Object>();
        Yaml yaml = new Yaml();
        try {
            @Cleanup InputStream in = YamlUtils.class.getClassLoader().getResourceAsStream(fileName);
            yamls = yaml.loadAs(in, LinkedHashMap.class);
        } catch (Exception e) {
            log.error("{} load failed !!!", fileName);
        }
        return yamls;
    }

    /**
     * key格式：aaa.bbb.ccc
     * 通过properties的方式获取yaml中的属性值
     *
     * @param key
     * @param yamlMap
     * @return
     */
    public Object getValue(String key, Map<String, Object> yamlMap) {
        String[] keys = key.split("[.]");
        Object o = yamlMap.get(keys[0]);
        if (key.contains(".")) {
            if (o instanceof Map) {
                return getValue(key.substring(key.indexOf(".") + 1), (Map<String, Object>) o);
            } else {
                return null;
            }
        } else {
            return o;
        }
    }

    /**
     * 使用递归的方式设置map中的值，仅适合单一属性
     * key的格式: "server.port"
     * server.port=111
     **/
    public Map<String, Object> setValue(String key, Object value) {
        Map<String, Object> result = new LinkedHashMap<String, Object>();
        String[] keys = key.split("[.]");
        int i = keys.length - 1;
        result.put(keys[i], value);
        if (i > 0) {
            return setValue(key.substring(0, key.lastIndexOf(".")), result);
        }
        return result;
    }

    public Map<String, Object> setValue(Map<String, Object> map, String key, Object value) {

        String[] keys = key.split("\\.");

        int len = keys.length;
        Map temp = map;
        for (int i = 0; i < len - 1; i++) {
            if (temp.containsKey(keys[i])) {
                temp = (Map) temp.get(keys[i]);
            } else {
                return null;
            }
            if (i == len - 2) {
                temp.put(keys[i + 1], value);
            }
        }
        for (int j = 0; j < len - 1; j++) {
            if (j == len - 1) {
                map.put(keys[j], temp);
            }
        }
        return map;
    }


    /**
     * 修改yaml中属性的值
     *
     * @param key      key是properties的方式： aaa.bbb.ccc (key不存在不修改)
     * @param value    新的属性值 （新属性值和旧属性值一样，不修改）
     * @param yamlName
     * @return true 修改成功，false 修改失败。
     */
    public boolean updateYaml(String key, Object value, String yamlName) {

        Map<String, Object> yamlToMap = this.getYamlToMap(yamlName);
        if (null == yamlToMap) {
            return false;
        }
        Object oldVal = this.getValue(key, yamlToMap);

        //未找到key 不修改
        if (null == oldVal) {
            log.error("{} key is not found", key);
            return false;
        }
        //不是最小节点值，不修改
        if (oldVal instanceof Map) {
            log.error("input key is not last node {}", key);
            return false;
        }

        //新旧值一样 不修改
        if (value.equals(oldVal)) {
            log.info("newVal equals oldVal, newVal: {} , oldVal: {}", value, oldVal);
            return false;
        }

        Yaml yaml = new Yaml(OPTIONS);
        String path = this.getClass().getClassLoader().getResource(yamlName).getPath();
        try {
            Map<String, Object> resultMap = this.setValue(yamlToMap, key, value);
            if (resultMap != null) {
                yaml.dump(this.setValue(yamlToMap, key, value), new FileWriter(path));
                return true;
            } else {
                return false;
            }
        } catch (Exception e) {
            log.error("yaml file update failed !");
            log.error("msg : {} ", e.getMessage());
            log.error("cause : {} ", e.getCause());
        }
        return false;
    }



    /**
     * 修改yaml中属性的值(就算key为 null也肯定会修改)
     *
     * @param key      key是properties的方式： aaa.bbb.ccc (key不存在不修改)
     * @param value    新的属性值 （新属性值和旧属性值一样，不修改）
     * @param yamlName
     * @return true 修改成功，false 修改失败。
     */
    public boolean updateYamlToNULL(String key, Object value, String yamlName) {

        Map<String, Object> yamlToMap = this.getYamlToMap(yamlName);
        if (null == yamlToMap) {
            return false;
        }
        Object oldVal = this.getValue(key, yamlToMap);
        //不是最小节点值，不修改
        if (oldVal instanceof Map) {
            log.error("input key is not last node {}", key);
            return false;
        }
        Yaml yaml = new Yaml(OPTIONS);
        String path = this.getClass().getClassLoader().getResource(yamlName).getPath();
        try {
            Map<String, Object> resultMap = this.setValue(yamlToMap, key, value);
            if (resultMap != null) {
                yaml.dump(this.setValue(yamlToMap, key, value), new FileWriter(path));
                return true;
            } else {
                return false;
            }
        } catch (Exception e) {
            log.error("yaml file update failed !");
            log.error("msg : {} ", e.getMessage());
            log.error("cause : {} ", e.getCause());
        }
        return false;
    }

    public static void main(String[] args) {

        YamlUtils configs = new YamlUtils();

        Map<String, Object> yamlToMap = configs.getYamlToMap("conf/config.yaml");

        System.out.println(yamlToMap);

        boolean b = configs.updateYaml("sys.cpu.name", "Intel Core i7", "conf/config.yaml");
        System.out.println(b);

        System.out.println(configs.getYamlToMap("conf/config.yaml"));
    }

}



package com.baasia.common.utils.config.nacos;

import com.baasia.common.utils.constant.AuthConstant;
import com.baasia.common.utils.utils.ContextUtil;
import com.baasia.common.utils.utils.YamlUtils;
import lombok.extern.log4j.Log4j2;

import java.io.IOException;
import java.util.Map;

@Log4j2
public class NacosConfig {

    //读取的文件
    public static final String BOOTSTRAP_YML_URL = "bootstrap.yml";
    /**
     * nacos 地址
     */
    public static final String NACOS_SERVER_ADDR = "spring.cloud.nacos.config.server-addr";
    /**
     * nacos discovery 地址
     */
    public static final String NACOS_SERVER_DISCOVERY_ADDR = "spring.cloud.nacos.discovery.server-addr";
    /**
     * 项目启动的环境
     */
    public static final String ACTIVE_CONFIG = "spring.profiles.active";

    /**
     * 修改nacos 默认
     * 项目初始化前先执行当前参数用于初始化class 文件中的配置
     */
    public void upNacosData(){
        YamlUtils configs = new YamlUtils();
        Map<String, Object> yamlToMap = configs.getYamlToMap(BOOTSTRAP_YML_URL);
        //项目启动环境参数
        Object env = configs.getValue(ACTIVE_CONFIG, yamlToMap);
        //nacos 地址参数
        Object nacos = configs.getValue(NACOS_SERVER_ADDR, yamlToMap);
        /**
         * 判断nacos 是否有值，没有则使用
         */
        Object bootstrapNacos = configs.getValue(NACOS_SERVER_ADDR, yamlToMap);
        if (null == bootstrapNacos || "".equals(bootstrapNacos)){
            //参数默认读取dev
            nacos = AuthConstant.NACOS_DEV;
            env = AuthConstant.DEV;
        }
        //调用私有方法设置yaml 文件参数
        setNacosUrl(configs, NACOS_SERVER_ADDR, nacos !=null?nacos.toString():null, BOOTSTRAP_YML_URL, ACTIVE_CONFIG, env != null ? 		  env.toString() : null);
    }

    /**
     * 设置nacos 地址
     * @param configs
     * @param nacos           nacos项配置位置
     * @param nacosUrl        nacosUrl nacos路径
     * @param bootstrapYml    bootstrap 文件名称
     * @param activeConfig    项目启动的环境配置位置
     * @param env             环境变量
     */
    private void setNacosUrl(YamlUtils configs, String nacos, String nacosUrl, String bootstrapYml, String activeConfig, String env) {
        //修改nacos
        boolean flag = configs.updateYamlToNULL(nacos, nacosUrl, bootstrapYml);
        //修改启动配置
        configs.updateYamlToNULL(activeConfig, env, bootstrapYml);
        log.info("环境变量：" + env + "--------------->nacos地址：" + nacosUrl);
    }


    public void nacosDate() throws IOException {
        //springBoot 启动时将环境参数放入了ApplicationContext 中，这个工具类就是获取ApplicationContext的环境参数
        String activeProfile = new ContextUtil().getActiveProfile();
        YamlUtils configs = new YamlUtils();
        Map<String, Object> yamlToMap = configs.getYamlToMap(BOOTSTRAP_YML_URL);
        System.out.println(yamlToMap);
        /**
         * 设置nacos 地址
         */
        if (AuthConstant.TEST.equals(activeProfile)) {
            setNacosUrl(configs, NACOS_SERVER_ADDR, AuthConstant.NACOS_TEST, BOOTSTRAP_YML_URL, ACTIVE_CONFIG, AuthConstant.TEST);
            setNacosUrl(configs, NACOS_SERVER_DISCOVERY_ADDR, AuthConstant.NACOS_TEST, BOOTSTRAP_YML_URL, ACTIVE_CONFIG, AuthConstant.TEST);
        } else if (AuthConstant.PROD.equals(activeProfile)) {
            setNacosUrl(configs, NACOS_SERVER_ADDR, AuthConstant.NACOS_PROD, BOOTSTRAP_YML_URL, ACTIVE_CONFIG, AuthConstant.PROD);
            setNacosUrl(configs, NACOS_SERVER_DISCOVERY_ADDR, AuthConstant.NACOS_PROD, BOOTSTRAP_YML_URL, ACTIVE_CONFIG, AuthConstant.PROD);
        } else {
            setNacosUrl(configs, NACOS_SERVER_ADDR, AuthConstant.NACOS_DEV, BOOTSTRAP_YML_URL, ACTIVE_CONFIG, AuthConstant.DEV);
            setNacosUrl(configs, NACOS_SERVER_DISCOVERY_ADDR, AuthConstant.NACOS_DEV, BOOTSTRAP_YML_URL, ACTIVE_CONFIG, AuthConstant.DEV);
        }
        Map<String, Object> yamlToMaprrrr = configs.getYamlToMap(BOOTSTRAP_YML_URL);
        System.out.println("更改后的nacos: " + yamlToMaprrrr.toString());
    }



}

2.读取nacos配置（Properties 文件）

YamlUtils configs = new YamlUtils();
        Map<String, Object> yamlToMap = configs.getYamlToMap(NacosConfig.BOOTSTRAP_YML_URL);
        //获取nacos地址
        Object nacos = configs.getValue(NacosConfig.NACOS_SERVER_ADDR, yamlToMap);
        Properties properties = new Properties();
        properties.put(PropertyKeyConst.SERVER_ADDR, nacos);
        ConfigService configService = NacosFactory.createConfigService(properties);
        String content = configService.getConfig("quartz.properties", "DEFAULT_GROUP", 5000);
        properties.load(new ByteArrayInputStream(content.getBytes(StandardCharsets.UTF_8)));
        //根据key获取
		properties.getProperty("xxxx")

(yml)

YamlUtils configs = new YamlUtils();
            Map<String, Object> yamlToMap = configs.getYamlToMap(NacosConfig.BOOTSTRAP_YML_URL);
            //获取nacos地址
            Object nacos = configs.getValue(NacosConfig.NACOS_SERVER_ADDR, yamlToMap);
            Properties properties = new Properties();
            YamlPropertiesFactoryBean yamlFactory = new YamlPropertiesFactoryBean();
            //设置获取地址
            properties.put(PropertyKeyConst.SERVER_ADDR, nacos);
            //获取全部nacos配置文件
            ConfigService configService = NacosFactory.createConfigService(properties);
            //根据dataId 与 group 拿去对应的配置文件
            String content = configService.getConfig("commonUrl.yml", "DEFAULT_GROUP", 5000);
            //将内容转为Resource
            yamlFactory.setResources(new ByteArrayResource(content.getBytes()));
            properties = yamlFactory.getObject();
            properties.getProperty("xxxx");

有问题可留言或私信，看到即回

GDKbb
关注
  • 1
    点赞
  • 踩
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
springboot 使用yml配置文件给静态变量赋值教程
12-20
声明： 此处需求是修改封装的clickhouseUtil数据查询引擎连接工具类。由于此类中的方法都是静态方法。连接地址等参数需要根据不同环境改变。例如开发下地址，测试下地址，生产地址等，所有通过配置文件来获取不同环境下的配置参数，但是使用的方法是静态的，所有不能使用一般情况下的@value直接给变量赋值，需要用到spring 属性的set方法来给静态变量赋值，然后静态方法使用静态变量即可 方法： 第一步：在yml文件中配置需要的参数 clickhouse: address: jdbc:clickhouse://172.20.xxx.xxx:8123 username: default
Java nacos配置中心
AndroidOrCsharp
06-12 8728
在Java开发过程中，我们可能会碰到处理XML和HTML的情况，一般情况下HTML文件字符串长度是很长的，不方便编辑。 我们在开发过程中遇到一个问题是对上传的SVG图片添加一个属性，查找资料后决定用Jsoup来处理。 使用Jsoup需要先安装对应的jar包，我们项目中使用Maven作为包管理器。不了解Maven的小伙伴可以看下另一篇帖子。 https://blog.csdn.net/qq_3...
bootstrap.yml读取nacos配置中心的配置文件
热门推荐
six_teen的博客
10-15 2万+
最近搞nacos做为springboot的配置中心时，运行项目就一直报错，报错原因是没有加载到配置文件，可是nacos服务的地方又确确实实配置了配置文件，最后在启动的控制台中找到了一些线索，结合百度和源码查看找到了原因所在。 线索：（ps:因为不知道怎么截横向的长图只能这样了） 项目启动时的控制台输出 写着需要 spring.application.name.properties配置文件 后面找到了PropertySourceBootstrapConfiguration类 应该是默认读取配置中心以p
spring cloud nacos使用yaml类型获取数组配置的几种方式
BUG指挥课堂
09-17 2779
方式一 配置项 app: demo: list1: xiaohong, xiaoming list2: > xiaohong, xiaoming list1和list2看起来是2种风格，其实都是同一种写法，以逗号分隔 java代码 @Data @Component public class AppConfig1 { @Value("${app.demo.list1}") private List<String> l
SpringBoot读取.yml配置文件最常见的两种方式-源码及其在nacos的应用
小王博客基地
08-17 1532
我们在开发中会经常遇到一些可能会变的值，比如数据库的密码，一些关键链接的配置等等。都需要我们写在配置文件中，这样可以把这些配置文件放到nacos上进行管理，修改nacos的配置，咱们发布的包就可以动态的进行更新了，不需要重新修改打包在重新发包！咱们今天就来说一说读取配置文件中的值常见的两种方法，刚刚说的动态更新配置的是第二种配置哈！不会动态更新，所以小编推荐使用第二种方式进行读取配置文件！下面小编 也会带大家一起演示一下不需要重启项目就可以动态的更新，在生产上非常的好用！！！...
springboot通过配置文件获取yaml的配置值及其避坑点
gaoduicai的博客
11-15 1357
先说坑：配置完了之后不生效。 原因：直接new出来的对象，必须使用@autowire或者@resource出来才能自动装配上
Nacos系列——配置的创建与获取
qq_51553982的博客
12-18 2832
这里仅需要一个简单的SpringBoot工程即可，如果您下载了对应的资源，那么仅需要查看资源内部README文档进行对应修改即可，下面我们将从0构建Nacos-easy。如果我们增加新的配置只需要在yaml中进行修改即可，输出就会改变了。选择下载：Nacos-easy。
配置本地的application-dev.yml读取nacos上面的配置
weixin_42759398的博客
07-02 1930
在本地的application-dev.yml文件中，您可以使用Spring Cloud Nacos来读取Nacos上的配置。我想配置本地的application-dev.yml读取nacos上面的配置，我应该在配置文件里怎么写？希望这可以帮助您配置本地的application-dev.yml读取Nacos上的配置。如果您有任何进一步的疑问，请随时向我提问。这些属性的值在实际应用中可用，并正确地指向Nacos服务器和相关配置。通过以上配置，您的应用程序将从Nacos服务器上读取所需的配置信息。
nacos源码本地调试-通过代码获取获取nacos配置内容
spark_guo的专栏
01-28 2125
1、首先在nacos-example中新建一个test.java package com.alibaba.nacos.example; import com.alibaba.nacos.api.NacosFactory; import com.alibaba.nacos.api.PropertyKeyConst; import com.alibaba.nacos.api.config.ConfigService; import java.util.Properties; public class
NACOS配置，bootstrap.properties详解
半路出家的码农小王
04-05 2456
3、profile： 指定环境 文件名：${application.name}-${profile}.${file-extension}#1、只有上面的配置的时候他默认加载文件为：${application.name} nacos-config。#5、 自定义 group 配置，这里也可以设置为数据库配置组，中间件配置组，但是一般不用，#加载文件为：${application.name}.${file-extension}#nacos-config.yaml,不配置默认为properties文件。
springcloud gateway网关项目，整合nacos，通过yml/nacos/database三种配置路由
12-19
该项目是springcloud gateway网关项目，可以通过yml/nacos/database三种配置路由。已经网关端重新访问者身份，网关限流异常。建议大家采用nacos配置。并且把服务的路由，和其他api的路由分开配置。yml配置，如何api...
Nacos配置中心使用说明（图解）.docx
01-12
Nacos配置中心使用说明（图解）
Nacos配置中心原理分析
02-24
动态配置管理是Nacos的三大功能之一，通过动态配置服务，我们可以在所有环境中以集中和动态的方式管理所有应用程序或服务的配置信息。动态配置中心可以实现配置更新时无需重新部署应用程序和服务即可使相应的配置...
SpringCloud Alibaba - Nacos 作为配置中心 & 读取Yaml配置信息
z69183787的专栏
10-03 2669
过本系列的前篇文章： 《SpringCloud Alibaba - Nacos 作为配置中心 & 读取Properties配置信息》 在之前文章中我们学习到了SpringCloud Alibaba读取Nacos Config内定义的properties类型的配置文件信息，并且使用Nacos Console进行修改配置信息后可以在应用程序内实时更新。 本章目标 Nacos Config所支持的配置文件类型既然有多种，那我们该怎么配置才能读取不同的配置类型的内容呢？ 快速入门 我们还是先来通过
Nacos配置
xingfengsuiyu的博客
06-02 1798
spring cloud alibb nacos
Nacos 配置中心使用详解
zjn640322的博客
06-28 3912
nacos config配置中心使用详解
项目实践-SpringBoot实时获取Nacos配置文件内容（.yaml文件）
观云卷云舒的博客
06-15 8027
提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档 文章目录前言一、pandas是什么？二、使用步骤1.引入库2.读入数据总结 前言 提示：这里可以添加本文要记录的大概内容： 例如：随着人工智能的不断发展，机器学习这门技术也越来越重要，很多人都开启了学习机器学习，本文就介绍了机器学习的基础内容。 提示：以下是本篇文章正文内容，下面案例可供参考 一、pandas是什么？ 示例：pandas 是基于NumPy 的一种工具，该工具是为了解决数据分析任务而创建的。 二、使用步骤 1.引入库 代码
SpringBoot读取nacos配置yml文件
weixin_58698336的博客
07-18 3998
SpringBoot读取nacos配置yml文件
链表刷题集
最新发布
yajunjiao的专栏
04-30 904
本文主要列举了一些刷的题，不多，有那么几道，也建议各位去建立自己的刷题集。积少成多。
springboot nacos配置代替yml配置
05-23
是的，你可以使用 Nacos 作为配置中心，代替 Spring Boot 的默认配置文件（application.yml 或 application.properties）来管理应用程序的配置。这种方式可以提高配置的灵活性和可管理性，特别是在微服务架构中使用。 具体的步骤如下： 1. 在 Spring Boot 项目中引入 Nacos 的依赖： ```xml <dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId> <version>2.2.5.RELEASE</version> </dependency> ``` 2. 在 application.yml 中添加 Nacos 的配置信息： ```yaml spring: cloud: nacos: config: server-addr: ${NACOS_SERVER_ADDR:localhost:8848} namespace: ${NACOS_NAMESPACE:} group: ${NACOS_GROUP:DEFAULT_GROUP} ``` 其中，`server-addr` 是 Nacos 服务端的地址，`namespace` 是命名空间，`group` 是配置组名，默认为 `DEFAULT_GROUP`。 3. 在 Nacos 中创建配置信息： 在 Nacos 管理界面中创建一个配置信息，如下所示： ![nacos-config.png](https://cdn.jsdelivr.net/gh/smileArchitect/img-bed/blog/20210616172451.png) 其中，`data-id` 对应的是配置文件的名称，`group` 对应的是配置组名，`content` 对应的是配置文件的内容。 4. 在 Spring Boot 项目中使用 Nacos 的配置信息： 在代码中使用 `@Value` 注解来注入 Nacos 的配置信息，如下所示： ```java @RestController public class HelloController { @Value("${config.name}") private String name; @GetMapping("/hello") public String hello() { return "Hello " + name; } } ``` 其中，`${config.name}` 对应的是 Nacos 中配置的 `data-id`。 这样就可以使用 Nacos 作为配置中心来管理应用程序的配置了。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值