[Перевод] Учебное пособие по Spring Boot (5): Пользовательская сериализация JSON с аннотацией @JsonComponent

Spring Boot

Предыдущий:Учебное пособие по Spring Boot (4): отключение и настройка страниц ошибок по умолчанию

оригинал:Using @JsonComponent in Spring Boot

1 Обзор

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

Используя эту аннотацию, нам не нужно ссылаться вручнуюObjectMapperобъект может представлять класс как класс Джексонаserializerа такжеdeserializer.

Поскольку это функция, предоставляемая 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);
    }
}

используйте вышеуказанноеserializerдолжен выводить JSON следующим образом:

{"favoriteColor":"#f0f8ff"}

из-за использования@JsonComponentОбратите внимание, вышеserializerбудет автоматически внедрен Spring Boot вObjectMapper, мы используем 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);
    }
}

Или приведенный выше пример, давайте напишемdeserializerположить#xxxxxxПреобразуйте цвет формата в объект цвета 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()));
    }
}

4. Интеграция сериализатора и десериализатора

При необходимости мы можемserializerа такжеdeserializerИнтеграция в класс с помощью внутренних классов.В этом случае нам нужно только поставить@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. Резюме

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

Фрагменты кода в этом руководстве можно найти по адресуGitHubнайти на.

Категории