JAVA基于SnakeYAML實(shí)現(xiàn)解析與序列化YAML

更新時(shí)間：2019年12月20日 08:33:38 作者：JadePeng

這篇文章主要介紹了JAVA基于SnakeYAML實(shí)現(xiàn)解析與序列化YAML,文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下

1.概述

本文，我們將學(xué)習(xí)如何使用SnakeYAML庫(kù)將

YAML文檔轉(zhuǎn)換為Java對(duì)象，以及JAVA對(duì)象如何序列化為YAML文檔。

2.項(xiàng)目設(shè)置

要在項(xiàng)目中使用SnakeYAML，需要添加Maven依賴項(xiàng)（可在此處找到最新版本）：

<dependency>
  <groupId>org.yaml</groupId>
  <artifactId>snakeyaml</artifactId>
  <version>1.25</version>
</dependency>

3.入口點(diǎn)

該YAML類是API的入口點(diǎn)：

Yaml yaml = new Yaml()

由于實(shí)現(xiàn)不是線程安全的，因此不同的線程必須具有自己的Yaml實(shí)例。

4.加載YAML文檔

SnakeYAML支持從String或InputStream加載文檔，我們從定義一個(gè)簡(jiǎn)單的YAML文檔開始，然后將文件命名為customer.yaml：

firstName: "John"
lastName: "Doe"
age: 20

4.1基本用法

現(xiàn)在，我們將使用Yaml類來解析上述YAML文檔：

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

上面的代碼生成以下輸出：

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

默認(rèn)情況下，load（）方法返回一個(gè)Map對(duì)象。查詢Map對(duì)象時(shí)，我們需要事先知道屬性鍵的名稱，否則容易出錯(cuò)。更好的辦法是自定義類型。

4.2自定義類型解析

SnakeYAML提供了一種將文檔解析為自定義類型的方法

讓我們定義一個(gè)Customer類，然后嘗試再次加載該文檔：

public class Customer {
 
  private String firstName;
  private String lastName;
  private int age;
 
  // getters and setters
}

現(xiàn)在我么來加載：

Yaml yaml = new Yaml();
InputStream inputStream = this.getClass()
 .getClassLoader()
 .getResourceAsStream("customer.yaml");
Customer customer = yaml.load(inputStream);

還有一種方法是使用Constructor：

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

4.3隱式類型

如果沒有為給定屬性定義類型，則庫(kù)會(huì)自動(dòng)將值轉(zhuǎn)換為隱式type。

例如：

1.0 -> Float
42 -> Integer
2009-03-30 -> Date

讓我們使用一個(gè)TestCase來測(cè)試這種隱式類型轉(zhuǎn)換：

@Test
public void whenLoadYAML_thenLoadCorrectImplicitTypes() {
  Yaml yaml = new Yaml();
  Map<Object, Object> document = yaml.load("3.0: 2018-07-22");
 
  assertNotNull(document);
  assertEquals(1, document.size());
  assertTrue(document.containsKey(3.0d));  
}

4.4 嵌套對(duì)象

SnakeYAML 支持嵌套的復(fù)雜類型。

讓我們向“ customer.yaml”添加“ 聯(lián)系方式” 和“ 地址” 詳細(xì)信息，并將新文件另存為customer_with_contact_details_and_address.yaml.。

現(xiàn)在，我們將分析新的YAML文檔：

firstName: "John"
lastName: "Doe"
age: 31
contactDetails:
  - type: "mobile"
   number: 123456789
  - type: "landline"
   number: 456786868
homeAddress:
  line: "Xyz, DEF Street"
  city: "City Y"
  state: "State Y"
  zip: 345657

我們來更新java類：

public class Customer {
  private String firstName;
  private String lastName;
  private int age;
  private List<Contact> contactDetails;
  private Address homeAddress;  
  // getters and setters
}

public class Contact {
  private String type;
  private int number;
  // getters and setters
}

public class Address {
  private String line;
  private String city;
  private String state;
  private Integer zip;
  // getters and setters
}

現(xiàn)在，我們來測(cè)試下Yaml＃load（）：

@Test
public void
 whenLoadYAMLDocumentWithTopLevelClass_thenLoadCorrectJavaObjectWithNestedObjects() {
 
  Yaml yaml = new Yaml(new Constructor(Customer.class));
  InputStream inputStream = this.getClass()
   .getClassLoader()
   .getResourceAsStream("yaml/customer_with_contact_details_and_address.yaml");
  Customer customer = yaml.load(inputStream);
 
  assertNotNull(customer);
  assertEquals("John", customer.getFirstName());
  assertEquals("Doe", customer.getLastName());
  assertEquals(31, customer.getAge());
  assertNotNull(customer.getContactDetails());
  assertEquals(2, customer.getContactDetails().size());
   
  assertEquals("mobile", customer.getContactDetails()
   .get(0)
   .getType());
  assertEquals(123456789, customer.getContactDetails()
   .get(0)
   .getNumber());
  assertEquals("landline", customer.getContactDetails()
   .get(1)
   .getType());
  assertEquals(456786868, customer.getContactDetails()
   .get(1)
   .getNumber());
  assertNotNull(customer.getHomeAddress());
  assertEquals("Xyz, DEF Street", customer.getHomeAddress()
   .getLine());
}

4.5類型安全的集合

當(dāng)給定Java類的一個(gè)或多個(gè)屬性是泛型集合類時(shí)，需要通過TypeDescription來指定泛型類型，以以便可以正確解析。

讓我們假設(shè)一個(gè) 一個(gè)Customer擁有多個(gè)Contact：

firstName: "John"
lastName: "Doe"
age: 31
contactDetails:
  - { type: "mobile", number: 123456789}
  - { type: "landline", number: 123456789}

為了能正確解析，我們可以在頂級(jí)類上為給定屬性指定TypeDescription ：

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

4.6載入多個(gè)文件

在某些情況下，單個(gè)文件中可能有多個(gè)YAML文檔，而我們想解析所有文檔。所述YAML類提供了一個(gè)LOADALL（）方法來完成這種類型的解析。

假設(shè)下面的內(nèi)容在一個(gè)文件中：

---
firstName: "John"
lastName: "Doe"
age: 20
---
firstName: "Jack"
lastName: "Jones"
age: 25

我們可以使用loadAll（）方法解析以上內(nèi)容，如以下代碼示例所示：

@Test
public void whenLoadMultipleYAMLDocuments_thenLoadCorrectJavaObjects() {
  Yaml yaml = new Yaml(new Constructor(Customer.class));
  InputStream inputStream = this.getClass()
   .getClassLoader()
   .getResourceAsStream("yaml/customers.yaml");
 
  int count = 0;
  for (Object object : yaml.loadAll(inputStream)) {
    count++;
    assertTrue(object instanceof Customer);
  }
  assertEquals(2,count);
}

5.生成YAML文件

SnakeYAML 支持將java對(duì)象序列化為yml。

5.1基本用法

我們將從一個(gè)將Map <String，Object>的實(shí)例轉(zhuǎn)儲(chǔ)到Y(jié)AML文檔（String）的簡(jiǎn)單示例開始：

@Test
public void whenDumpMap_thenGenerateCorrectYAML() {
  Map<String, Object> data = new LinkedHashMap<String, Object>();
  data.put("name", "Silenthand Olleander");
  data.put("race", "Human");
  data.put("traits", new String[] { "ONE_HAND", "ONE_EYE" });
  Yaml yaml = new Yaml();
  StringWriter writer = new StringWriter();
  yaml.dump(data, writer);
  String expectedYaml = "name: Silenthand Olleander\nrace: Human\ntraits: [ONE_HAND, ONE_EYE]\n";
 
  assertEquals(expectedYaml, writer.toString());
}

上面的代碼產(chǎn)生以下輸出（請(qǐng)注意，使用LinkedHashMap的實(shí)例將保留輸出數(shù)據(jù)的順序）：

name: Silenthand Olleander
race: Human
traits: [ONE_HAND, ONE_EYE]

5.2自定義Java對(duì)象

我們還可以選擇將自定義Java類型轉(zhuǎn)儲(chǔ)到輸出流中。

@Test
public void whenDumpACustomType_thenGenerateCorrectYAML() {
 Customer customer = new Customer();
 customer.setAge(45);
 customer.setFirstName("Greg");
 customer.setLastName("McDowell");
 Yaml yaml = new Yaml();
 StringWriter writer = new StringWriter();
 yaml.dump(customer, writer);  
 String expectedYaml = "!!com.baeldung.snakeyaml.Customer {age: 45, contactDetails: null, firstName: Greg,\n homeAddress: null, lastName: McDowell}\n";
 
 assertEquals(expectedYaml, writer.toString());
}

生成內(nèi)容會(huì)包含!!com.baeldung.snakeyaml.Customer，為了避免在輸出文件中使用標(biāo)簽名，我們可以使用庫(kù)提供的 dumpAs（）方法。

因此，在上面的代碼中，我們可以進(jìn)行以下調(diào)整以刪除標(biāo)記：