snakeyaml开源库,可以很方便的加载和生成yaml文件,普通的加载,其实springboot项目都可以实现,在生成yaml文件的时候,有几个问题需要注意,第一个是格式问题,另外一个就是空值问题。
使用snakeyaml库需要加入如下依赖:
<dependency>
<groupId>org.yaml</groupId>
<artifactId>snakeyaml</artifactId>
<version>1.30</version>
</dependency>
如下所示,默认yaml格式,集合显示带有中括号。
package com.yaml;
import org.yaml.snakeyaml.Yaml;
import java.io.StringWriter;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
public class YamlTest {
public static void main(String[] args) {
Map<String,Object> map = new HashMap<>(){
{
put("name","buejee");
put("age",18);
put("email",null);
put("company","");
put("language", Arrays.asList("java","python","cplusplus"));
}
};
Yaml yaml = new Yaml();
StringWriter writer = new StringWriter();
yaml.dump(map,writer);
System.out.println(writer.toString());
}
}
打印结果:
这个结果有一个很明显的问题,就是集合没有按照预期的格式展示,我们希望展示如下所示:
name: buejee
company: ''
language:
- java
- python
- cplusplus
age: 18
email: null
我们需要通过DumperOptions来设置yaml文件流格式,这里设置块级显示。
DumperOptions options = new DumperOptions();
options.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK);
Yaml yaml = new Yaml(options);
这样之后,显示稍微好一点:
但是缩进不是很理想,这里我们设置缩进:
options.setIndentWithIndicator(true);
options.setIndicatorIndent(2);
这样,显示好多了:
这里面,还是有两个问题,空字符"",显示为'',null值显示为了null,其实我们希望null显示空。经过摸索,发现可以通过自定义Representer来达到显示为空的效果。
package com.yaml;
import org.yaml.snakeyaml.nodes.Node;
import org.yaml.snakeyaml.nodes.Tag;
import org.yaml.snakeyaml.representer.Represent;
import org.yaml.snakeyaml.representer.Representer;
public class RepresenterNull extends Representer {
public RepresenterNull(){
super();
this.nullRepresenter = new NullRepresenter();
}
private class NullRepresenter implements Represent{
@Override
public Node representData(Object o) {
return representScalar(Tag.NULL,"");
}
}
}
在实例化Yaml的时候,传入RepresenterNull实例。
Yaml yaml = new Yaml(new RepresenterNull(),options);
展示效果:
不过,对于字符串=""的情况,并没有转为空,但是我们可以在赋值的时候判断,如果equals(""),那么就赋值null也可以。
这里改变输出到文件:
FileWriter writer = new FileWriter(new File("test.yaml"));
yaml.dump(map,writer);
最后生成的yaml文件如下所示:
完整代码:
package com.yaml;
import org.yaml.snakeyaml.DumperOptions;
import org.yaml.snakeyaml.Yaml;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.StringWriter;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
public class YamlTest {
public static void main(String[] args) throws IOException {
Map<String,Object> map = new HashMap<>(){
{
put("name","buejee");
put("age",18);
put("email",null);
put("company",null);
put("language", Arrays.asList("java","python","cplusplus"));
}
};
DumperOptions options = new DumperOptions();
options.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK);
options.setIndentWithIndicator(true);
options.setIndicatorIndent(2);
Yaml yaml = new Yaml(new RepresenterNull(),options);
//StringWriter writer = new StringWriter();
//yaml.dump(map,writer);
//System.out.println(writer.toString());
FileWriter writer = new FileWriter(new File("test.yaml"));
yaml.dump(map,writer);
}
}
snakeyaml生成yaml文件,设置块级格式,自定义空值显示就介绍完了。让我最高兴的就是空值显示问题的解决,因为在工作中正好用到了,特此记录一下。