Java代码修改yml配置文件属性

参考博客

问题背景

开发agent需要接受从服务端回传的Agent信息以及心跳回传周期，
客户端不能安装数据库，考虑存放在yml配置文件中通过代码动态修改参数。

需要导入的依赖

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

修改yml的工具类

package agent.utils;

import org.yaml.snakeyaml.DumperOptions;
import org.yaml.snakeyaml.Yaml;

import java.io.*;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Set;

/**
 * @author yichuan@iscas.ac.cn
 * 修改YmL文件的工具类
 * @version 1.0
 * @date 2020/11/14 17:01
 */
public class YmlUtil {
    private final static DumperOptions OPTIONS = new DumperOptions();

    private static File file;

    private static InputStream ymlInputSteam;

    private static Object CONFIG_MAP;

    private static Yaml yaml;

    static {
        //将默认读取的方式设置为块状读取
        OPTIONS.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK);
    }

    /**
     * 使用其他方法之前必须调用一次 设置yml的输出文件,当没有设置输入流时可以不设置输入流,默认以此文件读入
     *
     * @param file 输出的文件
     */
    public static void setYmlFile(File file) throws FileNotFoundException {
        YmlUtil.file = file;
        if (ymlInputSteam == null) {
            setYmlInputSteam(new FileInputStream(file));
        }
    }


    /**
     * 使用其他方法之前必须调用一次 设置yml的输入流
     *
     * @param inputSteam 输入流
     */
    public static void setYmlInputSteam(InputStream inputSteam) {
        ymlInputSteam = inputSteam;
        yaml = new Yaml(OPTIONS);
        CONFIG_MAP = yaml.load(ymlInputSteam);
    }

    /**
     * 根据键获取值
     *
     * @param key 键
     * @return 查询到的值
     */
    @SuppressWarnings("unchecked")
    public static Object getByKey(String key) {
        if (ymlInputSteam == null) {
            return null;
        }
        String[] keys = key.split("\\.");
        Object configMap = CONFIG_MAP;
        for (String s : keys) {
            if (configMap instanceof Map) {
                configMap = ((Map<String, Object>) configMap).get(s);
            } else {
                break;
            }
        }
        return configMap == null ? "" : configMap;
    }

    public static void saveOrUpdateByKey(String key, Object value) throws IOException {
        KeyAndMap keyAndMap = new KeyAndMap(key).invoke();
        key = keyAndMap.getKey();
        Map<String, Object> map = keyAndMap.getMap();
        map.put(key, value);
        //将数据重新写回文件
        yaml.dump(CONFIG_MAP, new FileWriter(file));
    }

    public static void removeByKey(String key) throws Exception {
        KeyAndMap keyAndMap = new KeyAndMap(key).invoke();
        key = keyAndMap.getKey();
        Map<String, Object> map = keyAndMap.getMap();
        Map<String, Object> fatherMap = keyAndMap.getFatherMap();
        map.remove(key);
        if (map.size() == 0) {
            Set<Map.Entry<String, Object>> entries = fatherMap.entrySet();
            for (Map.Entry<String, Object> entry : entries) {
                if (entry.getValue() == map) {
                    fatherMap.remove(entry.getKey());
                }
            }
        }
        yaml.dump(CONFIG_MAP, new FileWriter(file));
    }

    private static class KeyAndMap {
        private String key;
        private Map<String, Object> map;
        private Map<String, Object> fatherMap;

        public KeyAndMap(String key) {
            this.key = key;
        }

        public String getKey() {
            return key;
        }

        public Map<String, Object> getMap() {
            return map;
        }

        public Map<String, Object> getFatherMap() {
            return fatherMap;
        }

        @SuppressWarnings("unchecked")
        public KeyAndMap invoke() {
            if (file == null) {
                System.err.println("请设置文件路径");
            }
            if (null == CONFIG_MAP) {
                CONFIG_MAP = new LinkedHashMap<>();
            }
            String[] keys = key.split("\\.");
            key = keys[keys.length - 1];
            map = (Map<String, Object>) CONFIG_MAP;
            for (int i = 0; i < keys.length - 1; i++) {
                String s = keys[i];
                if (map.get(s) == null || !(map.get(s) instanceof Map)) {
                    map.put(s, new HashMap<>(4));
                }
                fatherMap = map;
                map = (Map<String, Object>) map.get(s);
            }
            return this;
        }
    }
}

测试类

import java.io.File;
import java.util.Objects;
/**
 * @author yichuan@iscas.ac.cn
 * yml编辑工具测试类
 * @version 1.0
 * @date 2020/11/14 17:11
 */
public class test {
    public static void main(String[] args) throws Exception {
        /**
         * 这里修改的是target目录编译后的路径，所以运行调试时。src目录下不会变
         */
        File yml = new File(Objects.requireNonNull(test.class.getClassLoader().getResource("application.yml")).toURI());
        //不管执行什么操作一定要先执行这个
        YmlUtil.setYmlFile(yml);
        System.out.println(YmlUtil.getByKey("修改前"+"heart.agentId"));
        System.out.println("aaaaaa");
        YmlUtil.saveOrUpdateByKey("heart.agentId", "哈哈哈哈");
        //YmlUtil.removeByKey("heart.agentId");
    }
}

这里要注意一个问题，修改的是target里面的配置文件，而不是src/resources里面的

存在的后续问题

项目是打成jar包运行，运行过程中会遇到java.lang.IllegalArgumentException: URI is not hierarchical的报错。
代码中使用的是File f = new File(this.getClass().getResource("路径/目录").toURI());读取该路径下所有文件，本来在代码环境下运行是正常的，可是后来打包后，在运行出现URI is not hierarchical 错误。
经过DEBUG发现，原来本地时，读取文件时，URI路径是：file:/E:/idea-workspace/project/module（jar包所在的module）/target/classes/package/路径或者目录，但是打包之后，同样是读取该路径下的所有文件，但是URI却变成了：jar:file:/E:/idea-workspace/project/module（war打包的模块）/target/war包名称/WEB-INF/lib/需要读取的包名称.jar!/路径或者是目录，从jar所在模块读取文件变成了从war中的lib下的打包好的jar中读取class文件，报错URI is not hierarchical 错误。

解决方法，将yml配置文件移到jar包外面

读取时直接写文件名即可

File yml = new File("application.yml");

获取参数时需要每次都刷新，采用读取文件，而不是注入后采用get

YmlUtil.setYmlFile(yml);
YmlUtil.getByKey();

修改运行时的参数

java -jar demo.jar --spring.config.location=路径（application.yml）

启动时修改yml配置

java -jar iscas-agent-1.0-SNAPSHOT.jar --spring.config.location=application.yml --heart.agentLocation=北京