欢迎访问我的GitHub

https://github.com/zq2599/blog_demos

内容&＃xff1a;所有原创文章分类和汇总&＃xff0c;及配套源码&＃xff0c;涉及Java、Docker、Kubernetes、DevOPS等&＃xff1b;

本篇概览

• 本文是《jackson学习》系列的第六篇&＃xff0c;继续学习jackson强大的注解能力&＃xff0c;本篇学习的是常用的类注解&＃xff0c;并通过实例来加深印象&＃xff0c;下图是常用类注解的简介&＃xff1a;

• 接下来逐个学习&＃xff1b;

源码下载

如果您不想编码&＃xff0c;可以在GitHub下载所有源码&＃xff0c;地址和链接信息如下表所示(
https://github.com/zq2599/blog_demos)&＃xff1a;

• 这个git项目中有多个文件夹&＃xff0c;本章的应用在jacksondemo文件夹下&＃xff0c;如下图红框所示&＃xff1a;

• jacksondemo是父子结构的工程&＃xff0c;本篇的代码在annotation子工程中&＃xff0c;里面的classannonation这个package下&＃xff0c;如下图&＃xff1a;

JsonRootName

1. JsonRootName的设置如下&＃xff1a;

&＃64;JsonRootName(value &＃61; "aaabbbccc")static class Test {private String field0;public String getField0() { return field0; } public void setField0(String field0) { this.field0 &＃61; field0; } }

2. 开启root对象特性方法&＃xff0c;以及序列化结果如下图&＃xff0c;可见JsonRootName注解的value值aaabbbccc成了root对象的key&＃xff1a;

2. 开启root对象的反序列化特性后&＃xff0c;用上述红框3中的json字符串可反序列化成Test类的实例&＃xff1b;
3. 关于root对象的序列化和反序列化特性&＃xff0c;可以参考《jackson学习之四&＃xff1a;WRAP ROOT(root对象) 》&＃xff1b;

JsonIgnoreProperties

1. 该注解用于指定序列化和反序列化时要忽略的字段&＃xff0c;如下所示&＃xff0c;Test类的field1和field2被设置为不参与序列化和反序列化操作&＃xff1a;

&＃64;JsonIgnoreProperties({"field1", "field2"}) static class Test { private String field0; private String field1; private String field2; // 省去get、set、toString方法

2. 演示代码是JsonIgnorePropertiesSeriallization.java&＃xff0c;执行结果如下图&＃xff1a;

2. 保持Test.java的JsonIgnoreProperties注解不变&＃xff0c;再试试反序列化&＃xff0c;对应的代码在JsonIgnorePropertiesDeserializer.java&＃xff0c;如下图&＃xff0c;反序列化后field1和field2依然是null&＃xff0c;也就是说反序列化操作中&＃xff0c;field1和field2都被忽略了&＃xff1a;

JsonIgnoreType

1. 被该注解修饰的类&＃xff0c;作为其他类的成员变量时&＃xff0c;不论是序列化还是反序列化都被忽略了&＃xff1b;
2. 来验证一下&＃xff0c;如下所示&＃xff0c;TestChild类被JsonIgnoreType注解修饰&＃xff1a;

&＃64;JsonIgnoreType static class TestChild { private int value; // 省去get、set、toString方法

3. 如下所示&＃xff0c;再把TestChild作为Test类的成员变量&＃xff1a;

static class Test { private String field0; private TestChild field1; // 省去get、set、toString方法

4. 序列化操作的代码是JsonIgnoreTypeSerialization.java&＃xff0c;执行结果如下图&＃xff0c;可见类型为TestChild的field1字段&＃xff0c;在序列化的时候被忽略了&＃xff1a;

4. 再来试试反序列化&＃xff0c;代码在JsonIgnoreTypeDeserializer.java&＃xff0c;如下图&＃xff0c;可见带有注解JsonIgnoreType的类作为成员变量&＃xff0c;在反序列化时会被忽略&＃xff1a;

JsonAutoDetect

1. 序列化和反序列化时自动识别的范围&＃xff0c;如下&＃xff1a;

&＃64;JsonAutoDetect(fieldVisibility &＃61; JsonAutoDetect.Visibility.PUBLIC_ONLY)public class College { private String name; private String city; protected int age &＃61; 100;

2. fieldVisibility属性有以下值可选&＃xff1a;

ANY // 所有NON_PRIVATE // private之外的PROTECTED_AND_PUBLIC // protected和public的(此时privte和默认的package access时不能被自动识别的)PUBLIC_ONLY // public的NONE // 禁止自动识别DEFAULT // 默认的&＃xff0c;用于继承父类的自动识别的范围

3. 验证&＃xff0c;如下图&＃xff0c;College类设置了注解&＃xff0c;fieldVisibility是PUBLIC_ONLY&＃xff0c;红框中显示age字段是protected类型的&＃xff1a;

3. 序列化结果如下图红框&＃xff0c;age字段不是public&＃xff0c;所以没有输出&＃xff1a;

3. fieldVisibility改成NON_PRIVATE再试试&＃xff1a;

3. 如下图红框&＃xff0c;age不是private&＃xff0c;所以可以被序列化&＃xff1a;

JsonPropertyOrder

1. 这个注解好理解&＃xff0c;就是指定序列化的顺序&＃xff0c;注意该注解仅在序列化场景有效&＃xff1b;
2. 先看看没有JsonPropertyOrder注解时的序列化顺序&＃xff0c;Test.java如下所示&＃xff0c;是和代码的顺序一致的&＃xff1a;

static class Test { private String field0; private String field1; private String field2; // 省去get、set、toString方法

3. 此时对Test的实例做序列化操作&＃xff0c;结果如下图&＃xff0c;顺序和代码顺序一致&＃xff1a;

3. 现在给Test类加上JsonPropertyOrder注解&＃xff0c;顺序是field2、field0、field1&＃xff1a;

&＃64;JsonPropertyOrder({"field2", "field0", "field1"}) static class Test { private String field0; private String field1; private String field2; // 省去get、set、toString方法

5. 执行结果如下图所示&＃xff0c;也是field2、field0、field1&＃xff1a;

JsonInclude

1. 注解JsonInclude仅在序列化场景有效&＃xff1b;
2. 通过该注解控制某些字段不被序列化(例如空字符串不被序列化)&＃xff1b;
3. 可以设置以下几种限制&＃xff1a;

ALWAYS // 默认策略&＃xff0c;任何情况都执行序列化NON_NULL // 非空NON_ABSENT // null的不会序列化&＃xff0c;但如果类型是AtomicReference&＃xff0c;依然会被序列化NON_EMPTY // null、集合数组等没有内容、空字符串等&＃xff0c;都不会被序列化NON_DEFAULT // 如果字段是默认值&＃xff0c;就不会被序列化CUSTOM // 此时要指定valueFilter属性&＃xff0c;该属性对应一个类&＃xff0c;用来自定义判断被JsonInclude修饰的字段是否序列化USE_DEFAULTS // 当JsonInclude在类和属性上都有时&＃xff0c;优先使用属性上的注解&＃xff0c;此时如果在序列化的get方法上使用了JsonInclude&＃xff0c;并设置为USE_DEFAULTS&＃xff0c;就会使用类注解的设置

4. JsonInclude涉及的知识点较多&＃xff0c;已在一篇单独文章中详细说明&＃xff0c;请参考《jackson学习之五&＃xff1a;JsonInclude注解 》&＃xff1b;

至此&＃xff0c;Jackson的常用类注解的学习和实战就完成了&＃xff0c;接下来的文章我们学习常用的属性注解&＃xff1b;

欢迎关注我的公众号&＃xff1a;程序员欣宸