«1. Обзор
В этом руководстве мы рассмотрим, как использовать представления Jackson JSON для сериализации/десериализации объектов, настройки представлений и, наконец, как начать интеграцию со Spring.
2. Сериализация с использованием представлений JSON
Сначала — давайте рассмотрим простой пример — сериализуйте объект с помощью @JsonView.
Вот наше представление:
public class Views {
public static class Public {
}
}
И объект «Пользователь»:
public class User {
public int id;
@JsonView(Views.Public.class)
public String name;
}
Теперь давайте сериализуем экземпляр «Пользователь», используя наше представление:
@Test
public void whenUseJsonViewToSerialize_thenCorrect()
throws JsonProcessingException {
User user = new User(1, "John");
ObjectMapper mapper = new ObjectMapper();
mapper.disable(MapperFeature.DEFAULT_VIEW_INCLUSION);
String result = mapper
.writerWithView(Views.Public.class)
.writeValueAsString(user);
assertThat(result, containsString("John"));
assertThat(result, not(containsString("1")));
}
Обратите внимание, как поскольку мы сериализуем с определенным активным представлением, мы видим, что сериализуются только нужные поля.
Также важно понимать, что по умолчанию все свойства, не отмеченные явным образом как часть представления, сериализуются. Мы отключаем это поведение с помощью удобной функции DEFAULT_VIEW_INCLUSION.
3. Используйте несколько представлений JSON
Далее — давайте посмотрим, как использовать несколько представлений JSON — каждое из них имеет разные поля, как в следующем примере: с внутренним представлением, расширяющим общедоступное:
А вот наша сущность «Элемент», где в общедоступное представление включены только поля id и name:
public class Views {
public static class Public {
}
public static class Internal extends Public {
}
}
Если мы используем общедоступное представление для сериализации — только идентификатор и имя будут сериализованы в JSON:
public class Item {
@JsonView(Views.Public.class)
public int id;
@JsonView(Views.Public.class)
public String itemName;
@JsonView(Views.Internal.class)
public String ownerName;
}
Но если мы используем внутреннее представление для выполнения сериализации, все поля будут частью вывода JSON:
@Test
public void whenUsePublicView_thenOnlyPublicSerialized()
throws JsonProcessingException {
Item item = new Item(2, "book", "John");
ObjectMapper mapper = new ObjectMapper();
String result = mapper
.writerWithView(Views.Public.class)
.writeValueAsString(item);
assertThat(result, containsString("book"));
assertThat(result, containsString("2"));
assertThat(result, not(containsString("John")));
}
4 Десериализация с использованием представлений JSON
@Test
public void whenUseInternalView_thenAllSerialized()
throws JsonProcessingException {
Item item = new Item(2, "book", "John");
ObjectMapper mapper = new ObjectMapper();
String result = mapper
.writerWithView(Views.Internal.class)
.writeValueAsString(item);
assertThat(result, containsString("book"));
assertThat(result, containsString("2"));
assertThat(result, containsString("John"));
}
Теперь — давайте посмотрим, как использовать представления JSON для десериализации объектов — в частности, экземпляра пользователя:
Обратите внимание, как мы используем API-интерфейс readerWithView() для создания ObjectReader, использующий данное представление.
@Test
public void whenUseJsonViewToDeserialize_thenCorrect()
throws IOException {
String json = "{"id":1,"name":"John"}";
ObjectMapper mapper = new ObjectMapper();
User user = mapper
.readerWithView(Views.Public.class)
.forType(User.class)
.readValue(json);
assertEquals(1, user.getId());
assertEquals("John", user.getName());
}
5. Настройка представлений JSON
Далее — давайте посмотрим, как настроить представления JSON. В следующем примере мы хотим сделать «имя» пользователя в верхнем регистре в результате сериализации.
Мы будем использовать BeanPropertyWriter и BeanSerializerModifier для настройки представления JSON. Во-первых, вот BeanPropertyWriter UpperCasingWriter для преобразования имени пользователя в верхний регистр:
А вот BeanSerializerModifier для установки имени пользователя BeanPropertyWriter с помощью нашего пользовательского UpperCasingWriter:
public class UpperCasingWriter extends BeanPropertyWriter {
BeanPropertyWriter _writer;
public UpperCasingWriter(BeanPropertyWriter w) {
super(w);
_writer = w;
}
@Override
public void serializeAsField(Object bean, JsonGenerator gen,
SerializerProvider prov) throws Exception {
String value = ((User) bean).name;
value = (value == null) ? "" : value.toUpperCase();
gen.writeStringField("name", value);
}
}
Теперь – давайте сериализуем экземпляр User с помощью модифицированного сериализатора:
public class MyBeanSerializerModifier extends BeanSerializerModifier{
@Override
public List<BeanPropertyWriter> changeProperties(
SerializationConfig config, BeanDescription beanDesc,
List<BeanPropertyWriter> beanProperties) {
for (int i = 0; i < beanProperties.size(); i++) {
BeanPropertyWriter writer = beanProperties.get(i);
if (writer.getName() == "name") {
beanProperties.set(i, new UpperCasingWriter(writer));
}
}
return beanProperties;
}
}
6. Использование представлений JSON с Spring
@Test
public void whenUseCustomJsonViewToSerialize_thenCorrect()
throws JsonProcessingException {
User user = new User(1, "John");
SerializerFactory serializerFactory = BeanSerializerFactory.instance
.withSerializerModifier(new MyBeanSerializerModifier());
ObjectMapper mapper = new ObjectMapper();
mapper.setSerializerFactory(serializerFactory);
String result = mapper
.writerWithView(Views.Public.class)
.writeValueAsString(user);
assertThat(result, containsString("JOHN"));
assertThat(result, containsString("1"));
}
Наконец, давайте кратко рассмотрим использование представлений JSON с Spring Framework. Мы можем использовать аннотацию @JsonView для настройки нашего ответа JSON на уровне API.
В следующем примере мы использовали представление Public для ответа:
Ответ:
@JsonView(Views.Public.class)
@RequestMapping("/items/{id}")
public Item getItemPublic(@PathVariable int id) {
return ItemManager.getById(id);
}
А когда мы использовали представление Internal следующим образом:
{"id":2,"itemName":"book"}
Это был ответ:
@JsonView(Views.Internal.class)
@RequestMapping("/items/internal/{id}")
public Item getItemInternal(@PathVariable int id) {
return ItemManager.getById(id);
}
Если вы хотите глубже погрузиться в использование представлений в Spring 4.1, вам следует ознакомиться с улучшениями Джексона в Spring 4.1.
{"id":2,"itemName":"book","ownerName":"John"}
7. Заключение
В этом кратком руководстве мы рассмотрели JSON-представления Джексона и аннотацию @JsonView. Мы показали, как использовать представления JSON для детального управления процессом сериализации/десериализации — с использованием одного или нескольких представлений. Полный код этого руководства можно найти на GitHub.
«