关于云计算:jackson学习之四WRAPROOTVALUEroot对象

欢送拜访我的 GitHub

https://github.com/zq2599/blog_demos

内容：所有原创文章分类汇总及配套源码，波及 Java、Docker、Kubernetes、DevOPS 等；

系列文章汇总

• jackson 学习之一：根本信息
• jackson 学习之二：jackson-core
• jackson 学习之三：罕用 API 操作
• jackson 学习之四：WRAP_ROOT_VALUE（root 对象）
• jackson 学习之五：JsonInclude 注解
• jackson 学习之六：罕用类注解
• jackson 学习之七：罕用 Field 注解
• jackson 学习之八：罕用办法注解
• jackson 学习之九：springboot 整合 (配置文件)
• jackson 学习之十 (终篇)：springboot 整合 (配置类)

本篇概览

本文是《jackson 学习》系列的第四篇，后面学习了罕用 API，能够执行最根本的序列化和反序列化操作，接下来要学习的就是 jackson 弱小的注解能力，本篇要学的是 root 对象个性，次要内容如下：

1. 对于 root 对象
2. 测试用的 POJO 类
3. 序列化实战
4. 反序列化实战

对于 root 对象（WRAP_ROOT_VALUE）

1. 对于只有 <font color=”blue”>id</font> 和 <font color=”blue”>name</font> 两个字段的 POJO 实例来说，失常的序列化后果如下：

{
  "id" : 1,
  "name" : "book"
}

1. jackson 在序列化时，能够在上述 json 里面再包裹一层，官网叫做 <font color=”blue”>WRAP_ROOT_VALUE</font>，本文中叫做 <font color=”red”>root 对象 </font>，如下所示，整个 json 的只有一个键值对，key 是 <font color=”blue”>aaabbbccc</font>，value 外部才是 POJO 实例的 id 和 name 字段的值：

{
  "aaabbbccc" : {
    "id" : 2,
    "name" : "food"
  }
}

提前小结

root 对象个性提前做个小结，这样如果您工夫无限，仅看这一节即可：

• 先看序列化场景：

1. 执行上面代码，jackson 在序列化时会减少 root 对象：

mapper.enable(SerializationFeature.WRAP_ROOT_VALUE);

1. root 对象的 key，默认是实例的类名，如果实例有 JsonRootName 注解，就是该注解的 value 值；
2. root 对象的 value 如下所示，相当于 <font color=”blue”> 不反对 root 对象时的序列化后果 </font>：

{
  "id" : 1,
  "name" : "book"
}

• 再看反序列化场景：

1. 执行上面代码，jackson 在反序列化时会先解析 root 对象：

mapper.enable(DeserializationFeature.UNWRAP_ROOT_VALUE);

1. root 对象的 key，默认是实例的类名，如果实例有 JsonRootName 注解，就是该注解的 value 值；
2. root 对象的 value 如下所示，相当于 <font color=”blue”> 不反对 root 对象时用来反序列化的 json 字符串 </font>：

{
  "id" : 1,
  "name" : "book"
}

筹备两个 POJO 类

用比照的形式能够更分明理解 JsonRootName 的作用，接下来的学习咱们筹备两个 POJO 类，一个没有 JsonRootName 注解，另一个有 JsonRootName 注解：

1. 名为 <font color=”blue”>Order1.java</font> 的，没有 JsonRootName 注解：

public class Order1 {
    private int id;
    private String name;
    // 省去 get、set、toString 办法
    ...
}

1. 名为 <font color=”blue”>Order2.java</font> 的，有 JsonRootName 注解，value 值为 <font color=”red”>aaabbbccc</font>：

import com.fasterxml.jackson.annotation.JsonRootName;

@JsonRootName(value = "aaabbbccc")
public class Order2 {
    private int id;
    private String name;
    // 省去 get、set、toString 办法
    ...
}

• 可见 Order1 和 Order2 的代码是统一的，惟一的不同是 Order2 带有注解 JsonRootName；

序列化

1. 须要设置 WRAP_ROOT_VALUE 属性，jackson 才会反对 root 对象，JsonRootName 注解才会发挥作用，设置代码如下：

mapper.enable(SerializationFeature.WRAP_ROOT_VALUE);

1. 写一段代码，在不开启 WRAP_ROOT_VALUE 属性的时候执行序列化，再开启 WRAP_ROOT_VALUE 属性执行序列化，比照试试：

public static void main(String[] args) throws Exception {
        // 实例化 Order1 和 Order2
        Order1 order1 = new Order1();
        order1. setId(1);
        order1.setName("book");

        Order2 order2 = new Order2();
        order2. setId(2);
        order2.setName("food");

        // 没有开启 WRAP_ROOT_VALUE 的时候
        logger.info("没有开启 WRAP_ROOT_VALUE\n");
        ObjectMapper mapper1 = new ObjectMapper();
        // 丑化输入
        mapper1.enable(SerializationFeature.INDENT_OUTPUT);

        logger.info("没有 JsonRootName 注解类，序列化后果：\n\n{}\n\n", mapper1.writeValueAsString(order1));
        logger.info("有 JsonRootName 注解的类，序列化后果：\n\n{}\n\n\n\n", mapper1.writeValueAsString(order2));

        // 开启了 WRAP_ROOT_VALUE 的时候
        logger.info("开启了 WRAP_ROOT_VALUE\n");
        ObjectMapper mapper2 = new ObjectMapper();
        // 丑化输入
        mapper2.enable(SerializationFeature.INDENT_OUTPUT);
        // 序列化的时候反对 JsonRootName 注解
        mapper2.enable(SerializationFeature.WRAP_ROOT_VALUE);

        logger.info("没有 JsonRootName 注解类，序列化后果：\n\n{}\n\n", mapper2.writeValueAsString(order1));
        logger.info("有 JsonRootName 注解的类，序列化后果：\n\n{}", mapper2.writeValueAsString(order2));
    }

1. 执行后果如下，JsonRootName 在序列化时的作用高深莫测：指定了 root 对象的 key：

反序列化（默认设置）

1. 在没有做任何设置的时候，上面这个字符串用来反序列化成 Order2 对象，会胜利吗？

{
  "id" : 2,
  "name" : "food"
}

1. 试了下是能够的：

1. 那上面这个字符串能反序列化成 Order2 对象吗？

{
  "aaabbbccc" : {
    "id" : 2,
    "name" : "food"
  }
}

1. 代码和后果如下图所示，反序列化时 jackson 并不意识 <font color=”red”>aaabbbccc</font> 这个 key，因为 jackson 此时并不反对 root 对象：

• 小结：默认状况下，反序列化时 json 字符串不能有 root 对象；

反序列化（开启 UNWRAP_ROOT_VALUE 属性）

1. 如果开启了 UNWRAP_ROOT_VALUE 属性，用于反序列化的 json 字符串就必须要有 root 对象了，开启 UNWRAP_ROOT_VALUE 属性的代码如下：

mapper.enable(DeserializationFeature.UNWRAP_ROOT_VALUE);

1. 代码和后果如下图，可见带有 root 对象的 json 字符串，能够反序列化胜利，root 对象的 key 就是 JsonRootName 注解的 value 属性：

1. 值得注意的是，上述 json 字符串中，root 对象的 key 为 <font color=”blue”>aaabbbccc</font>，这和 Order2 的 <font color=”blue”>JsonRootName</font> 注解的 value 值是统一的，<font color=”red”> 如果不统一就会反序列化失败 </font>，如下图：

• 至此，jackson 的 WRAP_ROOT_VALUE 个性就学习实现了，在 web 开发时这是个很罕用的性能，用于在最里面包裹一层，以便整体上增加额定的内容，心愿能给您带来参考；

你不孤独，欣宸原创一路相伴

1. Java 系列
2. Spring 系列
3. Docker 系列
4. kubernetes 系列
5. 数据库 + 中间件系列
6. DevOps 系列

欢送关注公众号：程序员欣宸

微信搜寻「程序员欣宸」，我是欣宸，期待与您一起畅游 Java 世界 …
https://github.com/zq2599/blog_demos