0

0

JSON序列化中自定义对象的空值排除策略

花韻仙語

花韻仙語

发布时间:2026-03-08 11:03:11

|

502人浏览过

|

来源于php中文网

原创

JSON序列化中自定义对象的空值排除策略

本文讲解如何在Jackson中正确排除自定义POJO(如Mgmt)的空实例,解决@JsonInclude(JsonInclude.Include.NON_EMPTY)对嵌套对象无效的问题,通过自定义valueFilter实现基于业务语义的“空”判定。

本文讲解如何在jackson中正确排除自定义pojo(如mgmt)的空实例,解决`@jsoninclude(jsoninclude.include.non_empty)`对嵌套对象无效的问题,通过自定义`valuefilter`实现基于业务语义的“空”判定。

在使用Jackson进行JSON序列化时,@JsonInclude(JsonInclude.Include.NON_EMPTY) 是一个常用注解,用于跳过值为null、空字符串、空集合等“空态”字段。但该策略对自定义对象类型(如Mgmt)默认不生效——因为Jackson无法自动推断Mgmt类何时算“空”。即使其内部字段(如List values)为空,Mgmt实例本身仍被视为非空对象,导致序列化结果中出现冗余的 "mgmt": {}。

要真正按业务逻辑剔除mgmt字段,需显式定义“空”的语义:当Mgmt.values为空列表时,该Mgmt实例应被排除。Jackson支持通过@JsonInclude(value = CUSTOM, valueFilter = ...)机制实现这一目标。

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

首先,编写一个过滤器类,重写equals()方法(注意:此处equals()的语义是“是否应被排除”,返回true表示跳过序列化):

AI封面生成器
AI封面生成器

专业的AI封面生成工具,支持小红书、公众号、小说、红包、视频封面等多种类型,一键生成高质量封面图片。

下载
public class MgmtIsEmptyFilter {
    @Override
    public boolean equals(Object obj) {
        // 若非Mgmt实例,不参与过滤(保留原行为)
        if (!(obj instanceof Mgmt)) {
            return false;
        }
        Mgmt mgmt = (Mgmt) obj;
        // 当values为null或空时,视为"空",返回true → 被排除
        return mgmt.values == null || mgmt.values.isEmpty();
    }
}

⚠️ 注意:valueFilter类的equals()方法不是用于对象相等性比较,而是Jackson调用它来判断“当前值是否应被忽略”。返回true即触发排除。

然后,在目标字段上应用该过滤器:

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

class Mgmt {
    List<String> values; // 无需额外@JsonInclude,由过滤器统一控制
}

? 序列化效果对比

mgmt.values 状态 默认 NON_EMPTY 行为 使用 MgmtIsEmptyFilter 后
null "mgmt": {} 字段完全省略
new ArrayList() "mgmt": {} 字段完全省略
Arrays.asList("a") "mgmt": {"values":["a"]} 正常序列化

? 关键注意事项

  • valueFilter仅适用于字段级注解,不能用于类级别(@JsonInclude在类上时valueFilter无效);
  • 过滤器类必须是无参构造、可被Jackson反射实例化的普通类(推荐使用static内部类或独立类);
  • 若Mgmt有多个判空维度(如同时检查values和id),可在equals()中扩展逻辑;
  • 替代方案(如@JsonInclude(JsonInclude.Include.NON_NULL) + 手动置null)虽简单,但破坏了领域对象状态完整性,不推荐用于复杂业务场景。

通过自定义valueFilter,你将序列化控制权交还给业务语义——这正是Jackson高级特性的核心价值:在标准化能力之上,精准表达领域规则。

热门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

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

252

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

1049

2024.03.01

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

738

2023.08.03

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

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

23

2026.03.06

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 10万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.3万人学习

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

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