Jackson序列化和反序列化忽略字段操作

Z时代
2024-01-10
分类：综合

一、设置Jackson序列化时只包含不为空的字段

new ObjectMapper().setSerializationInclusion(Include.NON_NULL);

二、设置在反序列化时忽略在JSON字符串中存在，而在Java中不存在的属性

new ObjectMapper.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);

三、Jackson序列化时忽略字段的方式

1、方式一：FilterProvider

a)在需要忽略某些字段的bean上添加@JsonFilter("fieldFilter")

b)ObjectMapper设置过滤器


  FilterProvider filterProvider = new SimpleFilterProvider();
  SimpleBeanPropertyFilter fieldFilter = SimpleBeanPropertyFilter().serializeAllExcept("name");
  filterProvider.addFilter("fieldFilter");
  new ObjectMapper.setFilters(filterProvider );

2、方式二：使用@JsonIgnore

在需要忽略的字段上标注注解@JsonIgnore,在序列化时即可忽略该字段

补充知识：Jackson 序列化对象成 JSON 字符串，忽略部分字段（属性）

1、属性上加 @JsonIgnore

这种方式作用于全局，只要是有这个对象的序列化，就会忽略注解过的这部分字段。

2、上面那种方式需要在 bean 上加注解，作用于全局，但是有的时候，我们可能不需要在所有情况下都忽略这个对象的这些字段，下面这种方式可以支持定制过滤方式。


public final class JsonFilterUtil {
  /**
   * 添加过滤的字段，这里过滤的是 ThinActivityInfo 这个 bean 下的 
   * "startAt", "expiredAt", "extra" 三个字段
   */
  public static void addFilterForMapper(ObjectMapper mapper) {
    SimpleBeanPropertyFilter fieldFilter = SimpleBeanPropertyFilter.serializeAllExcept(
        Sets.newHashSet("startAt", "expiredAt", "extra"));
    SimpleFilterProvider filterProvider = new SimpleFilterProvider().addFilter("fieldFilter", fieldFilter);
    mapper.setFilterProvider(filterProvider).addMixIn(ThinActivityInfo.class, FieldFilterMixIn.class);
  }
  /**
   * 定义一个类或接口
   */
  @JsonFilter("fieldFilter")
  interface FieldFilterMixIn{
  }
}