深入解析：Snakeyaml

一、概述

Snakeyaml是一个Java库，用于在Java应用程序和YAML数据之间进行转换。它可以将YAML数据解析为Java对象，反之亦然。Snakeyaml的主要功能包括：

读取YAML文件并将其解析为Java对象
将Java对象转换为YAML格式，并输出到文件或输出流中
提供解析器和生成器来处理自定义对象

Snakeyaml易于使用，提供了JavaBean和Map之间的双向绑定，且对一些高级特性有良好的支持，如类型转换和引用。

二、解析YAML文件

使用Snakeyaml读取YAML文件时，应该按照以下步骤进行。

1. 基本使用


Yaml yaml = new Yaml();
InputStream inputStream = new FileInputStream(new File("example.yaml"));
Map obj = yaml.load(inputStream);

在该示例中，我们创建了一个Yaml对象，并使用FileInputStream读取了一个example.yaml文件。然后，我们调用load()方法将数据读取到一个Map对象中。

2. 自定义对象映射

Snakeyaml支持将YAML文件中的数据映射到自定义的Java对象中。要实现该功能，需要使用自定义JavaBean类，并在其中添加@YamlProperty注解，在注解中指定属性名。然后可以使用自定义的类作为泛型类型，解析YAML数据。


import org.yaml.snakeyaml.Yaml;
import org.yaml.snakeyaml.constructor.Constructor;
import org.yaml.snakeyaml.introspector.BeanAccess;
import org.yaml.snakeyaml.introspector.Property;
import org.yaml.snakeyaml.introspector.PropertyUtils;

import java.io.FileInputStream;
import java.util.Map;

public class Example {

    public static void main(String[] args) throws Exception {
        Yaml yaml = new Yaml(new Constructor(MyBean.class));

        FileInputStream fis = new FileInputStream("example.yaml");

        MyBean myBean = yaml.loadAs(fis, MyBean.class);

        System.out.println(myBean);
    }

    public static class MyBean {
        private String name;
        private int age;

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

        @Override
        public String toString() {
            return "MyBean{" +
                    "name='" + name + '\'' +
                    ", age=" + age +
                    '}';
        }
    }
}

该示例中使用了自定义的JavaBean类MyBean，并在其中添加了@YamlProperty标注。在解析器Yaml中使用Constructor构造方法指定使用MyBean类作为自定义对象类型。最后使用yaml.loadAs()方法将YAML数据解析为Java对象。

3. 引用解析

Snakeyaml支持解析YAML中的引用。引用是通过在文本中使用'&'或'*'标记来指定的。


# yaml文件
children:
  john: &john
    name: John
    age: 30
  jane: &jane
    name: Jane
    age: 25
  david:
    name: David
    age: 22
  friend1: *john
  friend2: *john


public class Example {
    public static void main(String[] args) throws Exception {
        Yaml yaml = new Yaml();

        FileInputStream fis = new FileInputStream("example.yaml");

        Map<String, Object> map = yaml.load(fis);

        System.out.println(map.get("children"));
    }
}

在该示例中，使用了YAML编写了一个包含引用标记的YAML文件。在解析时，我们可以使用Map对象接收解析出的YAML数据。其中，&john和&jane是引用标记，*john和*jane则是引用的使用。

三、生成YAML文件

使用Snakeyaml生成YAML文件时，应该按照以下步骤进行。

1. 基本使用


Yaml yaml = new Yaml();

Map<String, Object> map = new HashMap<>();
map.put("name", "John");
map.put("age", 30);

FileWriter writer = new FileWriter(new File("example.yaml"));
yaml.dump(map, writer);
writer.close();

在该示例中，我们创建了一个Yaml对象，并将数据填充到一个Map对象中，然后使用FileWriter将生成的YAML数据输出到文件。

2. 使用字符串输出


Yaml yaml = new Yaml();

Map<String, Object> map = new HashMap<>();
map.put("name", "John");
map.put("age", 30);

StringWriter writer = new StringWriter();
yaml.dump(map, writer);
String output = writer.toString();
writer.close();

与输出到文件类似，可以使用StringWriter将生成的YAML数据输出到内存中的字符串。

3. 自定义对象生成

Snakeyaml也支持自定义对象生成。实现该功能，同样需要在自定义JavaBean类中添加@YamlProperty注解，并在注解中指定属性名。然后可以使用自定义的JavaBean对象作为生成目标。


import org.yaml.snakeyaml.Yaml;
import org.yaml.snakeyaml.introspector.BeanAccess;
import org.yaml.snakeyaml.introspector.Property;
import org.yaml.snakeyaml.introspector.PropertyUtils;

import java.io.FileWriter;
import java.util.HashMap;
import java.util.Map;

public class Example {

    public static void main(String[] args) throws Exception {
        Yaml yaml = new Yaml();
        yaml.setBeanAccess(BeanAccess.FIELD);

        MyBean myBean = new MyBean();
        myBean.name = "John";
        myBean.age = 30;

        FileWriter fw = new FileWriter("example.yaml");
        yaml.dump(myBean, fw);
        fw.close();
    }

    public static class MyBean {
        @YamlProperty("name")
        private String name;

        @YamlProperty("age")
        private int age;

        @Override
        public String toString() {
            return "MyBean{" +
                    "name='" + name + '\'' +
                    ", age=" + age +
                    '}';
        }
    }
}

在该示例中，定义了一个自定义的JavaBean类MyBean，并在其中添加了@YamlProperty注解。然后，使用FileWriter将生成的YAML数据输出到文件中。

四、其他功能

1. 特殊字符处理

Snakeyaml默认支持处理特殊字符，如\t，\n等。在读写过程中，会将这些特殊字符进行转义。不过，Snakeyaml也提供了配置选项，可以关闭这些特殊字符的处理。


Yaml yaml = new Yaml();
yaml.setEscapeGame(true);

2. 设置属性

Snakeyaml也提供了一些属性配置选项，可以对解析器或生成器进行配置。


Yaml yaml = new Yaml();
yaml.setBeanAccess(BeanAccess.FIELD);
// 设置可重复键
yaml.setAllowDuplicateKeys(false);
// 映射时忽略不存在的属性
yaml.setPropertyUtils(new PropertyUtils() {
    @Override
    public Property getProperty(Class type, String name) {
        return isReadableProperty(type, name) ? super.getProperty(type, name) : null;
    }
});

3. 自定义类型转换器

Snakeyaml提供了一个TypeDescription类，可以方便地定义自定义类型转换器。首先需要创建一个JavaBean类，然后使用PropertyUtils创建一个TypeDescription对象，将JavaBean类注册到解析器中。


public class Example {
    public static void main(String[] args) throws Exception {
        Yaml yaml = new Yaml();

        PropertyUtils pUtil = new PropertyUtils();
        TypeDescription tDesc = new TypeDescription(MyBean.class);
        tDesc.addPropertyParameters("map", Map.class, String.class, String.class);
        pUtil.addTypeDescription(tDesc);
        yaml.setPropertyUtils(pUtil);

        FileInputStream fis = new FileInputStream("example.yaml");

        MyBean myBean = yaml.loadAs(fis, MyBean.class);

        System.out.println(myBean);
    }

    static class MyBean {
        Map<String, String> map;

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

        public void setMap(Map<String, String> map) {
            this.map = map;
        }

        @Override
        public String toString() {
            return "MyBean{" +
                    "map=" + map +
                    '}';
        }
    }
}

该示例中，我们定义了一个自定义的JavaBean类MyBean，并注册到解析器中。在这个JavaBean类中，添加了一个Map类型的属性，将属性映射为一个键值对的Map对象。最后，使用yaml.loadAs()方法将YAML数据解析为Java对象。

4. 使用JVM Anchor

JVM Anchor是一个Java库，可以在Java中实现YAML中的锚点和别名功能。


Yaml yaml = new Yaml(new SafeConstructor());
yaml.addTypeDescription(new TypeDescription(MyClass.class));
yaml.setBeanAccess(BeanAccess.FIELD);

String input = "&car { model: 'BMW', year: 2019 }\n" +
        "&driver { name: 'John', car: *car }";
MyClass myObj = yaml.loadAs(input, MyClass.class);

System.out.println(myObj.getDriver().getName());
System.out.println(myObj.getDriver().getCar().getModel());

该示例演示了JVM Anchor的使用方法。在这个示例中，我们建立了一个锚点标记为&car和&driver。然后在Java类MyClass中定义了一个Driver子类，该子类引用了锚点标记。在解析时，Snakeyaml将锚点标记&car解析为一个对象，并将其设置为驾驶员属性Driver中的汽车对象Car。最后，将解析结果输出到控制台。

五、总结

Snakeyaml是一个强大的Java库，支持YAML文件与Java对象之间的转换。它可以解析YAML文件并转换为Java对象，并且也可以将Java对象转换为YAML格式。Snakeyaml在处理特殊字符、自定义对象、引用等方面都有良好的支持，非常方便易用。同时，可以通过自定义类型转换器、使用JVM Anchor等高级特性，扩展Snakeyaml的功能。

原创文章，作者：小蓝，如若转载，请注明出处：https://www.506064.com/n/236577.html

深入解析：Snakeyaml

一、概述

二、解析YAML文件

1. 基本使用

2. 自定义对象映射

3. 引用解析

三、生成YAML文件

1. 基本使用

2. 使用字符串输出

3. 自定义对象生成

四、其他功能

1. 特殊字符处理

2. 设置属性

3. 自定义类型转换器

4. 使用JVM Anchor

五、总结

相关推荐

发表回复