通過JAVA程式碼對yaml檔案進行增加、修改的操作

阿新 • • 發佈：2020-09-02

近期有個需求，需要通過java程式碼對yaml檔案進行修改或新增，對pom.xml檔案進行新增依賴或者刪除依賴。

首先介紹對yaml檔案的操作：

1.需要引入jar包：

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

2.在class檔案中，需要新增一下屬性：

private static DumperOptions dumperOptions = new DumperOptions();
static{
    //設定yaml讀取方式為塊讀取
    dumperOptions.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK);
    dumperOptions.setDefaultScalarStyle(DumperOptions.ScalarStyle.PLAIN);
    dumperOptions.setPrettyFlow(false);
}

具體作用是為了生成出的yaml格式（詳細作用可百度），注意：該方法相當於重新生成yaml檔案，原yaml檔案中的註釋會消失，暫未找到解決方法。

update方法：

public boolean updateYaml(String url, String paramKey, Object paramValue) {
Yaml yaml = new Yaml(dumperOptions);
//yaml檔案路徑
String yamlUr = url + yamlUrl;
Map map = null;
try {
    //將yaml檔案載入為map格式
    map = yaml.loadAs(new FileInputStream(yamlUr), Map.class);
} catch (FileNotFoundException e) {
    e.printStackTrace();
}
//獲取當前引數值並且修改
boolean flag = updateYaml(paramKey, paramValue, map, yamlUr, yaml);
return flag;
}

/**
 * 修改yaml中屬性的值
 *
 * @param key      key是properties的方式： aaa.bbb.ccc (key不存在不修改)
 * @param value    新的屬性值 （新屬性值和舊屬性值一樣，不修改）
 * @param yamlToMap map結構
 * @param path 路徑
 * @return true 修改成功，false 修改失敗。
 */
public boolean updateYaml(String key, Object value, Map<String, Object> yamlToMap, String path, Yaml yaml) {
    Object oldVal = getValue(key, yamlToMap);
    //未找到key 不修改
    if (null == oldVal) {
        return false;
    }

    try {
        Map<String, 
 Object> resultMap = setValue(yamlToMap, key, value);
        if (resultMap != null) {
            yaml.dump(resultMap, new FileWriter(path));
            return true;
        } else {
            return false;
        }
    } catch (Exception e) {
        System.out.println("yaml file update failed !");
    }
    return false;
}

/**
 * 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;
    }
}

/**
 * 修改yaml中的屬性值
 */
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檔案進行新增方法：

public boolean insertYaml(String key, Object value, Map<String, Object> yamlToMap, String path) {

    Yaml yaml = new Yaml(dumperOptions);
    String[] keys = key.split("\\.");

    int len = keys.length;
    Map temp = yamlToMap;

    for (int i = 0; i < len; i++) {
        if (temp.containsKey(keys[i])) {
            temp = (Map) temp.get(keys[i]);
        } else {
            //該處對yaml的層級需要有判斷，可能有問題
            if(i + 2 == len){
                Map<String, Object> newMap = new HashMap<>();
                newMap.put(keys[len-1],value);
                temp.put(keys[i],newMap);
                break;
            }else {
                temp.put(keys[i], value);
                break;
            }
        }
    }
    try {
        yaml.dump(yamlToMap, new FileWriter(path));
    } catch (Exception e) {
        System.out.println("yaml file insert failed !");
        return false;
    }
    return true;
}

對yaml檔案中的欄位進行刪除同樣可以做到，具體功能沒有實現。