這篇文章主要介紹“JAVA如何基于SnakeYAML實(shí)現(xiàn)序列化YAML”,在日常操作中,相信很多人在JAVA如何基于SnakeYAML實(shí)現(xiàn)序列化YAML問題上存在疑惑,小編查閱了各式資料,整理出簡單好用的操作方法,希望對大家解答”JAVA如何基于SnakeYAML實(shí)現(xiàn)序列化YAML”的疑惑有所幫助!接下來,請跟著小編一起來學(xué)習(xí)吧!
公司主營業(yè)務(wù):成都網(wǎng)站制作、網(wǎng)站設(shè)計(jì)、移動網(wǎng)站開發(fā)等業(yè)務(wù)。幫助企業(yè)客戶真正實(shí)現(xiàn)互聯(lián)網(wǎng)宣傳,提高企業(yè)的競爭能力。創(chuàng)新互聯(lián)是一支青春激揚(yáng)、勤奮敬業(yè)、活力青春激揚(yáng)、勤奮敬業(yè)、活力澎湃、和諧高效的團(tuán)隊(duì)。公司秉承以“開放、自由、嚴(yán)謹(jǐn)、自律”為核心的企業(yè)文化,感謝他們對我們的高要求,感謝他們從不同領(lǐng)域給我們帶來的挑戰(zhàn),讓我們激情的團(tuán)隊(duì)有機(jī)會用頭腦與智慧不斷的給客戶帶來驚喜。創(chuàng)新互聯(lián)推出密山免費(fèi)做網(wǎng)站回饋大家。
1.概述
本文,我們將學(xué)習(xí)如何使用SnakeYAML庫將
YAML文檔轉(zhuǎn)換為Java對象,以及JAVA對象如何序列化為YAML文檔。
2.項(xiàng)目設(shè)置
要在項(xiàng)目中使用SnakeYAML,需要添加Maven依賴項(xiàng)(可在此處找到最新版本):
3.入口點(diǎn)
該YAML類是API的入口點(diǎn):
Yaml yaml = new Yaml()
由于實(shí)現(xiàn)不是線程安全的,因此不同的線程必須具有自己的Yaml實(shí)例。
4.加載YAML文檔
SnakeYAML支持從String或InputStream加載文檔,我們從定義一個簡單的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
上面的代碼生成以下輸出:
{firstName=John, lastName=Doe, age=20}
默認(rèn)情況下,load()方法返回一個Map對象。查詢Map對象時,我們需要事先知道屬性鍵的名稱,否則容易出錯。更好的辦法是自定義類型。
4.2自定義類型解析
SnakeYAML提供了一種將文檔解析為自定義類型的方法
讓我們定義一個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隱式類型
如果沒有為給定屬性定義類型,則庫會自動將值轉(zhuǎn)換為隱式type。
例如:
1.0 -> Float42 -> Integer2009-03-30 -> Date
讓我們使用一個TestCase來測試這種隱式類型轉(zhuǎn)換:
@Testpublic void whenLoadYAML_thenLoadCorrectImplicitTypes() { Yaml yaml = new Yaml(); Map
4.4 嵌套對象
SnakeYAML 支持嵌套的復(fù)雜類型。
讓我們向“ customer.yaml”添加“ 聯(lián)系方式” 和“ 地址” 詳細(xì)信息,并將新文件另存為customer_with_contact_details_and_address.yaml.。
現(xiàn)在,我們將分析新的YAML文檔:
firstName: "John"lastName: "Doe"age: 31contactDetails: - type: "mobile" number: 123456789 - type: "landline" number: 456786868homeAddress: 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
現(xiàn)在,我們來測試下Yaml#load():
@Testpublic 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類的一個或多個屬性是泛型集合類時,需要通過TypeDescription來指定泛型類型,以以便可以正確解析。
讓我們假設(shè)一個 一個Customer擁有多個Contact:
firstName: "John"lastName: "Doe"age: 31contactDetails: - { type: "mobile", number: 123456789} - { type: "landline", number: 123456789}
為了能正確解析,我們可以在頂級類上為給定屬性指定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載入多個文件
在某些情況下,單個文件中可能有多個YAML文檔,而我們想解析所有文檔。所述YAML類提供了一個LOADALL()方法來完成這種類型的解析。
假設(shè)下面的內(nèi)容在一個文件中:
---firstName: "John"lastName: "Doe"age: 20---firstName: "Jack"lastName: "Jones"age: 25
我們可以使用loadAll()方法解析以上內(nèi)容,如以下代碼示例所示:
@Testpublic 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對象序列化為yml。
5.1基本用法
我們將從一個將Map
@Testpublic void whenDumpMap_thenGenerateCorrectYAML() { Map
上面的代碼產(chǎn)生以下輸出(請注意,使用LinkedHashMap的實(shí)例將保留輸出數(shù)據(jù)的順序):
name: Silenthand Olleanderrace: Humantraits: [ONE_HAND, ONE_EYE]
5.2自定義Java對象
我們還可以選擇將自定義Java類型轉(zhuǎn)儲到輸出流中。
@Testpublic 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)容會包含!!com.baeldung.snakeyaml.Customer,為了避免在輸出文件中使用標(biāo)簽名,我們可以使用庫提供的 dumpAs()方法。
因此,在上面的代碼中,我們可以進(jìn)行以下調(diào)整以刪除標(biāo)記:
yaml.dumpAs(customer, Tag.MAP, null);
到此,關(guān)于“JAVA如何基于SnakeYAML實(shí)現(xiàn)序列化YAML”的學(xué)習(xí)就結(jié)束了,希望能夠解決大家的疑惑。理論與實(shí)踐的搭配能更好的幫助大家學(xué)習(xí),快去試試吧!若想繼續(xù)學(xué)習(xí)更多相關(guān)知識,請繼續(xù)關(guān)注創(chuàng)新互聯(lián)網(wǎng)站,小編會繼續(xù)努力為大家?guī)砀鄬?shí)用的文章!