• JAVA使用SnakeYAML解析与序列化YAML


    1.概述

    本文,我们将学习如何使用SnakeYAML库将
    YAML文档转换为Java对象,以及JAVA对象如何序列化为YAML文档

    2.项目设置

    要在项目中使用SnakeYAML,需要添加Maven依赖

    1. <dependency>
    2. <groupId>org.yaml</groupId>
    3. <artifactId>snakeyaml</artifactId>
    4. <version>1.25</version>
    5. </dependency>

    3.入口点

    YAML类是API的入口点:

    1. Yaml yaml = new Yaml()

    由于实现不是线程安全的,因此不同的线程必须具有自己的Yaml实例。

    4.加载YAML文档

    SnakeYAML支持从StringInputStream加载文档,我们从定义一个简单的YAML文档开始,然后将文件命名为customer.yaml

    1. firstName: "John"
    2. lastName: "Doe"
    3. age: 20

    4.1 基本用法

    现在,我们将使用Yaml类来解析上述YAML文档:

    1. Yaml yaml = new Yaml();
    2. InputStream inputStream = this.getClass()
    3. .getClassLoader()
    4. .getResourceAsStream("customer.yaml");
    5. Map<String, Object> obj = yaml.load(inputStream);
    6. System.out.println(obj);

    上面的代码生成以下输出:

    1. {firstName=John, lastName=Doe, age=20}

    默认情况下,load()方法返回一个Map对象。查询Map对象时,我们需要事先知道属性键的名称,否则容易出错。更好的办法是自定义类型。

    4.2 自定义类型解析

    SnakeYAML提供了一种将文档解析为自定义类型的方法

    让我们定义一个Customer类,然后尝试再次加载该文档:

    1. public class Customer {
    2. private String firstName;
    3. private String lastName;
    4. private int age;
    5. // getters and setters
    6. }

    现在我么来加载:

    1. Yaml yaml = new Yaml();
    2. InputStream inputStream = this.getClass()
    3. .getClassLoader()
    4. .getResourceAsStream("customer.yaml");
    5. Customer customer = yaml.load(inputStream);

    还有一种方法是使用Constructor:

    1. Yaml yaml = new Yaml(new Constructor(Customer.class));

    4.3 隐式类型

    如果没有为给定属性定义类型,则库会自动将值转换为隐式type

    例如:

    1. 1.0 -> Float
    2. 42 -> Integer
    3. 2009-03-30 -> Date

    让我们使用一个TestCase来测试这种隐式类型转换:

    1. @Test
    2. public void whenLoadYAML_thenLoadCorrectImplicitTypes() {
    3. Yaml yaml = new Yaml();
    4. Map<Object, Object> document = yaml.load("3.0: 2022-8-17");
    5. assertNotNull(document);
    6. assertEquals(1, document.size());
    7. assertTrue(document.containsKey(3.0d));
    8. }

    4.4 嵌套对象

    SnakeYAML 支持嵌套的复杂类型。

    让我们向“ customer.yaml”添加“ 联系方式” 和“ 地址”详细信息并将新文件另存为customer_with_contact_details_and_address.yaml.

    现在,我们将分析新的YAML文档:

    1. firstName: "John"
    2. lastName: "Doe"
    3. age: 31
    4. contactDetails:
    5. - type: "mobile"
    6. number: 123456789
    7. - type: "landline"
    8. number: 456786868
    9. homeAddress:
    10. line: "Xyz, DEF Street"
    11. city: "City Y"
    12. state: "State Y"
    13. zip: 345657

    我们来更新java类:

    1. public class Customer {
    2. private String firstName;
    3. private String lastName;
    4. private int age;
    5. private List<Contact> contactDetails;
    6. private Address homeAddress;
    7. // getters and setters
    8. }
    9. public class Contact {
    10. private String type;
    11. private int number;
    12. // getters and setters
    13. }
    14. public class Address {
    15. private String line;
    16. private String city;
    17. private String state;
    18. private Integer zip;
    19. // getters and setters
    20. }

    现在,我们来测试下Yamlload()

    1. @Test
    2. public void
    3. whenLoadYAMLDocumentWithTopLevelClass_thenLoadCorrectJavaObjectWithNestedObjects() {
    4. Yaml yaml = new Yaml(new Constructor(Customer.class));
    5. InputStream inputStream = this.getClass()
    6. .getClassLoader()
    7. .getResourceAsStream("yaml/customer_with_contact_details_and_address.yaml");
    8. Customer customer = yaml.load(inputStream);
    9. assertNotNull(customer);
    10. assertEquals("John", customer.getFirstName());
    11. assertEquals("Doe", customer.getLastName());
    12. assertEquals(31, customer.getAge());
    13. assertNotNull(customer.getContactDetails());
    14. assertEquals(2, customer.getContactDetails().size());
    15. assertEquals("mobile", customer.getContactDetails()
    16. .get(0)
    17. .getType());
    18. assertEquals(123456789, customer.getContactDetails()
    19. .get(0)
    20. .getNumber());
    21. assertEquals("landline", customer.getContactDetails()
    22. .get(1)
    23. .getType());
    24. assertEquals(456786868, customer.getContactDetails()
    25. .get(1)
    26. .getNumber());
    27. assertNotNull(customer.getHomeAddress());
    28. assertEquals("Xyz, DEF Street", customer.getHomeAddress()
    29. .getLine());
    30. }

    4.5 类型安全的集合

    当给定Java类的一个或多个属性是泛型集合类时,需要通过TypeDescription来指定泛型类型,以以便可以正确解析。

    让我们假设一个 一个Customer拥有多个Contact

    1. firstName: "John"
    2. lastName: "Doe"
    3. age: 31
    4. contactDetails:
    5. - { type: "mobile", number: 123456789}
    6. - { type: "landline", number: 123456789}

    为了能正确解析,我们可以在顶级类上为给定属性指定TypeDescription :

    1. Constructor constructor = new Constructor(Customer.class);
    2. TypeDescription customTypeDescription = new TypeDescription(Customer.class);
    3. customTypeDescription.addPropertyParameters("contactDetails", Contact.class);
    4. constructor.addTypeDescription(customTypeDescription);
    5. Yaml yaml = new Yaml(constructor);

    4.6 载入多个文件

    在某些情况下,单个文件中可能有多个YAML文档,而我们想解析所有文档。所述YAML类提供了一个LOADALL()方法来完成这种类型的解析。

    假设下面的内容在一个文件中:

    1. ---
    2. firstName: "John"
    3. lastName: "Doe"
    4. age: 20
    5. ---
    6. firstName: "Jack"
    7. lastName: "Jones"
    8. age: 25

    我们可以使用loadAll()方法解析以上内容,如以下代码示例所示:

    1. @Test
    2. public void whenLoadMultipleYAMLDocuments_thenLoadCorrectJavaObjects() {
    3. Yaml yaml = new Yaml(new Constructor(Customer.class));
    4. InputStream inputStream = this.getClass()
    5. .getClassLoader()
    6. .getResourceAsStream("yaml/customers.yaml");
    7. int count = 0;
    8. for (Object object : yaml.loadAll(inputStream)) {
    9. count++;
    10. assertTrue(object instanceof Customer);
    11. }
    12. assertEquals(2,count);
    13. }

    5.生成YAML文件

    SnakeYAML 支持 将java对象序列化为yml。

    5.1 基本用法

    我们将从一个将Map 的实例转储到YAML文档(String)的简单示例开始:

    1. @Test
    2. public void whenDumpMap_thenGenerateCorrectYAML() {
    3. Map<String, Object> data = new LinkedHashMap<String, Object>();
    4. data.put("name", "Silenthand Olleander");
    5. data.put("race", "Human");
    6. data.put("traits", new String[] { "ONE_HAND", "ONE_EYE" });
    7. Yaml yaml = new Yaml();
    8. StringWriter writer = new StringWriter();
    9. yaml.dump(data, writer);
    10. String expectedYaml = "name: Silenthand Olleander\nrace: Human\ntraits: [ONE_HAND, ONE_EYE]\n";
    11. assertEquals(expectedYaml, writer.toString());
    12. }

    上面的代码产生以下输出(请注意,使用LinkedHashMap的实例将保留输出数据的顺序):

    1. name: Silenthand Olleander
    2. race: Human
    3. traits: [ONE_HAND, ONE_EYE]

    5.2 自定义Java对象

    我们还可以选择将自定义Java类型转储到输出流中

    1. @Test
    2. public void whenDumpACustomType_thenGenerateCorrectYAML() {
    3. Customer customer = new Customer();
    4. customer.setAge(45);
    5. customer.setFirstName("Greg");
    6. customer.setLastName("McDowell");
    7. Yaml yaml = new Yaml();
    8. StringWriter writer = new StringWriter();
    9. yaml.dump(customer, writer);
    10. String expectedYaml = "!!com.baeldung.snakeyaml.Customer {age: 45, contactDetails: null, firstName: Greg,\n homeAddress: null, lastName: McDowell}\n";
    11. assertEquals(expectedYaml, writer.toString());
    12. }

    生成内容会包含!!com.baeldung.snakeyaml.Customer,为了避免在输出文件中使用标签名,我们可以使用库提供的 dumpAs()方法。

    因此,在上面的代码中,我们可以进行以下调整以删除标记:

    yaml.dumpAs(customer, Tag.MAP, null);
    
  • 相关阅读:
    中国智慧城市研究战略及十四五规划分析报告2022-2028年新版
    双碳目标下:农田温室气体排放模拟
    js中this的原理详解(web前端开发javascript语法基础)
    钟汉良日记:改变心态了,回武平待3年
    深度学习基础-优化算法详解
    Python+Appium实现自动化测试的使用步骤
    Git安装、原理、常用命令、版本控制、如何上传普通文件到仓库以及如何修改IDEA中Terminal为git窗口
    Qt读写Excel--QXlsx工作表显示/隐藏状态设置4
    C现代方法(第9章)笔记——函数
    什么是神经网络?用代码示例解析其工作原理
  • 原文地址:https://blog.csdn.net/Java_ttcd/article/details/126403992