在Spring Boot中使用@JsonComponent

1. 概述

这篇快速文章主要关注如何在Spring Boot中使用@JsonComponent注解。

该注解允许我们将带注解的类公开为Jackson序列化器和/或反序列化器，而无需手动将其添加到ObjectMapper中。

这是核心Spring Boot模块的一部分，因此在普通Spring Boot应用程序中不需要额外的依赖项。

2. 序列化

让我们从以下包含最喜欢的颜色的用户对象开始：

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
    }
}

我们可以通过仅打印RGB值来使JSON更加简洁和可读-例如，在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注解，序列化器在Spring Boot应用程序的Jackson 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);
    }
}

3. 反序列化

继续使用相同的示例，我们可以编写一个反序列化器，将Web颜色字符串转换为JavaFX Color对象：

@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. 总结

本快速教程展示了如何利用带有@JsonComponent注解的组件扫描，在Spring Boot应用程序中快速添加Jackson序列化器/反序列化器。

与往常一样，本教程的完整源代码可在GitHub上获得。

Show Disqus Comments