如何防止Map中的null值和bean中的null字段通过Jackson序列化

Question

1. 映射可能有大量的空值和空键，我不希望空值被序列化。
2. 对于正在序列化的所有foo，我不想序列化foo中引用的null对象。

实现这一点的最佳方法是什么？我正在我的项目中使用Jackson-Core1.9和Jackson-Mapper1.9 JAR。

Answer 1

如果更改要序列化的原始map数据结构以更好地表示要序列化的实际值是合理的，那么这可能是一种不错的方法，它可能会减少所需的Jackson配置量。例如，如果可能，只需在调用Jackson之前删除null键项。上面说...

取消序列化具有空值的map项：

Jackson 2.9之前

mapper.configure(SerializationFeature.WRITE_NULL_MAP_VALUES, false);

自Jackson 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;
  }
}

若要取消序列化具有null键的map条目，则需要进一步的自定义序列化处理。