
本文讲解如何在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
要真正按业务逻辑剔除mgmt字段,需显式定义“空”的语义:当Mgmt.values为空列表时,该Mgmt实例应被排除。Jackson支持通过@JsonInclude(value = CUSTOM, valueFilter = ...)机制实现这一目标。
✅ 正确实现方式:自定义valueFilter
首先,编写一个过滤器类,重写equals()方法(注意:此处equals()的语义是“是否应被排除”,返回true表示跳过序列化):
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高级特性的核心价值:在标准化能力之上,精准表达领域规则。










