避免使用Jackson自定义JsonSerializer和JsonGenerator序列化空字段

Question

Jackson序列化到JSON有一些很好的特性，比如SerializationFeature.write_null_map_values，它允许您避免将null写入序列化对象。

但是，如果我使用自定义的JsonSerializer，这个设置将被忽略，并且我被迫在对WriteStringField的所有调用中进行空检查。例如，我注册了一个自定义的JSONSerializer：

ObjectMapper objectMapper = new ObjectMapper();
SimpleModule simpleModule = new SimpleModule();
simpleModule.addSerializer(CloudDocument.class, new ImportProductSerializer());

objectMapper.registerModule(simpleModule);

然后在ImportProductSerializer中，我不得不对要序列化的每个字段都进行空检查，这会变得丑陋和乏味：

private class ImportProductSerializer extends JsonSerializer<CloudDocument> {
    @Override
    public void serialize(CloudDocument value, 
        JsonGenerator gen, //Customize this?
        SerializerProvider serializers) throws Exception {
        gen.writeStartObject();
        gen.writeStringField("type", "add");

        //Null check here and every other field: gross!
        if(StringUtils.hasText(importProduct.getExtraListingSku1())) { 
            gen.writeStringField("extralistingsku1", importProduct.getExtraListingSku1());
        }
        gen.writeEndObject();
    }
}

我想采用的解决方案是让我的自定义JsonSerializer使用自定义JSONGenerator。serialize方法将JsonGenerator作为参数，我可以很容易地定义它，如下所示：

private class CustomGenerator extends JsonGenerator {

    @Override
    public JsonGenerator setCodec(ObjectCodec oc) {
        super.setCodec(oc);
    }


    @Override
    public void writeStringField(String fieldName, String value) throws IOException {
        if(value==null) return;
        super.writeStringField(fieldName.toLowerCase(), value);
    }
    .... //other methods implemented
}

但我不确定如何配置ObjectMapper来使用我的CustomGenerator实现。这种方法的好处是，我可以自定义writeField方法来执行空检查，并确保字段名订阅预期的命名约定，在本例中，这涉及将camelCase转换为lower_underscore。

有没有一种方法来配置通过调用ObjectMapper.WriteValue（）实例化的JsonGenerator？

Answer 1

这个问题有点无限制，因为我不知道你到底尝试了什么；有多少工作是由自定义序列化程序完成的。通常，序列化器需要委派大量的处理，以最大限度地减少它们所做的工作量。

但是，如果您已经定义了一个自定义序列化器来处理包含字段的POJO（而不是序列化为JSON字符串或其他标量值的东西的自定义序列化器），那么是的，您确实需要处理自己的检查。这部分是因为有许多方法可以潜在地改变包含；不仅仅是SerializationFeature，还包括属性的@JsonFormat注释；当将控制委托给自定义序列化器时，没有办法透明地处理这一点。

因此，是的，如果您最终使用writeStringfield()，您确实需要检查默认包含设置并适当地省略write。