使用RestTemplate获取XML对象列表为空问题的解决方案

1. 引言：RestTemplate与XML数据绑定挑战

在使用spring框架的resttemplate与外部api进行交互时，如果api返回的是xml格式的数据，并且数据中包含一个对象列表，开发者可能会遇到列表为空的问题。这通常不是resttemplate本身的问题，而是jackson xml数据绑定库（jackson-dataformat-xml）在将xml结构反序列化为java对象（pojo）列表时，未能正确识别和映射xml元素。本教程将深入分析此类问题，并提供一套基于jackson注解的完整解决方案。

2. 问题分析：XML列表反序列化失败的常见原因

假设我们从外部API获取的XML数据结构如下：

当尝试将这种XML结构映射到Java POJO列表时，常见的错误做法可能包括：

• POJO字段与XML元素名称不匹配： Java类中的字段名未与XML元素名保持一致，或未通过注解明确指定映射关系。
• 列表包装器注解使用不当： 对于像这种“非包装”列表（即列表元素直接作为父元素的子元素，没有额外的列表包装标签），@JacksonXmlElementWrapper注解的配置至关重要。
• 缺少必要的Jackson XML注解： 未使用@JacksonXmlRootElement或@JacksonXmlProperty来指导Jackson如何解析XML结构。
• @JsonIgnoreProperties误用： @JsonIgnoreProperties主要用于JSON反序列化，在XML场景下，其行为可能不如预期，或者不适用于解决列表为空的问题。对于XML，通常是未注解的字段会被忽略，除非设置了严格的失败策略。

3. 解决方案：使用Jackson XML注解正确映射

解决此问题的关键在于正确使用jackson-dataformat-xml提供的注解来精确指导Jackson如何将XML数据反序列化为Java对象。

3.1 核心依赖

首先，确保pom.xml中包含了Jackson XML数据绑定的相关依赖：

    com.fasterxml.jackson.dataformat
    jackson-dataformat-xml


    javax.xml.bind
    jaxb-api
    2.3.1 

jaxb-api在Java 9及更高版本中被移除出JDK默认模块，因此对于现代Spring Boot应用，通常需要显式添加此依赖。

3.2 定义子对象POJO (Object类)

针对XML中的

package it.me.model;

import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlRootElement;
import java.io.Serializable;

@JacksonXmlRootElement(localName = "Object") // 明确指定XML根元素名为"Object"
public class Object implements Serializable {

    private static final long serialVersionUID = 1L;

    @JacksonXmlProperty // 默认映射到同名字段
    private String id;

    @JacksonXmlProperty
    private String name;

    @JacksonXmlProperty
    private String var1;

    @JacksonXmlProperty
    private String var2;

    @JacksonXmlProperty
    private String var3;

    // 无参构造函数是Jackson反序列化的必要条件
    public Object() {}

    // 全参构造函数（可选，但推荐）
    public Object(String id, String name, String var1, String var2, String var3) {
        this.id = id;
        this.name = name;
        this.var1 = var1;
        this.var2 = var2;
        this.var3 = var3;
    }

    // Getters and Setters (Jackson需要它们来访问和设置字段值)
    public String getId() { return id; }
    public void setId(String id) { this.id = id; }
    public String getName() { return name; }
    public void setName(String name) { this.name = name; }
    public String getVar1() { return var1; }
    public void setVar1(String var1) { this.var1 = var1; }
    public String getVar2() { return var2; }
    public void setVar2(String var2) { this.var2 = var2; }
    public String getVar3() { return var3; }
    public void setVar3(String var3) { this.var3 = var3; }

    // toString, equals, hashCode 等方法（推荐重写，便于调试和使用）
    @Override
    public String toString() {
        return "Object{" +
               "id='" + id + '\'' +
               ", name='" + name + '\'' +
               ", var1='" + var1 + '\'' +
               ", var2='" + var2 + '\'' +
               ", var3='" + var3 + '\'' +
               '}';
    }
}

注意事项：

InsCode

InsCode 是CSDN旗下的一个无需安装的编程、协作和分享社区

下载

• @JacksonXmlRootElement(localName = "Object")：明确指出这个Java类对应XML中的
• @JacksonXmlProperty：用于标记需要从XML元素中映射的字段。如果XML元素名与Java字段名一致，则无需指定localName；否则，需要@JacksonXmlProperty(localName = "xmlElementName")。
• 所有需要映射的XML字段都应在POJO中定义并使用@JacksonXmlProperty进行注解。如果XML中存在POJO中未定义的字段，Jackson默认会忽略它们（除非配置了DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES）。如果只想获取部分字段，依然需要确保这些字段被正确注解。

3.3 定义列表包装器POJO (ArrayOfObject类)

针对包含

package it.me.model;

import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlRootElement;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

@JacksonXmlRootElement(localName = "ArrayOfObject") // 明确指定XML根元素名为"ArrayOfObject"
public class ArrayOfObject implements Serializable {

    private static final long serialVersionUID = 1L;

    // 关键注解：
    // @JacksonXmlProperty(localName = "Object")：指定列表中的每个元素对应的XML标签名是"Object"
    // @JacksonXmlElementWrapper(useWrapping = false)：告诉Jackson，XML中没有额外的列表包装标签，
    //