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

时间:2012-07-12 09:48:00

标签: java json jackson

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

  1. Map可以有很多空值和空键,我不希望空序列化。
  2. 对于所有那些被序列化的Foo,我不想序列化Foo中引用的空对象。
  3. 实现这一目标的最佳方法是什么?我在我的项目中使用jackson-core1.9和jackson-mapper1.9罐子。

4 个答案:

答案 0 :(得分:106)

如果将要序列化的原始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;
  }
}

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

答案 1 :(得分:19)

对于Jackson版本&lt; 2.0在被序列化的类上使用此注释:

@JsonSerialize(include=JsonSerialize.Inclusion.NON_NULL)

答案 2 :(得分:3)

答案似乎有点旧,我做的是使用此映射器转换MAP

      ObjectMapper mapper = new ObjectMapper().configure(SerializationConfig.Feature.WRITE_NULL_MAP_VALUES, false);

一个简单的Map

          Map<String, Object> user = new HashMap<String,Object>();
            user.put( "id",  teklif.getAccount().getId() );
            user.put( "fname", teklif.getAccount().getFname());
            user.put( "lname", teklif.getAccount().getLname());
            user.put( "email", teklif.getAccount().getEmail());
            user.put( "test", null);

像这样使用它:

      String json = mapper.writeValueAsString(user);

答案 3 :(得分:0)

我的解决方案,希望能帮助你 自定义ObjectMapper和配置为spring xml(注册消息转发器)

public class PyResponseConfigObjectMapper extends ObjectMapper {
public PyResponseConfigObjectMapper() {
    disable(SerializationFeature.WRITE_NULL_MAP_VALUES); //map no_null
    setSerializationInclusion(JsonInclude.Include.NON_NULL); // bean no_null
}

}