snakeyaml自定义pojo写入yml文件时属性字段排序问题

Posted 2023-03-04 luffy5459

    snakeyaml采用LinkedHashMap保存对象，最后写入yml文件的时候，可以按照存入的顺序写入yml，如果采用自定义pojo，虽然可以写入yml，但是属性默认是按照字母顺序进行写入的。

    如下所示，定义一个User实体，给定四个属性:id,name,age,email。

package com.yaml;
public class User 
    private int id;
    private String name;
    private int age;
    private String email;

    public int getId() 
        return id;
    

    public void setId(int id) 
        this.id = id;
    

    public String getName() 
        return name;
    

    public void setName(String name) 
        this.name = name;
    

    public int getAge() 
        return age;
    

    public void setAge(int age) 
        this.age = age;
    

    public String getEmail() 
        return email;
    

    public void setEmail(String email) 
        this.email = email;
    

    保存

package com.yaml;

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

import java.io.StringWriter;

public class PojoWriteExample 
    public static void main(String[] args) 
        DumperOptions options = new DumperOptions();
        options.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK);
        options.setIndentWithIndicator(true);
        options.setIndicatorIndent(2);
        Yaml yaml = new Yaml(options);
        User user = new User();
        user.setId(1);
        user.setName("buejee");
        user.setAge(18);
        user.setEmail("[e-mail]");
        StringWriter sw = new StringWriter();
        String res =  yaml.dumpAs(user, Tag.MAP, null);
        sw.append(res);
        sw.flush();
        System.out.println(res);
    

    运行结果：

 

     这个自定义pojo，按照字母排序就有一点遗憾了，虽然结构不会有问题，而且最后解析也不会有问题，但是强迫症的人就受不了。

    如下所示，这是网上的一个解决办法。

 java - How to order nodes in YAML with SnakeYaml? - Stack Overflow

   大致意思是自定义一个Representer，修改PropertyUtils

import java.util.LinkedHashSet;
import java.util.Set;
import java.util.stream.Collectors;

import org.yaml.snakeyaml.introspector.*;
import org.yaml.snakeyaml.nodes.*;
import org.yaml.snakeyaml.representer.Representer;

public class CustomRepresenter extends Representer 

  public CustomRepresenter() 
    super();
    PropertyUtils propUtil = new PropertyUtils() 
      @Override
      protected Set<Property> createPropertySet(Class<? extends Object> type, BeanAccess bAccess) 
        return getPropertiesMap(type, bAccess).values().stream().sequential()
            .filter(prop -> prop.isReadable() && (isAllowReadOnlyProperties() || prop.isWritable()))
            .collect(Collectors.toCollection(LinkedHashSet::new));
      
    ;
    setPropertyUtils(propUtil);
  

    我们拷贝这个代码，加入我们的代码中:

CustomRepresenter customRepresenter = new CustomRepresenter();
Yaml yaml = new Yaml(customRepresenter, options);

     运行代码，结果如下：

 

    似乎没有改进，这是因为在修改PropertyUtils中，getPropertiesMap(type,bAccess)这个方法，最终得到的结果还是一个按照字母顺序排列的集合，需要让代码生效，我们需要改进。

getPropertiesMap(type, BeanAccess.FIELD)

    更改之后，再运行代码： 

    完美解决pojo写入yml时属性排序问题。 

    同样的，这个自定义Representer里面还可以添加其他生成器，比如空值，双引号生成器。