如何防止Map内部的空值和Bean中的空字段通过Jackson序列化

Question

我Map<String,Foo> foosMap想通过杰克逊进行序列化。现在，我要在序列化过程中进行以下两项设置：

1. Map可以具有大量的null值和null键，我不希望将null序列化。
2. 对于所有要序列化的Foos，我不想序列化Foo中引用的空对象。

实现此目标的最佳方法是什么？我在我的项目中使用jackson-core1.9和jackson-mapper1.9 jar。

Answer 1

如果合理地更改Map要序列化的原始数据结构以更好地表示要序列化的实际值，那可能是一个不错的方法，这可能会减少所需的Jackson配置量。例如，null在可能的情况下，只要致电杰克逊，就删除关键条目。那说…

要禁止序列化Map具有空值的条目：

杰克逊2.9之前

您仍然可以使用WRITE_NULL_MAP_VALUES，但请注意，它已移至SerializationFeature：

mapper.configure(SerializationFeature.WRITE_NULL_MAP_VALUES, false);

自杰克逊2.9

在WRITE_NULL_MAP_VALUES已被弃用，你可以使用下面的等价：

mapper.setDefaultPropertyInclusion(
   JsonInclude.Value.construct(Include.ALWAYS, Include.NON_NULL))

要禁止使用空值序列化属性，可以直接配置ObjectMapper或使用@JsonInclude批注：

mapper.setSerializationInclusion(Include.NON_NULL);

要么：

@JsonInclude(Include.NON_NULL)
class Foo
{
  public String bar;

  Foo(String bar)
  {
    this.bar = bar;
  }
}

据Map我所知，要处理空键，必须进行一些自定义序列化。

一种将null键序列化为空字符串的简单方法（包括前面提到的两个配置的完整示例）：

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.databind.SerializerProvider;

public class JacksonFoo
{
  public static void main(String[] args) throws Exception
  {
    Map<String, Foo> foos = new HashMap<String, Foo>();
    foos.put("foo1", new Foo("foo1"));
    foos.put("foo2", new Foo(null));
    foos.put("foo3", null);
    foos.put(null, new Foo("foo4"));

    // System.out.println(new ObjectMapper().writeValueAsString(foos));
    // Exception: Null key for a Map not allowed in JSON (use a converting NullKeySerializer?)

    ObjectMapper mapper = new ObjectMapper();
    mapper.configure(SerializationFeature.WRITE_NULL_MAP_VALUES, false);
    mapper.setSerializationInclusion(Include.NON_NULL);
    mapper.getSerializerProvider().setNullKeySerializer(new MyNullKeySerializer());
    System.out.println(mapper.writeValueAsString(foos));
    // output: 
    // {"":{"bar":"foo4"},"foo2":{},"foo1":{"bar":"foo1"}}
  }
}

class MyNullKeySerializer extends JsonSerializer<Object>
{
  @Override
  public void serialize(Object nullKey, JsonGenerator jsonGenerator, SerializerProvider unused) 
      throws IOException, JsonProcessingException
  {
    jsonGenerator.writeFieldName("");
  }
}

class Foo
{
  public String bar;

  Foo(String bar)
  {
    this.bar = bar;
  }
}

为了禁止Map使用null键序列化条目，将需要进一步的自定义序列化处理。