JsonInclude.Include

最近有个功能需要对Jackson做很多的个性化配置,在网上找了一圈,大部分只对配置项做了说明,无法直接看到效果。
因此,自己根据源码上的注解,对一些常见的配置做了一下测试。
如有理解错误的地方,欢迎指正、探讨,不喜勿喷,谢谢。

JsonInclude.Include枚举用于配置Jave Bean的哪些属性会被Jackson序列化。

JsonInclude.Include.ALWAYS

序列化所有属性,与属性的值无关。Jackson默认的序列化方式。
默认值情况下序列化的json:
在这里插入图片描述
设置为ALWAYS序列化的json:
在这里插入图片描述

JsonInclude.Include.NON_NULL

仅序列化非null的属性。下图中的mobileaddress属性没有被序列化。
在这里插入图片描述

JsonInclude.Include.NON_ABSENT

这个选项拥有 NON_NULL 的功能,主要作用于java.util.concurrent.atomic.AtomicReferencejava.util.Optional等类型。如果AtomicReference/Optional对象的value属性为null,则对象不会被序列化。
下面的例子中,RefObj对象的personReference属性虽然不为null,但是personReference.value为null。当选择NON_NULLpersonReference属性会被序列化;当选择NON_ABSENTpersonReference属性不会被序列化。
在这里插入图片描述

AtomicReference/Optionalvalue属性不为null时,RefObjpersonReference属性才会被序列化。
在这里插入图片描述

备注:AtomicReferenceOptional等这些类型在序列化时,它们的value属性不会出现在JSON字符串中。

注意观察下面的输出,AtomicReference对象的value属性,并没有出现在JSON中。
在这里插入图片描述

JsonInclude.Include.NON_EMPTY

这个选项拥有 NON_ABSENT 选项的功能,同时还会判断属性值是否为,如果为,则属性不会被序列化。

java.util.Collectionjava.util.Map,通过isEmpty()方法判断是否为空。
数组,长度为0,则判断为空。
字符串,长度为0,则判断为空。

在这里插入图片描述
当属性值不为空时才会被序列化。
在这里插入图片描述

JsonInclude.Include.NON_DEFAULT

这个选项拥有 NON_EMPTY 选项的功能,同时还会判断属性值是否是默认值,如果是默认值,则属性不会被序列化。
基本类型及其包装类型的默认值:
在这里插入图片描述
值为0的日期类型,例如Datejava.sql.Timestamp,不会被序列化。
在这里插入图片描述

JsonInclude.Include.CUSTOM

自定义序列化规则,通过自定义的过滤器控制Jackson的序列化行为。

自定义的过滤器无需继承特定的类或者实现特定接口,只需要重写Object的equals方法即可,当返回值是true时,属性被过滤,不会被序列化,当返回值是false时,属性才会序列化。

这个选项可以与@JsonInclude注解一起使用,用于类、属性、get方法上。如果仅用在ObjectMapper上,那么ObjectMapper序列化对象的行为与默认值一样。
在这里插入图片描述

还可以通过向ObjectMapper设置过滤器的方式自定义序列化行为。这种方式与是否配置成 JsonInclude.Include.CUSTOM 选项无关。
在这里插入图片描述

JsonInclude.Include.USE_DEFAULTS

如果一个属性被配置了多种序列化方式,那么向上找上一级配置的序列化方式。

序列化配置的优先级,从低到高依次是:
全局配置的ObjectMapper -> 在类上使用Jackson注解 -> 在类的属性上使用Jackson注解 -> get方法上使用Jackson注解。

这个选项常出现在以下这类场景:
① 在一个类上配置了该类的序列化方式;
② 在该类的某个属性上也配置了序列化方式;
③ 该属性的get方法上也配置了序列化方式;
此时在序列化该类的对象时,该属性会使用类上的配置。

例如下面的例子:
Person类上配置了NON_NULL
address属性上配置了NON_EMPTY
getAddress()方法配置了USE_DEFAULTS
在序列化Person类的对象时,address属性的序列化方式会使用类上的NON_NULL
在这里插入图片描述

这个选项可以用于在子类中修改父类属性的序列化方式。
备注:如果子类上有@JsonInclude注解,会覆盖父类上的@JsonInclude注解,但是不能覆盖父类属性上的@JsonInclude,需要通过重写get方法的方式进行覆盖。
例如下面的例子,子类上的注解覆盖了父类上的注解(weight属性被序列化了);子类中getAddress()方法上的注解,使得address属性使用了默认方式(ALWAYS),也被序列化了。
在这里插入图片描述

  • 3
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值