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

json java jackson

2022-08-31 16:31:21

我有一个我想通过杰克逊序列化的。现在，我希望在序列化过程中遵循以下两个设置：Map<String,Foo> foosMap

Map 可以具有大量空值和空键，我不希望序列化空值。
对于所有正在序列化的 Foo，我不想序列化 Foo 中引用的空对象。

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

答案 1

如果更改要序列化的原始数据结构以更好地表示要序列化的实际值是合理的，那么这可能是一个不错的方法，这可能会减少所需的Jackson配置量。例如，如果可能，只需在呼叫 Jackson 之前删除密钥条目即可。可是。。。Mapnull

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

在杰克逊之前 2.9

您仍然可以使用，但请注意，它已移至序列化功能：WRITE_NULL_MAP_VALUES

mapper.configure(SerializationFeature.WRITE_NULL_MAP_VALUES, false);

自杰克逊 2.9 起

已弃用，您可以使用以下等效项：WRITE_NULL_MAP_VALUES

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

若要禁止序列化具有 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;
  }
}

若要禁止使用键序列化条目，需要进一步的自定义序列化处理。Mapnull

答案 2

对于 Jackson 版本 < 2.0，请在正在序列化的类上使用以下注释：

@JsonSerialize(include=JsonSerialize.Inclusion.NON_NULL)