1. Обзор
В этом руководстве показано, как мы можем использовать Jackson для сериализации поля только в том случае, если оно соответствует определенным пользовательским критериям .
Например, скажем, мы хотим сериализовать целочисленное значение только в том случае, если оно положительное, и мы хотим полностью его пропустить, если оно не положительное.
Если вы хотите копнуть глубже и узнать о других интересных вещах, которые вы можете делать с Jackson 2, — перейдите к основному руководству по Jackson .
2. Используйте фильтр Джексона для управления процессом сериализации
Во-первых, нам нужно определить фильтр для нашего объекта, используя аннотацию @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 Interface:
@JsonIgnoreProperties("hidden")
public interface Hidable {
boolean isHidden();
}
И у нас есть два простых класса, реализующих этот интерфейс Person , Address :
`Класс человека :`
public class Person implements Hidable {
private String name;
private Address address;
private boolean hidden;
}
И класс адреса :
public class Address implements Hidable {
private String city;
private String country;
private boolean hidden;
}
Примечание. Мы использовали @JsonIgnoreProperties («скрытый») , чтобы убедиться, что само скрытое свойство не включено в 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"));
}
Теперь весь человек скрыт :
@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. Вывод
Этот тип расширенной фильтрации невероятно мощен и позволяет очень гибко настраивать json при сериализации сложных объектов с помощью Jackson.
Более гибкой, но и более сложной альтернативой было бы использование полностью настраиваемого сериализатора для управления выводом JSON, поэтому, если это решение недостаточно гибкое, возможно, стоит изучить его.
Реализацию всех этих примеров и фрагментов кода можно найти на GitHub — это проект на основе Maven, поэтому его легко импортировать и запускать как есть.