
本文介绍如何在 jackson 中直接将形如 {"phonelist": {"phone": [...]}} 的嵌套 json 结构反序列化为 list<t> 字段,无需定义冗余的中间容器类(如 phonelist),通过 @jsonproperty 配合反序列化 setter 实现扁平化映射。
本文介绍如何在 jackson 中直接将形如 {"phonelist": {"phone": [...]}} 的嵌套 json 结构反序列化为 list<t> 字段,无需定义冗余的中间容器类(如 phonelist),通过 @jsonproperty 配合反序列化 setter 实现扁平化映射。
在实际开发中,我们常遇到 API 返回的 JSON 数据结构与理想 Java 模型不完全匹配的情况。例如,后端返回的 phoneList 并非直接是一个数组,而是包裹在一层 "phone" 键下的对象:
{
"name": "test",
"phoneList": {
"phone": [
{ "number": "32323232", "code": 555 },
{ "number": "4343423432", "code": 555 }
]
}
}若强行按此结构定义 DTO,需额外引入 PhoneList 类——这不仅增加代码量,还破坏了领域模型的简洁性。幸运的是,Jackson 提供了灵活的反序列化钩子机制,允许我们用 反序列化专用 setter 方法(deserialization-only setter)绕过中间类。
✅ 推荐解决方案:使用 @JsonProperty 注解的私有 setter
只需在目标字段(如 phoneList)上添加一个接受 Map<String, List<Phone>> 参数的私有方法,并用 @JsonProperty("phoneList") 标记,Jackson 即会在反序列化 phoneList 字段时自动调用该方法,并将原始 JSON 对象解析为 Map,再从中提取 "phone" 对应的列表:
public class Response {
private String name;
private List<Phone> phoneList = new ArrayList<>();
// 标准 getter/setter(Jackson 序列化时会用到)
public String getName() { return name; }
public void setName(String name) { this.name = name; }
public List<Phone> getPhoneList() { return phoneList; }
public void setPhoneList(List<Phone> phoneList) { this.phoneList = phoneList; }
// ✅ 关键:反序列化专用 setter —— Jackson 会自动调用它处理 "phoneList" 字段
@JsonProperty("phoneList")
private void setPhoneListFromNested(Map<String, List<Phone>> phoneListMap) {
if (phoneListMap != null && phoneListMap.containsKey("phone")) {
this.phoneList = phoneListMap.get("phone");
} else {
this.phoneList = Collections.emptyList();
}
}
// 内部 Phone 类(需满足 Jackson POJO 规范)
public static class Phone {
private String number;
private Integer code;
// 必须提供无参构造器(Jackson 反序列化必需)
public Phone() {}
// 建议添加 getter/setter(即使私有,Jackson 默认可访问)
public String getNumber() { return number; }
public void setNumber(String number) { this.number = number; }
public Integer getCode() { return code; }
public void setCode(Integer code) { this.code = code; }
}
}? 原理说明:当 Jackson 遇到 @JsonProperty("phoneList") 修饰的方法,且其参数类型能匹配 JSON 中该字段的结构(此处为对象 → Map<String, ?>),便会跳过常规字段赋值逻辑,转而调用该方法完成自定义映射。这是一种轻量、零依赖、不侵入业务逻辑的“结构适配”技巧。
⚠️ 注意事项
- 必须提供无参构造器:所有参与反序列化的类(包括 Response 和 Phone)都需有 public 或 protected 的无参构造函数。
- 字段访问权限不限:setPhoneListFromNested 可为 private,Jackson 通过反射可访问(默认启用)。
- 健壮性处理:示例中加入了 null 和 containsKey 判断,避免 NullPointerException;生产环境建议保留。
- 不适用于序列化输出:该方法仅影响反序列化(JSON → Java)。若需将 phoneList 以相同嵌套格式序列化回 JSON,则需额外配置 @JsonSerialize 或自定义序列化器。
-
替代方案对比:
- ✅ @JsonUnwrapped 不适用(它用于扁平化对象字段,而非解析嵌套键);
- ❌ @JsonAlias 仅支持同级别别名,无法处理嵌套层级;
- ⚠️ 自定义 JsonDeserializer 功能强大但过度复杂,本场景无需。
✅ 总结
通过 @JsonProperty + Map 参数的反序列化 setter,你可以在保持 DTO 简洁性的同时,精准适配“带包装键”的嵌套数组结构。这种方式语义清晰、实现简单、易于测试,是 Jackson 高级用法中极具实用价值的技巧之一。推荐在类似 data.items, result.list, payload.entries 等常见嵌套模式中复用此模式。










