1. 概述
本文重点介绍如何在Spring Boot中使用@JsonComponent注解。这个注解允许我们将标注的类直接暴露为Jackson序列化器/反序列化器，无需手动将其注册到ObjectMapper中。
✅ 核心优势：
- 属于Spring Boot核心模块，无需额外依赖
- 自动注册到Jackson配置中
- 简化自定义序列化/反序列化流程
⚠️ 注意：本文面向有经验的开发者，基础Spring Boot和Jackson知识默认掌握。
2. 序列化实战
先看这个包含颜色属性的User对象：
public class User {
private Color favoriteColor;
// 标准getter/构造器
}
使用默认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
}
}
🎯 目标：转换为简洁的CSS颜色格式（如#f0f8ff）
实现步骤：
- 创建实现
JsonSerializer的类 - 添加
@JsonComponent注解 - 重写
serialize方法
@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"}
✅ 验证测试：
@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. 反序列化实战
现在反向操作：将CSS颜色字符串转换为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
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()));
}
}
}
📌 优势：
- 逻辑内聚，便于维护
- 单文件管理双向转换逻辑
- 保持
@JsonComponent的自动注册特性
5. 总结
本文展示了如何通过@JsonComponent注解在Spring Boot中快速实现Jackson自定义序列化/反序列化：
🔑 关键要点：
- 使用
@JsonComponent自动注册组件 - 可独立实现序列化器/反序列化器
- 支持通过内部类合并双向转换逻辑
- 零额外依赖，开箱即用
💡 实战建议：
- 优先考虑合并实现，提升代码内聚性
- 复杂类型转换务必编写单元测试
- 注意线程安全（Jackson的
ObjectMapper是线程安全的）
完整代码示例可在GitHub仓库获取。