江上孤舟sky.jpg
1.概述
本文将展示如何使用Jackson 2.x将对象序列化为JSON时忽略某些字段。
将对象转换为json时，对象的属性以及set、get方法在某些情况下无法修改，而且默认的字段不符合json字段的要求，我们还需要精确地控制哪些内容被序列化为JSON，这些问题Jackson 都能很好的帮我们处理。
有以下几种方法可以忽略属性。
2.类级别注释忽略字段
我们可以使用类级别注释@ JsonIgnoreProperties来忽略特定字段，在注释的value中指定要忽略的字段：
@JsonIgnoreProperties(value = { "intValue" })
public class MyDto {
private String stringValue;
private int intValue;
private boolean booleanValue;
public MyDto() {
super();
}
// standard setters and getters are not shown
}
我们可以测试将对象写入JSON之后，该字段确实不是输出的一部分：
@Test
public void givenFieldIsIgnoredByName_whenDtoIsSerialized_thenCorrect()
throws JsonParseException, IOException {
ObjectMapper mapper = new ObjectMapper();
MyDto dtoObject = new MyDto();
String dtoAsString = mapper.writeValueAsString(dtoObject);
assertThat(dtoAsString, not(containsString("intValue")));
}
3.字段级别注释忽略字段
我们可以直接在该字段上使用@ JsonIgnore注释来忽略此字段：
public class MyDto {
private String stringValue;
@JsonIgnore
private int intValue;
private boolean booleanValue;
public MyDto() {
super();
}
// standard setters and getters are not shown
}
我们可以测试intValue字段确实不属于序列化JSON输出的一部分：
@Test
public void givenFieldIsIgnoredDirectly_whenDtoIsSerialized_thenCorrect()
throws JsonParseException, IOException {
ObjectMapper mapper = new ObjectMapper();
MyDto dtoObject = new MyDto();
String dtoAsString = mapper.writeValueAsString(dtoObject);
assertThat(dtoAsString, not(containsString("intValue")));
}
4.按类型忽略所有字段
我们可以使用@ JsonIgnoreType注解忽略指定类型的所有字段。如果我们控制类型，那么我们可以直接注释类：
@JsonIgnoreType
public class SomeType { ... }
但是，我们常常无法控制类本身。在这种情况下，我们可以充分利用Jackson mixins。
首先，我们为要忽略的类型定义一个MixIn，并使用@JsonIgnoreType进行注释：
@JsonIgnoreType
public class MyMixInForIgnoreType {}
然后，我们在编组期间注册该mixin来替换（并忽略）所有String []类型：
mapper.addMixInAnnotations(String[].class, MyMixInForIgnoreType.class);
此时，所有String数组都将被忽略，而不是封送为JSON：
@Test
public final void givenFieldTypeIsIgnored_whenDtoIsSerialized_thenCorrect()
throws JsonParseException, IOException {
ObjectMapper mapper = new ObjectMapper();
mapper.addMixIn(String[].class, MyMixInForIgnoreType.class);
MyDtoWithSpecialField dtoObject = new MyDtoWithSpecialField();
dtoObject.setBooleanValue(true);
String dtoAsString = mapper.writeValueAsString(dtoObject);
assertThat(dtoAsString, containsString("intValue"));
assertThat(dtoAsString, containsString("booleanValue"));
assertThat(dtoAsString, not(containsString("stringValue")));
}
这是我们的DTO：
public class MyDtoWithSpecialField {
private String[] stringValue;
private int intValue;
private boolean booleanValue;
}
注意:从2.5版本开始，我们不能使用这个方法来忽略基本数据类型，但是我们可以使用它来定制数据类型和数组。
5.使用过滤器忽略字段
我们还可以使用过滤器来忽略 Jackson中的特定字段。首先，我们需要在Java对象上定义过滤器：
@JsonFilter("myFilter")
public class MyDtoWithFilter { ... }
然后，我们定义一个简单的过滤器，该过滤器将忽略intValue字段：
SimpleBeanPropertyFilter theFilter = SimpleBeanPropertyFilter
.serializeAllExcept("intValue");
FilterProvider filters = new SimpleFilterProvider()
.addFilter("myFilter", theFilter);
现在我们可以序列化对象，并确保JSON输出中不存在intValue字段：
@Test
public final void givenTypeHasFilterThatIgnoresFieldByName_whenDtoIsSerialized_thenCorrect()
throws JsonParseException, IOException {
ObjectMapper mapper = new ObjectMapper();
SimpleBeanPropertyFilter theFilter = SimpleBeanPropertyFilter
.serializeAllExcept("intValue");
FilterProvider filters = new SimpleFilterProvider()
.addFilter("myFilter", theFilter);
MyDtoWithFilter dtoObject = new MyDtoWithFilter();
String dtoAsString = mapper.writer(filters).writeValueAsString(dtoObject);
assertThat(dtoAsString, not(containsString("intValue")));
assertThat(dtoAsString, containsString("booleanValue"));
assertThat(dtoAsString, containsString("stringValue"));
System.out.println(dtoAsString);
}
