
在使用spring框架的resttemplate与外部api进行交互时,如果api返回的是xml格式的数据,并且数据中包含一个对象列表,开发者可能会遇到列表为空的问题。这通常不是resttemplate本身的问题,而是jackson xml数据绑定库(jackson-dataformat-xml)在将xml结构反序列化为java对象(pojo)列表时,未能正确识别和映射xml元素。本教程将深入分析此类问题,并提供一套基于jackson注解的完整解决方案。
假设我们从外部API获取的XML数据结构如下:
<ArrayOfObject>
    <Object>
        <id>1</id>
        <name>Item A</name>
        <var1>Value1A</var1>
        <var2>Value2A</var2>
        <var3>Value3A</var3>
    </Object>
    <Object>
       <id>2</id>
       <name>Item B</name>
       <var1>Value1B</var1>
       <var2>Value2B</var2>
       <var3>Value3B</var3>
   </Object>
   <!-- ... 更多Object元素 ... -->
</ArrayOfObject>当尝试将这种XML结构映射到Java POJO列表时,常见的错误做法可能包括:
解决此问题的关键在于正确使用jackson-dataformat-xml提供的注解来精确指导Jackson如何将XML数据反序列化为Java对象。
首先,确保pom.xml中包含了Jackson XML数据绑定的相关依赖:
<dependency>
    <groupId>com.fasterxml.jackson.dataformat</groupId>
    <artifactId>jackson-dataformat-xml</artifactId>
</dependency>
<dependency>
    <groupId>javax.xml.bind</groupId>
    <artifactId>jaxb-api</artifactId>
    <version>2.3.1</version> <!-- 根据Java版本选择合适的版本,Java 11+可能需要 -->
</dependency>jaxb-api在Java 9及更高版本中被移除出JDK默认模块,因此对于现代Spring Boot应用,通常需要显式添加此依赖。
针对XML中的<Object>元素,我们需要创建一个对应的Java类。为了确保Jackson能正确识别每个字段,应使用@JacksonXmlRootElement标记根元素,并使用@JacksonXmlProperty标记每个字段。
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 + '\'' +
               '}';
    }
}注意事项:
针对包含<Object>列表的<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中没有额外的列表包装标签,
    //                                                <Object>元素直接作为<ArrayOfObject>的子元素。
    @JacksonXmlProperty(localName = "Object")
    @JacksonXmlElementWrapper(useWrapping = false)
    private List<Object> objects = new ArrayList<>(); // 字段名可以自由命名,但要通过注解正确映射
    public ArrayOfObject() {}
    public ArrayOfObject(List<Object> objects) {
        this.objects = objects;
    }
    // Getters and Setters
    public List<Object> getObjects() { return objects; }
    public void setObjects(List<Object> objects) { this.objects = objects; }
    @Override
    public String toString() {
        return "ArrayOfObject{" +
               "objects=" + objects +
               '}';
    }
}注意事项:
最后,在Spring Controller或Service中,使用RestTemplate进行API调用时,将期望的反序列化类型指定为包装类ArrayOfObject.class。
package it.me.controller;
import it.me.model.ArrayOfObject;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;
import java.util.List;
@RestController
@RequestMapping("/api") // 建议为Controller添加一个基础路径
public class RestCallController {
    private final String EXTERNAL_API_URI = "http://localhost:8080/external/objects"; // 替换为实际的外部API地址
    @GetMapping("/objects")
    public List<Object> getObjectsFromExternalApi() {
        RestTemplate restTemplate = new RestTemplate();
        // 直接将XML反序列化为ArrayOfObject类型
        ArrayOfObject resultWrapper = restTemplate.getForObject(EXTERNAL_API_URI, ArrayOfObject.class);
        // 返回包装类中的列表
        return resultWrapper != null ? resultWrapper.getObjects() : new ArrayList<>();
    }
}注意事项:
通过上述步骤,我们可以成功地使用RestTemplate和Jackson将外部XML API返回的列表数据反序列化为Java POJO。解决此类问题的关键在于:
遵循这些最佳实践,可以有效避免在使用RestTemplate和Jackson处理XML列表时遇到的反序列化问题,确保数据能够被准确无误地解析和使用。
以上就是使用RestTemplate获取XML对象列表为空问题的解决方案的详细内容,更多请关注php中文网其它相关文章!
                        
                        每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
                Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号