spring boot 读取yml配置

最新推荐文章于 2024-12-31 10:13:00 发布

shepherd_dirk

最新推荐文章于 2024-12-31 10:13:00 发布

阅读量224

点赞数

CC 4.0 BY-SA版权

分类专栏：后端框架 Java 文章标签： spring boot yml

本文链接：https://blog.youkuaiyun.com/shepherd_dirk/article/details/99731474

Java 同时被 2 个专栏收录

21 篇文章

订阅专栏

后端框架

12 篇文章

订阅专栏

本文分享了一个用于读取和解析SpringBoot项目中YAML配置文件的工具类，该工具类能够将YAML配置转换为Map集合，方便在项目中进行配置项的获取和使用。

spring boot 官方文档
spring boot官方文档推荐使用yml代替properties进行配置，自己写了个读取yml配置的工具类，分享一下

package com.dirk.commons.util;

import org.springframework.beans.factory.config.YamlMapFactoryBean;
import org.springframework.core.io.ClassPathResource;
import org.springframework.util.StringUtils;

import java.util.HashMap;
import java.util.Map;

/**
 * @author Dirk
 * @Description yaml配置工具类
 * @Date 2019-08-19 11:01
 */
public class YamlUtil {

    private static final String DEV = "dev";
    private static final String OS_LINUX = "linux";
    private static Map<String, Object> map = new HashMap<>();

    /**
     * 加载yaml配置转换为{@code Map<String, Object>}
     *
     * @param fileName
     * @return
     */
    private static Map<String, Object> loadYamlByFileName(String fileName) {
        YamlMapFactoryBean yaml = new YamlMapFactoryBean();
        yaml.setResources(new ClassPathResource(fileName));
        forEachYaml("", yaml.getObject());
        return map;
    }

    @SuppressWarnings({"unchecked"})
    private static void forEachYaml(String key, Map<String, Object> yaml) {
        if (yaml == null) {
            return;
        }
        yaml.forEach((s, o) -> {
            if (!StringUtils.isEmpty(key)) {
                s = key.concat(".").concat(s);
            }
            if (o instanceof Map) {
                forEachYaml(s, (Map<String, Object>) o);
            } else {
                map.put(s, o);
            }
        });
    }

    public static Object getObject(String key) {
        Map<String, Object> yaml = loadYamlByFileName("application.yml");
        String config = (String) yaml.get("spring.profiles.active");
        if (!StringUtils.isEmpty(config)) {
            String fileName = "application-".concat(config).concat(".yml");
            yaml.putAll(loadYamlByFileName(fileName));
        }
        return map.get(key);
    }

    /**
     * 获取yaml配置的值
     *
     * @param key key
     * @return value
     */
    public static String get(String key) {
        return (String) getObject(key);
    }

    /**
     * 是否是dev环境
     *
     * @return
     */
    public static Boolean isDev() {
        return DEV.equals(get("spring.profiles.active"));
    }

    /**
     * 是否是pro环境
     *
     * @return
     */
    public static Boolean isPro() {
        return !isDev();
    }

    /**
     * 是否是本地环境
     *
     * @return
     */
    public static Boolean isLocal() {
        String os = System.getProperty("os.name");
        return !os.toLowerCase().contains(OS_LINUX);
    }
}

参考

24. Externalized Configuration
yaml解析