使用Jackson仅序列化满足自定义条件的字段

1. 概述

本教程将展示如何使用Jackson来根据特定自定义条件仅序列化字段。

例如，如果我们只想在整数值为正时序列化它，如果不满足这个条件，则完全跳过。

如果你想要深入了解如何使用Jackson 2的其他酷炫功能，请访问主Jackson教程。

2. 使用Jackson过滤器控制序列化过程

首先，我们需要在实体上使用@JsonFilter注解定义过滤器：

@JsonFilter("myFilter")
public class MyDto {
    private int intValue;

    public MyDto() {
        super();
    }

    public int getIntValue() {
        return intValue;
    }

    public void setIntValue(int intValue) {
        this.intValue = intValue;
    }
}

然后，我们需要定义我们自己的PropertyFilter：

PropertyFilter theFilter = new SimpleBeanPropertyFilter() {
   @Override
   public void serializeAsField
    (Object pojo, JsonGenerator jgen, SerializerProvider provider, PropertyWriter writer)
     throws Exception {
      if (include(writer)) {
         if (!writer.getName().equals("intValue")) {
            writer.serializeAsField(pojo, jgen, provider);
            return;
         }
         int intValue = ((MyDtoWithFilter) pojo).getIntValue();
         if (intValue >= 0) {
            writer.serializeAsField(pojo, jgen, provider);
         }
      } else if (!jgen.canOmitFields()) { // since 2.3
         writer.serializeAsOmittedField(pojo, jgen, provider);
      }
   }
   @Override
   protected boolean include(BeanPropertyWriter writer) {
      return true;
   }
   @Override
   protected boolean include(PropertyWriter writer) {
      return true;
   }
};

这个过滤器包含实际逻辑，根据整数值的值决定intValue字段是否会被序列化。

接下来，我们将这个过滤器与ObjectMapper关联起来，然后序列化一个实体：

FilterProvider filters = new SimpleFilterProvider().addFilter("myFilter", theFilter);
MyDto dtoObject = new MyDto();
dtoObject.setIntValue(-1);

ObjectMapper mapper = new ObjectMapper();
String dtoAsString = mapper.writer(filters).writeValueAsString(dtoObject);

最后，我们可以检查intValue字段确实没有出现在序列化后的JSON输出中：

assertThat(dtoAsString, not(containsString("intValue")));

3. 根据属性值有条件地跳过对象

现在，让我们讨论如何根据属性值在序列化时跳过对象。我们将跳过所有hidden属性为true的对象：

3.1. 可隐藏类

首先，我们来看看Hidable接口：

@JsonIgnoreProperties("hidden")
public interface Hidable {
    boolean isHidden();
}

我们有两个简单的实现了此接口的类：Person和Address：

Person类：

public class Person implements Hidable {
    private String name;
    private Address address;
    private boolean hidden;
}

Address类：

public class Address implements Hidable {
    private String city;
    private String country;
    private boolean hidden;
}

注意：我们使用了@JsonIgnoreProperties("hidden")来确保hidden属性本身不包含在JSON中

3.2. 自定义序列化器

接下来是我们的自定义序列化器：

public class HidableSerializer extends JsonSerializer<Hidable> {

    private JsonSerializer<Object> defaultSerializer;

    public HidableSerializer(JsonSerializer<Object> serializer) {
        defaultSerializer = serializer;
    }

    @Override
    public void serialize(Hidable value, JsonGenerator jgen, SerializerProvider provider)
      throws IOException, JsonProcessingException {
        if (value.isHidden())
            return;
        defaultSerializer.serialize(value, jgen, provider);
    }

    @Override
    public boolean isEmpty(SerializerProvider provider, Hidable value) {
        return (value == null || value.isHidden());
    }
}

请注意：

当对象不会被跳过时，我们委托给默认注入的序列化器进行序列化。
我们重写了isEmpty()方法 - 以确保如果Hidable对象是属性，属性名称也会从JSON中排除。

3.3. 使用`BeanSerializerModifier`

最后，我们需要使用BeanSerializerModifier在自定义HidableSerializer中注入默认序列化器，如下所示：

ObjectMapper mapper = new ObjectMapper();
mapper.setSerializationInclusion(Include.NON_EMPTY);
mapper.registerModule(new SimpleModule() {
    @Override
    public void setupModule(SetupContext context) {
        super.setupModule(context);
        context.addBeanSerializerModifier(new BeanSerializerModifier() {
            @Override
            public JsonSerializer<?> modifySerializer(
              SerializationConfig config, BeanDescription desc, JsonSerializer<?> serializer) {
                if (Hidable.class.isAssignableFrom(desc.getBeanClass())) {
                    return new HidableSerializer((JsonSerializer<Object>) serializer);
                }
                return serializer;
            }
        });
    }
});

3.4. 示例输出

这里有一个简单的序列化示例：

Address ad1 = new Address("tokyo", "jp", true);
Address ad2 = new Address("london", "uk", false);
Address ad3 = new Address("ny", "usa", false);
Person p1 = new Person("john", ad1, false);
Person p2 = new Person("tom", ad2, true);
Person p3 = new Person("adam", ad3, false);

System.out.println(mapper.writeValueAsString(Arrays.asList(p1, p2, p3)));

输出结果如下：

[
    {
        "name":"john"
    },
    {
        "name":"adam",
        "address":{
            "city":"ny",
            "country":"usa"
        }
    }
]

3.5. 测试

最后，这里有一些测试用例：

第一种情况，没有任何东西被隐藏：

@Test
public void whenNotHidden_thenCorrect() throws JsonProcessingException {
    Address ad = new Address("ny", "usa", false);
    Person person = new Person("john", ad, false);
    String result = mapper.writeValueAsString(person);

    assertTrue(result.contains("name"));
    assertTrue(result.contains("john"));
    assertTrue(result.contains("address"));
    assertTrue(result.contains("usa"));
}

接下来，只有地址被隐藏：

@Test
public void whenAddressHidden_thenCorrect() throws JsonProcessingException {
    Address ad = new Address("ny", "usa", true);
    Person person = new Person("john", ad, false);
    String result = mapper.writeValueAsString(person);

    assertTrue(result.contains("name"));
    assertTrue(result.contains("john"));
    assertFalse(result.contains("address"));
    assertFalse(result.contains("usa"));
}

现在，整个Person被隐藏：

@Test
public void whenAllHidden_thenCorrect() throws JsonProcessingException {
    Address ad = new Address("ny", "usa", false);
    Person person = new Person("john", ad, true);
    String result = mapper.writeValueAsString(person);

    assertTrue(result.length() == 0);
}

4. 总结

这种高级过滤功能非常强大，能够灵活定制复杂对象的Jackson序列化JSON。

一个更灵活但更复杂的替代方案是使用完全自定义的序列化器来控制JSON输出。如果这个解决方案不够灵活，可能值得进一步研究。

所有这些示例和代码片段的实现可以在GitHub上找到 - 这是一个基于Maven的项目，因此导入并运行起来应该很容易。

Persistence

REST

Security