0

0

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

花韻仙語

花韻仙語

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

|

102人浏览过

|

来源于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 状态。

Veed AI Voice Generator
Veed AI Voice Generator

Veed推出的AI语音生成器

下载

然后,在目标字段上使用 @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工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

453

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

546

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

331

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

82

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

970

2023.08.02

线程和进程的区别
线程和进程的区别

线程和进程的区别:线程是进程的一部分,用于实现并发和并行操作,而线程共享进程的资源,通信更方便快捷,切换开销较小。本专题为大家提供线程和进程区别相关的各种文章、以及下载和课程。

763

2023.08.10

golang map内存释放
golang map内存释放

本专题整合了golang map内存相关教程,阅读专题下面的文章了解更多相关内容。

77

2025.09.05

golang map相关教程
golang map相关教程

本专题整合了golang map相关教程,阅读专题下面的文章了解更多详细内容。

40

2025.11.16

JavaScript浏览器渲染机制与前端性能优化实践
JavaScript浏览器渲染机制与前端性能优化实践

本专题围绕 JavaScript 在浏览器中的执行与渲染机制展开,系统讲解 DOM 构建、CSSOM 解析、重排与重绘原理,以及关键渲染路径优化方法。内容涵盖事件循环机制、异步任务调度、资源加载优化、代码拆分与懒加载等性能优化策略。通过真实前端项目案例,帮助开发者理解浏览器底层工作原理,并掌握提升网页加载速度与交互体验的实用技巧。

23

2026.03.06

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号