配置Jackson以支持自定义序列化程序类的SerializationInclusion配置

Question

我遇到了一个非常有趣的问题，试图让Jackson在自定义序列化程序类创建的JSON中正确删除空字段。我已经非常彻底地搜索了有关序列化程序和SerializationInclusion配置的信息，但我没有找到任何可以解释我所看到的内容的东西。

我配置了一个Jackson对象映射器，并通过Spring自动连接。对象映射器配置和POJO（为简洁起见进行了编辑）看起来或多或少像下面的代码。

出于某种原因，当我调用RESTendpoint以获取包含上述示例值的Bar对象时，我看到了以下行为：

• 序列化包含设置将应用于所有本身为空或空的属性（name， aList， obId）。
• 序列化包含设置不被应用于任何由自定义序列化类设置为null的属性，并且我们返回具有null值的JSON。

我在这里的想法是，序列化器逻辑在Jackson已经从JSON中删除了所有空值和空值后被调用，因此“foo”属性被正确设置为空值，但没有被删除，因为包含逻辑已经执行。

有人对这里可能发生的事情有什么想法吗？在2.2.2版本中如何实现Jackson数据绑定库，这是一个怪癖吗？

杰克逊配置-

@Bean
public JacksonObjectMapper jacksonMapper() {
    final JacksonObjectMapper mapper = new JacksonObjectMapper();

    mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
    mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
    mapper.enable(MapperFeature.SORT_PROPERTIES_ALPHABETICALLY);
    mapper.enable(SerializationFeature.ORDER_MAP_ENTRIES_BY_KEYS);
    mapper.registerModule(agJacksonModule());

    return mapper;
}

@Bean
public SimpleModule agJacksonModule() {
    final SimpleModule module = new SimpleModule();

    module.addSerializer(Foo.class, new FooSerializer());

    return module;
}

自定义序列化-

public class FooSerializer extends JsonSerializer<Foo> {

@Override
public void serialize(Sponsor sponsor, JsonGenerator jsonGenerator, SerializerProvider serializerProvider)
        throws IOException {

    // write null value for sponsor json property, if sponsor object has all empty or null fields
    if(sponsor == null || isObjectEmpty(sponsor)) {
        jsonGenerator.writeNull();
        return;
    }

    // write out object
    jsonGenerator.writeStartObject();
    jsonGenerator.writeStringField("imgUrl", sponsor.getImgUrl());
    jsonGenerator.writeStringField("clickUrl", sponsor.getClickUrl());
    jsonGenerator.writeStringField("sponsorName", sponsor.getSponsorName());
    jsonGenerator.writeStringField("sponsorText", sponsor.getSponsorText());
    jsonGenerator.writeEndObject();

}

private boolean isObjectEmpty(Sponsor sponsor) {
    return Strings.isNullOrEmpty(sponsor.getClickUrl())
            && Strings.isNullOrEmpty(sponsor.getImgUrl())
            && Strings.isNullOrEmpty(sponsor.getSponsorName())
            && Strings.isNullOrEmpty(sponsor.getSponsorText());
}

}

对象模型看起来像这样（为了简洁，再次编辑，示例值作为示例数据设置在类成员上）：

巴波乔-

public abstract class Bar {

    protected Foo foo = aFoo;
    protected String name = "";
    protected ArrayList aList = Lists.newArrayList();
    protected String objId = null;

    // some getters and setters for the above properties 
}

福波乔-

public abstract class Foo {

    protected String aString = "";
    protected String bString = "";
    protected String cString = "";
    protected String dString = "";

    // some getters and setters for the above properties
}

Answer 1

重写并实现JsonSerializer的isEmpty方法以实现您想要的。

自定义定义什么

public boolean isEmpty(SerializerProvider provider, T value);

请注意，调用方在写入字段名时必须进行过滤；只有在需要实际序列化时才会调用序列化程序。