如何通过Jackson的PropertyFilter动态阻止特定字段序列化

我完全理解你的困扰——用类级别的@JsonFilter确实会干扰集合序列化的包装逻辑，而字段级别的过滤器配置又没摸透门道。下面给你两种可靠的解决方案，既满足按值过滤字段的需求，又不会破坏列表这类集合的序列化：

方案一：用@JsonInclude自定义字段过滤（推荐，Jackson 2.9+） #

Jackson 2.9及以上版本支持通过@JsonInclude的valueFilter参数，为单个字段指定值过滤规则，这是最简洁的注解驱动方式：

步骤1：定义自定义过滤类 #

这些类通过重写equals方法来判断是否需要过滤字段值：

// 过滤int类型的0值
public class IntZeroFilter {
    @Override
    public boolean equals(Object obj) {
        return obj instanceof Integer && ((Integer) obj).intValue() == 0;
    }
}

// 过滤boolean类型的false值
public class BooleanFalseFilter {
    @Override
    public boolean equals(Object obj) {
        return obj instanceof Boolean && !((Boolean) obj);
    }
}

步骤2：在字段上添加注解 #

直接在MyPojo的字段上配置对应的过滤器：

class MyPojo {
    @JsonInclude(value = JsonInclude.Include.CUSTOM, valueFilter = IntZeroFilter.class)
    private int myInt;

    @JsonInclude(value = JsonInclude.Include.CUSTOM, valueFilter = BooleanFalseFilter.class)
    private boolean myBoolean;

    // getters、setters 省略
}

这种方式是字段级别的配置，完全不会影响集合序列化的包装逻辑，测试列表序列化时会正常输出数组结构。

方案二：用BeanSerializerModifier全局配置（兼容低版本Jackson） #

如果你的Jackson版本低于2.9，可以通过修改BeanSerializerModifier来全局控制字段的序列化条件，这种方式更灵活，也不会破坏集合序列化：

步骤1：自定义BeanSerializerModifier #

遍历所有字段，根据类型设置序列化包含条件：

public class CustomFieldFilterModifier extends BeanSerializerModifier {
    @Override
    public List<BeanPropertyWriter> changeProperties(SerializationConfig config, BeanDescription beanDesc, List<BeanPropertyWriter> beanProperties) {
        for (BeanPropertyWriter writer : beanProperties) {
            Class<?> fieldType = writer.getType().getRawClass();
            // 处理int/Integer类型，值为0则不序列化
            if (int.class.equals(fieldType) || Integer.class.equals(fieldType)) {
                writer.setIncludeInJson(value -> !(value instanceof Integer && ((Integer) value) == 0));
            }
            // 处理boolean/Boolean类型，值为false则不序列化
            else if (boolean.class.equals(fieldType) || Boolean.class.equals(fieldType)) {
                writer.setIncludeInJson(value -> !(value instanceof Boolean && !((Boolean) value)));
            }
        }
        return beanProperties;
    }
}

步骤2：注册到ObjectMapper #

把自定义的Modifier注册到Jackson的核心对象中：

ObjectMapper mapper = new ObjectMapper();
SimpleModule module = new SimpleModule();
module.setSerializerModifier(new CustomFieldFilterModifier());
mapper.registerModule(module);

为什么类级@JsonFilter会破坏列表序列化？ #

当你在类上添加@JsonFilter时，Jackson会对该类的所有实例（包括集合中的每个元素）强制应用过滤器逻辑。但集合序列化的默认逻辑依赖于类的元数据完整性，过滤器的介入可能干扰了Jackson对集合包装结构的处理，导致序列化结果不符合预期。而上面两种方案都是针对单个字段的精准控制，不会影响类的元数据，因此集合序列化可以正常工作。

测试验证 #

用下面的代码测试两种方案：

MyPojo emptyPojo = new MyPojo();
emptyPojo.setMyInt(0);
emptyPojo.setMyBoolean(false);

MyPojo filledPojo = new MyPojo();
filledPojo.setMyInt(10);
filledPojo.setMyBoolean(true);

List<MyPojo> pojoList = Arrays.asList(emptyPojo, filledPojo);

// 输出：{}
System.out.println(mapper.writeValueAsString(emptyPojo));
// 输出：{"myInt":10,"myBoolean":true}
System.out.println(mapper.writeValueAsString(filledPojo));
// 输出：[{},{"myInt":10,"myBoolean":true}]（列表结构完全正常）
System.out.println(mapper.writeValueAsString(pojoList));

内容的提问来源于stack exchange，提问作者Matthew Olsson