【译】Spring Boot教程(5)：使用@JsonComponent注解自定义JSON序列化

上一篇：【译】Spring Boot教程(4)：禁用与自定义默认错误页面

原文：Using @JsonComponent in Spring Boot

1. 概述

本篇教程将聚焦于如何使用Spring Boot中的 @JsonComponent 注解。

通过使用这个注解，我们不需要手动引用ObjectMapper对象就可以将一个类暴露为Jackson的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的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()));
    }
}

4. 把Serializer和Deserializer整合到一起

必要时，我们可以把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注解快速的添加Jackson的serializer与deserializer到Spring Boot应用程序中。

本篇教程中的代码片段可以在GitHub上找到。