讲师中心 微信公众号
AI工具推荐 视频效率加速

如何在 Jackson 序列化中精准控制自定义对象字段的包含逻辑

落伟小哥_3191

落伟小哥_3191

发布时间:2026-03-08 12:21:16

|

122人浏览过

|

来源于php中文网

原创

如何在 Jackson 序列化中精准控制自定义对象字段的包含逻辑

本文详解 Jackson 中 @JsonInclude 对自定义类(如 Mgmt)的“空值”判定失效问题,通过 CUSTOM 模式配合自定义过滤器,实现仅当内部集合为空时彻底排除该字段(而非输出 "mgmt": {})。

本文详解 jackson 中 `@jsoninclude` 对自定义类(如 `mgmt`)的“空值”判定失效问题,通过 `custom` 模式配合自定义过滤器,实现仅当内部集合为空时彻底排除该字段(而非输出 `"mgmt": {}`)。

Jackson 的 @JsonInclude(JsonInclude.Include.NON_EMPTY) 是常用且便捷的序列化过滤注解,但它对“空”的判定有明确边界:仅原生支持 Collection、Map、String、数组等标准类型——不自动递归检查自定义 POJO 的内部状态。因此,即使 Mgmt 类中 values 为 new ArrayList(),Jackson 仍会将其视为“非空对象”,最终序列化为 "mgmt": {},违背业务预期。

要真正实现“当 Mgmt.values 为空列表时,完全省略 mgmt 字段”,必须启用 JsonInclude.Include.CUSTOM 模式,并提供一个语义明确的过滤器类。

✅ 正确实现方式:自定义 valueFilter

首先,定义一个过滤器类(需继承 Object 并重写 equals 方法),其返回 true 表示“该实例应被排除”:

public class MgmtEmptyFilter {
    @Override
    public boolean equals(Object obj) {
        // 若非 Mgmt 实例,不参与过滤(避免误判 null 或其他类型)
        if (!(obj instanceof Mgmt)) {
            return false;
        }
        Mgmt mgmt = (Mgmt) obj;
        // 仅当 values 为 null 或 isEmpty() 时,才排除该 mgmt 实例
        return mgmt.values == null || mgmt.values.isEmpty();
    }
}

⚠️ 注意:原始答案中 return true 用于非 Mgmt 实例是错误逻辑(会导致所有非 Mgmt 值被过滤),此处已修正为 return false,确保类型安全;核心判断聚焦于 mgmt.values 状态。

然后,在目标字段上使用 @JsonInclude 指定 CUSTOM 模式与该过滤器:

class Test {
    @JsonInclude(
        value = JsonInclude.Include.CUSTOM,
        valueFilter = MgmtEmptyFilter.class
    )
    Mgmt mgmt;
}

? 序列化效果验证

假设有以下实例:

Test test1 = new Test();
test1.mgmt = new Mgmt(); // values = null → 被排除 → 输出: {}

Test test2 = new Test();
test2.mgmt = new Mgmt();
test2.mgmt.values = Collections.emptyList(); // values.isEmpty() → 被排除 → 输出: {}

Test test3 = new Test();
test3.mgmt = new Mgmt();
test3.mgmt.values = Arrays.asList("a", "b"); // 非空 → 保留 → 输出: {"mgmt":{"values":["a","b"]}}

? 关键注意事项

  • 过滤器类必须是无参构造、线程安全的普通类,Jackson 会通过反射实例化它;
  • equals() 方法中务必先做 instanceof 类型检查,避免 ClassCastException;
  • valueFilter 仅作用于字段值本身(即 Mgmt 实例),不适用于嵌套属性;若需更复杂逻辑(如多字段联合判定),可在 equals() 中扩展;
  • 若 Mgmt 类已重写 equals(),请确保其语义与“序列化空值判定”一致,否则建议仍使用独立的 valueFilter 类以解耦关注点。

通过这一模式,你将完全掌控 Jackson 对任意自定义类型的序列化可见性,让 JSON 输出严格符合领域语义——既简洁,又精准。

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

热门AI工具

更多
Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

超级麦吉

一款通过数字员工协作完成调研、数据分析与文档制作的AI办公平台。

相关专题

更多
java
java

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

11457

2023.06.15

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

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

8562

2023.07.05

java自学难吗
java自学难吗

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

7372

2023.07.31

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

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

1224

2023.08.01

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

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

988

2023.08.02

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

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

1476

2023.08.02

java有什么用
java有什么用

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

3009

2023.08.02

java在线网站
java在线网站

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

20271

2023.08.03

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

20

2026.10.28

热门下载

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

精品课程

更多
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn