RestTemplate使用JAXB注解时@XmlElementWrapper标注的列表无法被正确识别
非Spring Boot项目RestTemplate反序列化JAXB注解DTO列表为null问题
场景说明
我在非Spring Boot的应用服务器项目中使用RestTemplate从接口端点获取实体数据,实体DTO基于JAXB注解定义,反序列化结果和预期不符。
实体DTO定义
@XmlAccessorType(XmlAccessType.NONE) @XmlRootElement(name = "entity") public class EntityDTO { private Integer id; // 该字段曾一度缺失 private List<String> parameterName; // 存储参数名列表 public EntityDTO() { } @XmlElementWrapper(name = "parameterNames") @XmlElement(name = "parameterName") public List<String> getParameterName() { return parameterName; } public void setParameterName(List<String> parameterName) { this.parameterName = parameterName; } @XmlElement(name = "id") public Integer getId() { return id; } // 该setter方法曾错误返回Integer类型,现已修正为void public void setId(Integer id) { this.id = id; } }
接口返回格式
{ "entity": { "id": 1, "parameterNames": { "parameterName": [ "param1", "param2" ] } } }
发起请求的代码
// 省略前置配置逻辑 HttpEntity<EntityDTO> response = restTemplate.exchange( uri, HttpMethod.GET, httpEntity, EntityDTO.class);
注意:原请求代码中泛型参数存在笔误(写为
EntityDTOO),配置时需要保证泛型类型和实际解析类一致,否则也会触发反序列化异常。
异常现象
- 实际反序列化结果:
id: 1,parameterName: null - 预期反序列化结果:
id: 1,parameterName: ["param1", "param2"]
问题核心根源
- JAXB注解仅在XML序列化场景生效:
@XmlElementWrapper、@XmlElement是JAXB生态专门为XML格式设计的注解,RestTemplate处理JSON响应时,默认使用MappingJackson2HttpMessageConverter,底层由Jackson完成JSON解析,默认完全不会扫描、解析任何JAXB的XML专属注解。 - DTO结构和接口返回的JSON层级不匹配:当前DTO没有对应
parameterNames这一层嵌套节点字段。JSON中parameterNames是一个独立的对象,内部才存储parameterName数组,Jackson解析时无法将嵌套在parameterNames对象内的数组值,直接映射到DTO顶层的parameterName字段——即便开启了JAXB注解的Jackson支持模块,@XmlElementWrapper的映射逻辑也只适配XML的嵌套节点结构,和当前多层嵌套的JSON结构无法对应。 - id字段可以正常映射的原因:id字段和JSON返回的key处于同一层级,即便Jackson不识别@XmlElement注解,也会默认按字段名做同名匹配,因此可以正常拿到值。
可选解决方案
适配JSON结构调整DTO字段(最稳妥)
针对接口返回的嵌套JSON结构,新增对应层级的字段,同时不改动原有JAXB的XML映射逻辑:@XmlAccessorType(XmlAccessType.NONE) @XmlRootElement(name = "entity") public class EntityDTO { private Integer id; // 新增对应JSON中parameterNames对象的嵌套字段 private ParameterNames parameterNames; // 保留原parameterName列表的读取入口,适配原有业务逻辑 public List<String> getParameterName() { return parameterNames == null ? null : parameterNames.getParameterName(); } public void setParameterName(List<String> parameterName) { if (this.parameterNames == null) { this.parameterNames = new ParameterNames(); } this.parameterNames.setParameterName(parameterName); } @XmlElement(name = "id") public Integer getId() { return id; } public void setId(Integer id) { this.id = id; } // 静态内部类对应parameterNames节点结构,兼容XML序列化 @XmlAccessorType(XmlAccessType.NONE) public static class ParameterNames { private List<String> parameterName; @XmlElement(name = "parameterName") public List<String> getParameterName() { return parameterName; } public void setParameterName(List<String> parameterName) { this.parameterName = parameterName; } } }调整后JSON反序列化、XML序列化场景都能正常兼容原有业务逻辑。
启用Jackson的JAXB注解支持(适配双协议场景)
如果项目同时需要兼容XML和JSON接口,且不想调整DTO结构,可引入Jackson的JAXB注解适配模块:- 添加
jackson-module-jaxb-annotations依赖 - 手动配置ObjectMapper注册该模块,开启JAXB注解解析开关
- 注意:该模块仅能解析大部分常用JAXB注解的语义,对
@XmlElementWrapper的嵌套结构适配,无法直接对应多层嵌套的JSON结构,仍需要配合自定义字段路径映射调整。
- 添加
自定义反序列化映射
如果接口返回结构固定且无法修改,可针对parameterName字段编写自定义Jackson反序列化器,直接从JSON的嵌套路径中提取列表值映射到字段上,不需要改动DTO的整体结构。
内容的提问来源于stack exchange,提问作者italktothewind
相关产品推荐
相关产品推荐

