Использование @JsonComponent в Spring Boot
1. обзор
В этой быстрой статье рассказывается, как использовать аннотацию@JsonComponent в Spring Boot.
Аннотации позволяют нам сделать аннотированный класс сериализатором и / или десериализатором Джексона без необходимости добавлять его вObjectMapperвручную.
Это часть основного модуля Spring Boot, поэтому никаких дополнительных зависимостей в простом приложении Spring Boot не требуется.
2. Сериализация
Начнем со следующего объектаUser, содержащего любимый цвет:
public class User {
private Color favoriteColor;
// standard getters/constructors
}
Если мы сериализуем этот объект, используя Джексона с настройками по умолчанию, мы получим:
{ "favoriteColor": { "red": 0.9411764740943909, "green": 0.9725490212440491, "blue": 1.0, "opacity": 1.0, "opaque": true, "hue": 208.00000000000003, "saturation": 0.05882352590560913, "brightness": 1.0 } }
Мы можем сделать JSON намного более сжатым и читаемым, просто распечатав значения RGB - например, для использования в CSS.
В этом смысле нам просто нужно создать класс, реализующийJsonSerializer:
@JsonComponent
public class UserJsonSerializer extends JsonSerializer {
@Override
public void serialize(User user, JsonGenerator jsonGenerator,
SerializerProvider serializerProvider) throws IOException,
JsonProcessingException {
jsonGenerator.writeStartObject();
jsonGenerator.writeStringField(
"favoriteColor",
getColorAsWebColor(user.getFavoriteColor()));
jsonGenerator.writeEndObject();
}
private static String getColorAsWebColor(Color color) {
int r = (int) Math.round(color.getRed() * 255.0);
int g = (int) Math.round(color.getGreen() * 255.0);
int b = (int) Math.round(color.getBlue() * 255.0);
return String.format("#%02x%02x%02x", r, g, b);
}
}
С этим сериализатором полученный JSON был уменьшен до:
{"favoriteColor":"#f0f8ff"}
Из-за аннотации@JsonComponent сериализатор зарегистрирован в JacksonObjectMapper в приложении Spring Boot. Мы можем проверить это с помощью следующего теста JUnit:
@JsonTest
@RunWith(SpringRunner.class)
public class UserJsonSerializerTest {
@Autowired
private ObjectMapper objectMapper;
@Test
public void testSerialization() throws JsonProcessingException {
User user = new User(Color.ALICEBLUE);
String json = objectMapper.writeValueAsString(user);
assertEquals("{\"favoriteColor\":\"#f0f8ff\"}", json);
}
}
3. Десериализация
Продолжая тот же пример, мы можем написать десериализатор, который превратит веб-цветString в объект JavaFX Color:
@JsonComponent
public class UserJsonDeserializer extends JsonDeserializer {
@Override
public User deserialize(JsonParser jsonParser,
DeserializationContext deserializationContext) throws IOException,
JsonProcessingException {
TreeNode treeNode = jsonParser.getCodec().readTree(jsonParser);
TextNode favoriteColor
= (TextNode) treeNode.get("favoriteColor");
return new User(Color.web(favoriteColor.asText()));
}
}
Давайте протестируем новый десериализатор и убедимся, что все работает должным образом:
@JsonTest
@RunWith(SpringRunner.class)
public class UserJsonDeserializerTest {
@Autowired
private ObjectMapper objectMapper;
@Test
public void testDeserialize() throws IOException {
String json = "{\"favoriteColor\":\"#f0f8ff\"}"
User user = objectMapper.readValue(json, User.class);
assertEquals(Color.ALICEBLUE, user.getFavoriteColor());
}
}
4. Serializer иDeserializer в одном классе
При желании мы можем соединить сериализатор и десериализатор в один класс, используя два внутренних класса и добавив@JsonComponent к включающему классу:
@JsonComponent
public class UserCombinedSerializer {
public static class UserJsonSerializer
extends JsonSerializer {
@Override
public void serialize(User user, JsonGenerator jsonGenerator,
SerializerProvider serializerProvider) throws IOException,
JsonProcessingException {
jsonGenerator.writeStartObject();
jsonGenerator.writeStringField(
"favoriteColor", getColorAsWebColor(user.getFavoriteColor()));
jsonGenerator.writeEndObject();
}
private static String getColorAsWebColor(Color color) {
int r = (int) Math.round(color.getRed() * 255.0);
int g = (int) Math.round(color.getGreen() * 255.0);
int b = (int) Math.round(color.getBlue() * 255.0);
return String.format("#%02x%02x%02x", r, g, b);
}
}
public static class UserJsonDeserializer
extends JsonDeserializer {
@Override
public User deserialize(JsonParser jsonParser,
DeserializationContext deserializationContext)
throws IOException, JsonProcessingException {
TreeNode treeNode = jsonParser.getCodec().readTree(jsonParser);
TextNode favoriteColor = (TextNode) treeNode.get(
"favoriteColor");
return new User(Color.web(favoriteColor.asText()));
}
}
}
5. Заключение
В этом кратком руководстве показано, как быстро добавить сериализатор / десериализатор Джексона в приложение Spring Boot, используя сканирование компонентов с аннотацией@JsonComponent.
Фрагменты кода можно найтиover on GitHub.