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

Question

我有一个 Map<String,Foo> foosMap我想通过 Jackson 序列化。现在我想在序列化过程中进行以下两个设置:

1. Map 可以有很多空值和空键，我不希望空值被序列化。
2. 对于所有正在序列化的 Foo，我不想序列化 Foo 中引用的空对象。

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

Answer 1

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

---

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

在 jackson 2.9 之前

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

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))

---

要禁止序列化具有空值的属性，您可以 configure the ObjectMapper directly ，或使用 @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 条目，需要进一步的自定义序列化处理。