jackson学习之五:JsonInclude注解

欢迎访问我的GitHub

https://github.com/zq2599/blog_demos
内容:所有原创文章分类汇总及配套源码,涉及Java、Docker、Kubernetes、DevOPS等;

系列文章汇总

本篇概览

  1. 本文是《jackson学习》系列第五篇,来熟悉一个常用的注解JsonInclude,该注解的仅在序列化操作时有用,用于控制方法、属性等是否应该被序列化;
  2. 之所以用单独的一篇来写JsonInclude注解,是因为该注解的值有多种,每种都有不同效果,最好的学习方法就是编码实战;
  3. 先对注解的所有取值做个简介:
ALWAYS // 默认策略,任何情况都执行序列化
NON_NULL // 非空
NON_ABSENT // null的不会序列化,但如果类型是AtomicReference,依然会被序列化
NON_EMPTY // null、集合数组等没有内容、空字符串等,都不会被序列化
NON_DEFAULT // 如果字段是默认值,就不会被序列化
CUSTOM // 此时要指定valueFilter属性,该属性对应一个类,用来自定义判断被JsonInclude修饰的字段是否序列化
USE_DEFAULTS // 当JsonInclude在类和属性上都有时,优先使用属性上的注解,此时如果在序列化的get方法上使用了JsonInclude,并设置为USE_DEFAULTS,就会使用类注解的设置  

源码下载

  1. 如果您不想编码,可以在GitHub下载所有源码,地址和链接信息如下表所示(https://github.com/zq2599/blog_demos):
名称 链接 备注
项目主页 https://github.com/zq2599/blog_demos 该项目在GitHub上的主页
git仓库地址(https) https://github.com/zq2599/blog_demos.git 该项目源码的仓库地址,https协议
git仓库地址(ssh) git@github.com:zq2599/blog_demos.git 该项目源码的仓库地址,ssh协议
  1. 这个git项目中有多个文件夹,本章的应用在jacksondemo文件夹下,如下图红框所示:
    在这里插入图片描述

  2. jacksondemo是父子结构的工程,本篇的代码在annotation子工程中,里面的jsoninclude这个package下,如下图:
    在这里插入图片描述

  • 接下来逐个学习这些属性的效果;

ALWAYS

ALWAYS表示全部序列化,如下图,null和空字符串都会序列化:
在这里插入图片描述

NON_NULL

NON_NULL好理解,就是值为null就不序列化:
在这里插入图片描述

NON_ABSENT

  1. NON_ABSENT略为复杂,当实例化的对象有OptionalAtomicReference类型的成员变量时,如果Optional引用的实例为空,用NON_ABSENT能使该字段不做序列化;
  2. Optional是java用来优雅处理空指针的一个特性,本文中不做过多说明,请您自行查阅相关文档;
  3. 要让Jackson支持Optional特性,必须做两件事,首先是在pom.xml中添加以下依赖:
<dependency>
    <groupId>com.fasterxml.jackson.datatype</groupId>
    <artifactId>jackson-datatype-jdk8</artifactId>
    <version>2.11.0</version>
</dependency>
  1. 其次是代码中执行以下设置:
mapper.registerModule(new Jdk8Module());
  1. 咱们先看看设置成NON_NULL时jackson对Optional和AtomicReference的处理,下面的代码中,Optional和AtomicReference的引用都是空,但还是被序列化出来了:
    在这里插入图片描述

  2. 代码不变,将NON_NULL改为NON_ABSENT试试,如下图,可见field2和field3都没有序列化了:
    在这里插入图片描述
    小结NON_ABSENT的效果:
    a. 自身为null的字段不会被序列化;
    b. Optional类型的字段,如果引用值为null,该字段不会被序列化;
    c. AtomicReference类型的字段,如果引用值为null,该字段不会被序列化;

NON_EMPTY

NON_EMPTY好理解,以下情况都不会被序列化:

  1. null
  2. 空字符串
  3. 空集合
  4. 空数组
  5. Optional类型的,其引用为空
  6. AtomicReference类型的,其引用为空
  7. 演示代码和结果如下图,可见上述场景全部没有被序列化:
    在这里插入图片描述

NON_DEFAULT

  1. 设置为NON_DEFAULT后,对保持默认值的字段不做序列化,如下图:
    在这里插入图片描述

CUSTOM

  1. 相对其他类型,CUSTOM略为复杂,这个值要配合valueFilter属性一起使用;
  2. 如下所示,JsonInclude的value等于CUSTOM时,在序列化的时候会执行CustomFilter的equals方法,该方法的入参就是field0的值,如果equals方法返回true,field0就不会被序列化,如果equals方法返回false时field0才会被序列化
@JsonInclude(value = JsonInclude.Include.CUSTOM, 
                valueFilter = CustomFilter.class)
        private String field0;
  1. 来看看CustomFilter类的代码,如下所示,只有equals方法,可见:null、非字符串、长度大于2这三种情况都返回true,也就是说这三种情况下都不会被序列化
static class CustomFilter {
        @Override
        public boolean equals(Object obj) {
            // null,或者不是字符串就返回true,意味着不被序列化
            if(null==obj || !(obj instanceof String)) {
                return true;
            }

            // 长度大于2就返回true,意味着不被序列化
            return ((String) obj).length() > 2;
        }
    }
  1. 下面贴出完整代码和结果,您就一目了然了:
    在这里插入图片描述
  • 再次强调:valueFilter的equals方法返回true,意味着该字段不会被序列化!!!

USE_DEFAULTS

USE_DEFAULTS的用法也有点绕,咱们通过对比的方法来学习;

  1. 代码如下所示,在类和成员变量上都有JsonInclude注解,序列化field0的时候,是哪个注解生效呢?:
    @JsonInclude(JsonInclude.Include.NON_EMPTY)
    static class Test {

        @JsonInclude(JsonInclude.Include.NON_NULL)
        private List<String> field0;

        public List<String> getField0() { return field0; }

        public void setField0(List<String> field0) { this.field0 = field0; }
    }
  1. 把field0设置为空集合,运行代码试试,如果类上的注解生效,那么field0就不会被序列化(NON_EMPTY会过滤掉空集合),如果成员变量上的注解生效,field0就会被序列化(NON_NULL只过滤null,空集合不是null),执行结果如下图,可见是成员变量上的注解生效了:
    在这里插入图片描述

  2. 接下来保持上述代码不变,仅在getField0方法上添加JsonInclude注释,值是USE_DEFAULTS,这样在序列化过程中,调用getField0方法时,就用类注解JsonInclude的值了,即NON_EMPTY:

@JsonInclude(JsonInclude.Include.USE_DEFAULTS)
public List<String> getField0() { 
	return field0; 
}
  1. 执行修改后的代码,如下图所示,此时用的成员变量field0上的注解就不生效了,而是类注解生效,导致空集合不被序列化:
    在这里插入图片描述
    小结USE_DEFAULTS的作用如下:
    a. 类注解和成员变量注解同时存在时,以成员变量注解为准;
    b. 如果对应的get方法也使用了JsonInclude注解,并且值是USE_DEFAULTS,此时以类注解为准;

至此,JsonInclude注解的学习和实战就完成了,希望本文能给您提供参考,助您熟练使用注解来指定更精确的序列化过滤策略;

欢迎关注我的公众号:程序员欣宸

在这里插入图片描述

©️2020 CSDN 皮肤主题: 书香水墨 设计师: CSDN官方博客 返回首页
实付0元
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、C币套餐、付费专栏及课程。

余额充值