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. 反序列化
繼續使用相同的示例，我們可以編寫一個反序列器，將網頁顏色 String 轉換為 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 序列化/反序列器。
