使用Java对yaml和properties互转，保证顺序、实测无BUG版本

原创

已于 2024-08-01 15:22:10 修改 · 3.2k 阅读

16 ·

CC 4.0 BY-SA版权

本文为博主原创文章，转载无需注明出处。水平有限，错误百出，望谨慎转载

文章标签：

#java

于 2023-11-29 10:42:34 首次发布

本文介绍了一种使用Java实现的YAML和Properties格式文件互转的方法，解决了转换过程中常见的顺序错乱和子节点遗漏问题。通过优化，确保了转换后的文件保持原有顺序，并完整保留所有节点信息。适用于需要在不同配置格式间进行灵活转换的场景。

使用Java对yaml和properties互转

代码图片生成工具：有码高清

一、前言

浏览了一圈网上的版本，大多存在以下问题：

转换后顺序错乱
遗漏子节点

基于此进行了优化，如果只是想直接转换，可直接使用我发布的在线版本
在这里插入图片描述

如果想在工程中使用，可继续往下看，源码在文末。

1.1 顺序错乱的原因

大部分代码都是使用了 java.util.Properties 类来转换，这个类是基于 ConcurrentHashMap 来存储键值对的，必然会顺序错乱

这是截取的 Properties 类的部分源码：

/**
  * Properties does not store values in its inherited Hashtable, but instead
  * in an internal ConcurrentHashMap.  Synchronization is omitted from
  * simple read operations.  Writes and bulk operations remain synchronized,
  * as in Hashtable.
  */
private transient volatile ConcurrentHashMap<Object, Object> map;

/**
     * Creates an empty property list with the specified defaults.
     *
     * @implNote The initial capacity of a {@code Properties} object created
     * with this constructor is unspecified.
     *
     * @param   defaults   the defaults.
     */
public Properties(Properties defaults) {
   
   
    this(defaults, 8);
}

private Properties(Properties defaults, int initialCapacity) {
   
   
    // use package-private constructor to
    // initialize unused fields with dummy values
    super((Void) null);
    map = new ConcurrentHashMap<>(initialCapacity);
    this.defaults = defaults;

    // Ensure writes can't be reordered
    UNSAFE.storeFence();
}

1.2 遗漏子节点的原因

主要还是代码不够严谨，解析的时候没有判断子节点是否是数组或对象，粗暴的转为 String 直接赋值了

二、优化措施

基于 LinkedHashMap 来存储键值对
递归遍历时判断子节点类型，不同类型采用不同的处理方式

三、源码

在这里插入图片描述

import cn.hutool.core.collection.CollUtil;
import cn.hutool.core.util.StrUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.util.CollectionUtils;
import org.yaml.snakeyaml.Yaml;

import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * @author Deng.Weiping
 * @since 2023/11/28 13:57
 */
@Slf4j
public class PropertiesUtil {
   
   

    /**
     * yaml 转 Properties
     *
     * @param input
     * @return
     */
    public static String castToProperties(String input) {
   
   
        Map<String, Object> propertiesMap = new LinkedHashMap<>();
        Map<String, Object> yamlMap = new Yaml().load(input);
        flattenMap("", yamlMap, propertiesMap);
        StringBuffer strBuff = new StringBuffer();
        propertiesMap.forEach((key, value) -> strBuff.append(key)
                .append("=")
                .append(value)
                .append(StrUtil.LF));
        return strBuff.toString();
    }

    /**
     * Properties 转 Yaml
     *
     * @param input
     * @return
     */
    public