如何在 Jackson 序列化中忽略空的 Optional 字段

夏涛小哥_7992

夏涛小哥_7992

2026-10-10

806人浏览

原创

如何在 Jackson 序列化中忽略空的 Optional 字段

Jackson 默认将 Optional 的空值序列化为 null,需配置 @JsonInclude(JsonInclude.Include.NON_ABSENT) 或改用非 Optional 的字段设计,才能实现对空 Optional 字段(如 Optional.empty())的完全忽略。

jackson 默认将 `optional` 的空值序列化为 `null`,需配置 `@jsoninclude(jsoninclude.include.non_absent)` 或改用非 `optional` 的字段设计,才能实现对空 `optional` 字段(如 `optional.empty()`)的完全忽略。

在使用 Jackson 处理 Java 8+ 的 Optional 类型时,一个常见误区是期望 JsonInclude.Include.NON_NULL 能自动跳过 Optional.empty()——但事实并非如此。因为 Optional.empty() 是一个非 null 的对象实例,它不等于 null,因此 NON_NULL 策略对其无效,最终仍会输出 "secondName": null。

✅ 正确解决方案是使用 JsonInclude.Include.NON_ABSENT:
该策略专为“缺席值”(absent value)设计,Jackson 的 Jdk8Module 会将 Optional.empty() 映射为 ABSENT,从而在序列化时彻底排除该字段。

✅ 正确配置示例

// 启用 Jdk8Module 并设置全局包含策略
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.registerModule(new Jdk8Module());
objectMapper.setSerializationInclusion(JsonInclude.Include.NON_ABSENT); // 关键:替换 NON_NULL

// 或对特定字段加注解(更灵活)
class Employee {
    private String firstName;
    private String secondName;

    @JsonInclude(JsonInclude.Include.NON_ABSENT)
    public Optional<string> getFirstName() {
        return Optional.ofNullable(firstName);
    }

    @JsonInclude(JsonInclude.Include.NON_ABSENT)
    public Optional<string> getSecondName() {
        return Optional.ofNullable(secondName);
    }

    // setters...
}</string></string>

此时,当 secondName 为 null 时,getSecondName() 返回 Optional.empty(),序列化结果即为:

{"firstName":"foo"}

⚠️ 重要提醒:

  • NON_ABSENT 仅对 Jackson 认可的“可选类型”(如 Optional, OptionalInt, OptionalLong 等)生效,前提是已注册 Jdk8Module;
  • 不建议将 Optional 作为实体类的字段访问器返回类型(如本例中的 getter)。根据 Java 官方文档,Optional 主要用于方法返回值以明确表达“无结果”,而非作为属性封装器——这既违背其设计初衷,也增加序列化/反序列化的复杂性;
  • 更推荐的实践是:保持字段为普通类型(如 String),在业务逻辑中按需构造 Optional,例如 Optional.ofNullable(employee.getFirstName())。

? 总结:若必须使用 Optional getter,请务必搭配 NON_ABSENT + Jdk8Module;但长期来看,重构为非 Optional 的 POJO 字段设计,才是清晰、高效且符合 Jackson 与 Java 生态惯例的方案。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

10157

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

7302

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

6412

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1104

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

908

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1336

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2669

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

19991

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1195

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习