jackson学习之五：JsonInclude注解

这里分类和汇总了欣宸的全部原创(含配套源码)：https://github.com/zq2599/blog_demos

系列文章汇总

• jackson学习之一：基本信息

• jackson学习之二：jackson-core

• jackson学习之三：常用API操作

• jackson学习之四：WRAP_ROOT_VALUE（root对象）

• jackson学习之五：JsonInclude注解

• jackson学习之六：常用类注解

• jackson学习之七：常用Field注解

• jackson学习之八：常用方法注解

• jackson学习之九：springboot整合(配置文件)

• jackson学习之十(终篇)：springboot整合(配置类)

本篇概览

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协议 |

2. 这个git项目中有多个文件夹，本章的应用在jacksondemo文件夹下，如下图红框所示：

3. jacksondemo是父子结构的工程，本篇的代码在annotation子工程中，里面的jsoninclude这个package下，如下图：

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

ALWAYS

ALWAYS表示全部序列化，如下图，null和空字符串都会序列化：

NON_NULL

NON_NULL好理解，就是值为null就不序列化：

NON_ABSENT

1. NON_ABSENT略为复杂，当实例化的对象有Optional或AtomicReference类型的成员变量时，如果Optional引用的实例为空，用NON_ABSENT能使该字段不做序列化；

2. Optional是java用来优雅处理空指针的一个特性，本文中不做过多说明，请您自行查阅相关文档；

3. 要让Jackson支持Optional特性，必须做两件事，首先是在pom.xml中添加以下依赖：

com.fasterxml.jackson.datatype

jackson-datatype-jdk8

2.11.0

4. 其次是代码中执行以下设置：

mapper.registerModule(new Jdk8Module());

5. 咱们先看看设置成NON_NULL时jackson对Optional和AtomicReference的处理，下面的代码中，Optional和AtomicReference的引用都是空，但还是被序列化出来了：

![在这里插入图片描述](https://img-blog.csdnimg.cn/20200905112007611.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdG

必看视频！获取2024年最新Java开发全套学习资料 备注Java

k,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5,size_16,color_FFFFFF,t_70#pic_center)

6. 代码不变，将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;

3. 来看看CustomFilter类的代码，如下所示，只有equals方法，可见：null、非字符串、长度大于2这三种情况都返回true，也就是说这三种情况下都不会被序列化：

static class CustomFilter {

@Override

public boolean equals(Object obj) {

// null，或者不是字符串就返回true，意味着不被序列化

if(null==obj || !(obj instanceof String)) {

return true;

}

最后

每年转战互联网行业的人很多，说白了也是冲着高薪去的，不管你是即将步入这个行业还是想转行，学习是必不可少的。作为一个Java开发，学习成了日常生活的一部分，不学习你就会被这个行业淘汰，这也是这个行业残酷的现实。

如果你对Java感兴趣，想要转行改变自己，那就要趁着机遇行动起来。或许，这份限量版的Java零基础宝典能够对你有所帮助。

|| !(obj instanceof String)) {

return true;

}

最后

每年转战互联网行业的人很多，说白了也是冲着高薪去的，不管你是即将步入这个行业还是想转行，学习是必不可少的。作为一个Java开发，学习成了日常生活的一部分，不学习你就会被这个行业淘汰，这也是这个行业残酷的现实。

如果你对Java感兴趣，想要转行改变自己，那就要趁着机遇行动起来。或许，这份限量版的Java零基础宝典能够对你有所帮助。

[外链图片转存中…(img-ZjaufHWY-1716445337297)]