Использование @JsonComponent в Spring Boot

1. Обзор

Эта короткая статья посвящена тому, как использовать аннотацию @JsonComponent в Spring Boot.

Аннотация позволяет нам представить аннотированный класс как сериализатор и/или десериализатор Джексона без необходимости добавлять его в ObjectMapper вручную.

Это часть основного модуля Spring Boot, поэтому в простом приложении Spring Boot не требуются дополнительные зависимости.

2. Сериализация

Начнем со следующего объекта User , содержащего любимый цвет:

public class User {
    private Color favoriteColor;

    // standard getters/constructors
}

Если мы сериализуем этот объект с помощью Jackson с настройками по умолчанию, мы получим:

{
  "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<User> {

    @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 сериализатор зарегистрирован в Jackson ObjectMapper в приложении 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. Десериализация

Продолжая тот же пример, мы можем написать десериализатор, который превратит строку веб-цвета в объект цвета JavaFX:

@JsonComponent
public class UserJsonDeserializer extends JsonDeserializer<User> {
 
    @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. Сериализатор и десериализатор в одном классе

При желании мы можем соединить сериализатор и десериализатор в одном классе, используя два внутренних класса и добавив @JsonComponent во внешний класс:

@JsonComponent
public class UserCombinedSerializer {
 
    public static class UserJsonSerializer 
      extends JsonSerializer<User> {

        @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<User> {
 
        @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. Вывод

В этом кратком руководстве показано, как быстро добавить сериализатор/десериализатор Jackson в приложение Spring Boot, используя сканирование компонентов с помощью аннотации @JsonComponent .

Фрагменты кода можно найти на GitHub .