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

Question

我Map<String,Foo> foosMap想要通过杰克逊序列化.现在我想在序列化过程中遵循两个设置:

1. Map可以有很多空值和null键,我不希望空序列化.
2. 对于所有那些被序列化的Foo,我不想序列化Foo中引用的null对象.

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

Answer 1

如果将原始Map数据结构更改为序列化以更好地表示想要序列化的实际值是合理的,那么这可能是一种不错的方法,这可能会减少所需的Jackson配置量.例如,null在调用Jackson之前,如果可能,只需删除密钥条目.那说......

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

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

要处理null 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键序列化条目,需要进一步的自定义序列化处理.

Answer 2

对于Jackson版本<2.0,在序列化的类上使用此注释:

@JsonSerialize(include=JsonSerialize.Inclusion.NON_NULL)