当前位置:首页 > 技术 > 正文内容

Java中YAML配置文件的高效读取方法

访客 技术 2026年6月21日 1

简介

在非Spring框架项目中处理YAML配置时,需要手动实现类似Spring Boot的配置加载功能。本文提供一个可主动指定环境的配置解析工具,解决静态代码块阶段无法获取配置的问题。

配置路径

支持解析变量占位符

Maven依赖

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

配置加载器

/**
 * 提供YAML文件解析及变量替换功能
 * @author config_tool
 * @version 1.0
 */
public class YamlConfigLoader {

    // 变量占位符正则
    private static final java.util.regex.Pattern VAR_PATTERN = java.util.regex.Pattern.compile("\\$\\{.*?\\}");

    private YamlConfigLoader() {
        throw new UnsupportedOperationException("工具类禁止实例化");
    }

    // 存储加载的配置文件
    private static final java.util.Map<String, java.util.Map<String, Object>> configMaps = new java.util.HashMap<>();
    // 当前线程配置文件标识
    private static final java.lang.ThreadLocal<String> currentConfigFile = new java.lang.InheritableThreadLocal<>();
    // 环境标识存储
    private static final java.lang.ThreadLocal<String> activeProfile = new java.lang.InheritableThreadLocal<>();

    /**
     * 设置当前环境标识
     * @param env 环境名称
     */
    public static void setEnvironment(String env) {
        activeProfile.set(env);
    }

    /**
     * 加载指定配置文件
     * @param fileName 配置文件路径
     */
    private static void loadConfig(String fileName) {
        currentConfigFile.set(fileName);
        if (!configMaps.containsKey(fileName)) {
            configMaps.put(fileName, new org.yaml.snakeyaml.Yaml().loadAs(
                YamlConfigLoader.class.getResourceAsStream("/" + fileName), 
                java.util.Map.class
            ));
        }
    }

    /**
     * 获取配置值并处理嵌套变量
     * @param key 配置键
     * @return 对象值
     */
    private static Object getVal(String key) {
        String[] parts = key.split("\\.");
        java.util.Map<String, Object> config = new java.util.HashMap<>(configMaps.get(currentConfigFile.get()));
        
        for (int i = 0; i < parts.length; i++) {
            Object val = config.get(parts[i]);
            if (i < parts.length - 1) {
                config = (java.util.Map<String, Object>) val;
            } else if (val == null) {
                throw new java.lang.IllegalArgumentException("配置项不存在: " + key);
            } else {
                String value = val.toString();
                java.util.regex.Matcher matcher = VAR_PATTERN.matcher(value);
                while (matcher.find()) {
                    String placeholder = matcher.group();
                    String varKey = placeholder.substring(2, placeholder.length() - 1);
                    String replacement = getVal(varKey).toString();
                    value = value.replace(placeholder, replacement);
                }
                return value;
            }
        }
        return null;
    }

    /**
     * 通过文件名和键获取配置值
     * @param fileName 配置文件名
     * @param key 配置键
     * @return 对象值
     */
    public static Object getVal(String fileName, String key) {
        loadConfig(fileName);
        return getVal(key);
    }

    /**
     * 获取环境标识
     * @return 环境名称
     */
    public static String getEnv() {
        if (activeProfile.get() == null) {
            String env = (String) getVal("application.yml", "spring.profiles.active");
            setEnvironment(env);
        }
        return activeProfile.get();
    }

    /**
     * 获取字符串类型配置值
     * @param fileName 配置文件名
     * @param key 配置键
     * @return 字符串值
     */
    public static String getString(String fileName, String key) {
        return (String) getVal(fileName, key);
    }

    /**
     * 获取默认配置文件的字符串值
     * @param key 配置键
     * @return 字符串值
     */
    public static String getDefaultString(String key) {
        return (String) getVal("application.yml", key);
    }

    /**
     * 获取环境特定配置文件的字符串值
     * @param key 配置键
     * @return 字符串值
     */
    public static String getEnvString(String key) {
        String fileName = "application-" + getEnv() + ".yml";
        return (String) getVal(fileName, key);
    }

    /**
     * 测试方法
     */
    public static void main(String[] args) {
        System.out.println(getEnv());
        System.out.println(getString("pulsar.topic", "application.yml"));
        System.out.println(getString("your-yaml-file-name.yml", "key1.key2"));
        System.out.println(getEnvString("Ignite-addr"));
        
        setEnvironment("test");
        System.out.println(getEnvString("Ignite-addr"));
    }
}
标签: SnakeYAML

相关文章

Linux crontab 详解

1) crontab 是什么cron 是 Linux 的定时任务守护进程;crontab 是用来编辑/查看“按时间周期执行命令”的表(cron table)。常见两类:用户 crontab:每个用户一份(crontab -e 编辑)系统级 crontab / cron.d:可指定执行用户(/etc/crontab、/etc/cron.d/*)2) crontab 时间...

富文本里可以允许的 HTML 属性

一、所有标签默认允许的安全属性(极少)class        (可选)id           (通常建议禁用)title️ 注意:id 容易被滥用做锚点注入,很多系统直接禁用class 允许的话最好只允许固定前缀(如 editor-*)二、a 标签允许属性<a href="" t...

Mac 安装 Node.js 指南

方法一:通过官网安装包(最简单,适合初学者)如果你只是想快速安装并开始使用,这是最直接的方法。访问 Node.js 官网。页面会显示两个版本:LTS (Recommended For Most Users):长期支持版,最稳定。建议选这个。Current:最新特性版,包含最新功能但可能不够稳定。下载 .pkg 安装包并运行。按照安装向导点击“下一步”即可完成。方法二:使用 Homebrew 安装(...

Dom\HTML_NO_DEFAULT_NS 的副作用:自动加闭合标签

在使用Dom\HTMLDocument时,Dom\HTML_NO_DEFAULT_NS 将禁止在解析过程中设置元素的命名空间, 此设置是为了与DOMDocument向后兼容而存在的。当使用它时,已知的一个副作用就是:自动加闭合标签例如 </img> 为什么会这样?当你使用:Dom\HTML_NO_DEFAULT_NS文档会变成 无命名空间模式,此时内部更接近 XML...

Laravel 事件和监听器创建

在 Laravel 中,使用 Artisan 命令创建 Events(事件) 和 Listeners(监听器) 是非常高效的。你可以通过以下几种方式来实现:1. 手动创建单个 Event如果你只想创建一个事件类,可以使用 make:event 命令:Bashphp artisan make:event UserRegistered执行后,文件将生成在 app/Even...

自定义域名解析神器 dnsmasq

什么是 dnsmasq?dnsmasq 是一个轻量级、功能强大的网络服务工具,专为小型和中等规模网络设计。它是一个综合的网络基础设施解决方案[1]。dnsmasq 能做什么?功能说明应用场景DNS 转发与缓存将 DNS 查询转发到上游服务器(ISP、Google DNS 等),并在本地缓存结果加快 DNS 查询速度,减少外部 DNS 流量本地 DNS解析本地网络设备的主机名,无需编辑&n...

发表评论

访客

◎欢迎参与讨论,请在这里发表您的看法和观点。