Spring Boot中使用@JsonComponent

文章目錄

• 序列化
• 反序列化
• 在同一個class中序列化和反序列化

Spring Boot中使用@JsonComponent

@JsonComponent 是Spring boot的核心注解，使用@JsonComponent 之后就不需要手動將Jackson的序列化和反序列化手動加入ObjectMapper了。使用這個注解就夠了。

序列化

假如我們有個User類，它里面有一個Color屬性：

@Data
@AllArgsConstructor
public class User {
    private Color favoriteColor;
}

接下來我們來創建針對User的序列化組件，我們需要實現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);
    }
}

在上面的類中，我們自定義了序列化的方法。接下來我們測試一下：

@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);
    }
}

反序列化

同樣的，我們實現JsonDeserializer接口：

@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());
    }
}

在同一個class中序列化和反序列化

@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()));
        }
    }
}

為了方便，我們還可以在同一個類中定義兩個內部類來實現序列化和反序列化。如上所示。

本文的例子可以參考https://github.com/ddean2009/learn-springboot2/tree/master/springboot-jsoncomponent

更多教程請參考 flydean的博客