SnakeYaml反序列化基础

一、基础概念

1.1 SnakeYaml 简介

YAML是”YAML Ain’t a Markup Language”（YAML不是一种标记语言）的递归缩写，是一个可读性高、用来表达数据序列化的格式，类似于XML但比XML更简洁。

在Java中，有一个用于解析YAML格式的库，即SnakeYaml。

SnakeYaml是一个完整的YAML1.1规范Processor，支持UTF-8/UTF-16，支持Java对象的序列化/反序列化，支持所有YAML定义的类型。

1.2 Yaml 语法与结构

YAML基本格式要求：

YAML大小写敏感；
使用缩进代表层级关系；
缩进只能使用空格，不能使用TAB，不要求空格个数，只需要相同层级左对齐（一般2个或4个空格）

示例如下：

environments:
    dev:
        url: http://dev.bar.com
        name: Developer Setup
    prod:
        url: http://foo.bar.com
        name: My Cool App
my:
    servers:
        - dev.bar.com
        - foo.bar.com

YAML支持三种数据结构：

1、对象

使用冒号代表，格式为key: value。冒号后面要加一个空格：

1	`key: value`

可以使用缩进表示层级关系：

1
2
3

key: 
    child-key: value
    child-key2: value2

2、数组

使用一个短横线加一个空格代表一个数组项：

1
2
3

hobby:
    - Java
    - LOL

3、常量

YAML中提供了多种常量结构，包括：整数，浮点数，字符串，NULL，日期，布尔，时间。下面使用一个例子来快速了解常量的基本使用：

boolean: 
    - TRUE  #true,True都可以
    - FALSE  #false，False都可以
float:
    - 3.14
    - 6.8523015e+5  #可以使用科学计数法
int:
    - 123
    - 0b1010_0111_0100_1010_1110    #二进制表示
null:
    nodeName: 'node'
    parent: ~  #使用~表示null
string:
    - 哈哈
    - 'Hello world'  #可以使用双引号或者单引号包裹特殊字符
    - newline
      newline2    #字符串可以拆成多行，每一行会被转化成一个空格
date:
    - 2018-02-17    #日期必须使用ISO 8601格式，即yyyy-MM-dd
datetime: 
    -  2018-02-17T15:02:31+08:00    #时间使用ISO 8601格式，时间和日期之间使用T连接，最后使用+代表时区

更多的关于YAML的语法及使用可参考：https://www.yiibai.com/yaml

二、SnakeYaml 序列化与反序列化

2.1 SnakeYaml 序列化和反序列化实践

SnakeYaml提供了Yaml.dump()和Yaml.load()两个函数对yaml格式的数据进行序列化和反序列化。

Yaml.load()：入参是一个字符串或者一个文件，经过序列化之后返回一个Java对象；
Yaml.dump()：将一个对象转化为yaml文件形式；

下面使用的环境是用的 SnakeYaml 1.33 版本

User 类，拥有一个name属性及其setter方法和getter方法

package com.candy;

/**
 * @author candy
 * @project SnakeYamlDeserialization
 * @file com.candy.User.java
 * @date 2024/11/20 21:22
 */

public class User {
    String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

snakeTest.java，序列化新建的User对象为yaml格式内容

package com.candy;

import org.yaml.snakeyaml.Yaml;

/**
 * @author candy
 * @project SnakeYamlDeserialization
 * @file com.candy.snakeTest.java
 * @date 2024/11/20 21:23
 */

public class snakeTest {
    public static void main(String[] args) {
        User user = new User();
        user.setName("candy");
        Yaml yaml = new Yaml();
        String s = yaml.dump(user);
        System.out.println(s);
    }
}

输出结果

1	`!!com.candy.User {name: candy}`

输出yaml格式的内容，这里”!!”用于强制类型转化，”!!User”是将该对象转为User类，如果没有”!”则就是个key为字符串的Map；

修改 snakeTest.java 程序，反序列化一下输出的 User 对象

package com.candy;

import org.omg.PortableInterceptor.USER_EXCEPTION;
import org.yaml.snakeyaml.Yaml;

/**
 * @author candy
 * @project SnakeYamlDeserialization
 * @file com.candy.snakeTest.java
 * @date 2024/11/20 21:23
 */

public class snakeTest {
    public static void main(String[] args) {
        String s = "!!com.candy.User {name: candy}";
        Yaml yaml = new Yaml();
        User user = yaml.load(s);
        System.out.println(user + ": " + user.getName());
    }
}

输出，看到成功反序列化出User对象：

1	`com.candy.User@64a294a6: candy`

2.2 SnakeYaml 反序列化的类方法调用

类比下Fastjson和Jackson的反序列化的类方法调用，这里我们也试下Yaml.load()在调用时会调用将要反序列化的类的哪些方法。

修改 User 类

package com.candy;

/**
 * @author candy
 * @project SnakeYamlDeserialization
 * @file com.candy.User.java
 * @date 2024/11/20 21:22
 */

public class User {
    String name;
    int age;

    public String getName() {
        System.out.println("调用了User#getName方法");
        return name;
    }

    public void setName(String name) {
        System.out.println("调用了User#setName方法");
        this.name = name;
    }

    public int getAge() {
        System.out.println("调用了User#getAge方法");
        return age;
    }

    public void setAge(int age) {
        System.out.println("调用了User#setAge方法");
        this.age = age;
    }
}

修改 snakeTest.java

package com.candy;

import org.omg.PortableInterceptor.USER_EXCEPTION;
import org.yaml.snakeyaml.Yaml;

/**
 * @author candy
 * @project SnakeYamlDeserialization
 * @file com.candy.snakeTest.java
 * @date 2024/11/20 21:23
 */

public class snakeTest {
    public static void main(String[] args) {
        String s = "!!com.candy.User {age: 18, name: candy}";
        Yaml yaml = new Yaml();
        User user = yaml.load(s);
        System.out.println(user + ": " + user.getName());
    }
}

输出看到，调用了反序列化的类的构造函数和yaml格式内容中包含的属性的setter方法：

调用了User#setAge方法
调用了User#setName方法
调用了User#getName方法
com.candy.User@6ae40994: candy

2.3 SnakeYaml反序列化过程调试分析

SnakeYaml反序列化的实现主要是通过反射机制来查找对应的Java类，新建一个实例并将对应的属性值赋给该实例。

在前面的反序列化Demo中，在User user = yaml.load(s);上打上断点开始调试。

在load()函数中会先生成一个StreamReader，将yaml数据通过构造函数赋给StreamReader，再调用loadFromReader()函数：

在loadFromReader()函数中，调用了 Baseconstructor.getSingleData()函数，此时type为java.lang.Object，指定从yaml格式数据中获取数据类型是Object类型：

跟进getSingleData()函数中，先创建一个Node对象（其中调用getSingleNote()会根据流来生成一个文件，即将字符串按照yaml语法转为Node对象），然后判断当前Node是否为空且是否Tag为空，若不是则判断yaml格式数据的类型是否为Object类型、是否有根标签，这里都判断不通过，最后返回调用constructDocument()函数的结果：