当前位置:

首页 > 编程开发 > RestTemplate获取XML列表为空解决方法

RestTemplate获取XML列表为空解决方法

本文详细探讨了在使用SpringRestTemplate结合Jackson处理外部API返回的XML列表时,可能遇到的空列表问题。核心在于通过Jackson的XML特定注解(如@JacksonXmlRootElement、@JacksonXmlProperty和@JacksonXmlElementWrapper)正确映射XML结构到JavaPOJO,尤其是在处理非包装(unwrapped)列表元素时,确保数据能够被正确反序列化。文章提供了完整的代码示例和配置说明,帮助开发者有效解决此类XML数据绑定难题。

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

本文详细探讨了在使用Spring RestTemplate结合Jackson处理外部API返回的XML列表时,可能遇到的空列表问题。核心在于通过Jackson的XML特定注解(如@JacksonXmlRootElement、@JacksonXmlProperty和@JacksonXmlElementWrapper)正确映射XML结构到Java POJO,尤其是在处理非包装(unwrapped)列表元素时,确保数据能够被正确反序列化。文章提供了完整的代码示例和配置说明,帮助开发者有效解决此类XML数据绑定难题。

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

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

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

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


    
        1
        Item A
        Value1A
        Value2A
        Value3A
    
    
       2
       Item B
       Value1B
       Value2B
       Value3B
   
   

当尝试将这种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中的元素,我们需要创建一个对应的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 + '\'' +
               '}';
    }
}

注意事项:

  • @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中没有额外的列表包装标签,
        //                                                元素直接作为的子元素。
        @JacksonXmlProperty(localName = "Object")
        @JacksonXmlElementWrapper(useWrapping = false)
        private List objects = new ArrayList<>(); // 字段名可以自由命名,但要通过注解正确映射
    
        public ArrayOfObject() {}
    
        public ArrayOfObject(List objects) {
            this.objects = objects;
        }
    
        // Getters and Setters
        public List getObjects() { return objects; }
        public void setObjects(List objects) { this.objects = objects; }
    
        @Override
        public String toString() {
            return "ArrayOfObject{" +
                   "objects=" + objects +
                   '}';
        }
    }

    注意事项:

    • @JacksonXmlRootElement(localName = "ArrayOfObject"):指定这个Java类对应XML中的标签。
    • @JacksonXmlProperty(localName = "Object"):此注解应用于列表字段objects,它告诉Jackson,当解析ArrayOfObject时,寻找名为Object的子元素来填充此列表。
    • @JacksonXmlElementWrapper(useWrapping = false):这是解决“空列表”问题的核心。它指示Jackson,XML结构中没有一个额外的标签来“包装”列表中的所有Object元素。例如,如果XML是......,那么useWrapping就应该设置为true,并且localName设置为Objects。但在当前示例中,直接是的子元素,因此必须设置为false。

      3.4 RestTemplate调用

      最后,在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 getObjectsFromExternalApi() {
              RestTemplate restTemplate = new RestTemplate();
              // 直接将XML反序列化为ArrayOfObject类型
              ArrayOfObject resultWrapper = restTemplate.getForObject(EXTERNAL_API_URI, ArrayOfObject.class);
      
              // 返回包装类中的列表
              return resultWrapper != null ? resultWrapper.getObjects() : new ArrayList<>();
          }
      }

      注意事项:

      • RestTemplate会自动检测响应的Content-Type。如果响应是application/xml,并且jackson-dataformat-xml依赖已存在,RestTemplate会使用Jackson的XML消息转换器进行反序列化。
      • getForObject(uri, ArrayOfObject.class):指定了RestTemplate应将响应体反序列化为ArrayOfObject的实例。

      4. 总结与最佳实践

      通过上述步骤,我们可以成功地使用RestTemplate和Jackson将外部XML API返回的列表数据反序列化为Java POJO。解决此类问题的关键在于:

      1. 引入正确的Jackson XML依赖 (jackson-dataformat-xml和jaxb-api)。
      2. 为每个XML元素定义对应的Java POJO,并使用@JacksonXmlRootElement和@JacksonXmlProperty进行精确映射。
      3. 特别注意列表的反序列化
        • 在包含列表的POJO中,使用@JacksonXmlProperty(localName = "ElementNameOfListItem")来指定列表中每个元素的XML标签名。
        • 根据XML结构,正确配置@JacksonXmlElementWrapper(useWrapping = false)或@JacksonXmlElementWrapper(useWrapping = true, localName = "WrapperElementName")。对于本例中的非包装列表,useWrapping = false是核心。
      4. 提供无参构造函数和完整的Getter/Setter方法,这是Jackson进行反序列化的基本要求。
      5. 在RestTemplate调用中,将目标类型指定为包含列表的包装类

      遵循这些最佳实践,可以有效避免在使用RestTemplate和Jackson处理XML列表时遇到的反序列化问题,确保数据能够被准确无误地解析和使用。

      本文内容来源于互联网,如有侵权请联系删除。
      作者最新文章
      编程开发
      相关文章 更多
      C++动态数组初始化怎么写?常用语句与代码示例
      C++动态数组初始化怎么写?常用语句与代码示例

      深入解析C++中动态数组的初始化机制,涵盖new操作符的不同用法、基本类型与类对象的初始化差异,以及为何在现代C++开发中应优先使用std::vector。

      using namespace 使用中遇到的问题怎么解决
      using namespace 使用中遇到的问题怎么解决

      命名空间的基本概念与常见引入问题在C++等编程语言中,命名空间(namespace)是一种将代码标识符(如变量、函数、类名)封装在特定名称下的机制,其主要目的是避免命名冲突,尤其是在大型项目或使用多个第三方库时。使用“using namespace”指令可以将指定命名空间中的所有名称引入当前作用域,

      c语言函数递归 实操经验总结:这些技巧很实用
      c语言函数递归 实操经验总结:这些技巧很实用

      理解递归的基本原理在C语言中,递归是一种函数调用自身的编程技术。要掌握它,首先需要理解其核心思想:将一个复杂的大问题,分解为一个或几个与原问题相似但规模更小的子问题,直到子问题足够简单,可以直接求解。这个过程通常包含两个关键部分:递归出口和递归体。递归出口定义了问题何时不再继续分解,即最简单、可直接

      c语言函数递归 怎么选?常见方案对比分析
      c语言函数递归 怎么选?常见方案对比分析

      递归函数的基本概念与适用场景在C语言编程中,递归是一种函数调用自身的编程技巧。它并非适用于所有问题,但在处理某些具有自相似结构的问题时,能提供极其清晰和优雅的解决方案。递归的核心思想是将一个大规模问题分解为一个或多个同类型但规模更小的子问题,直到子问题简单到可以直接求解。典型的适用场景包括树形结构的

      Objective-C 内存管理入门:从 alloc 到 dealloc 的生命周期详解
      Objective-C 内存管理入门:从 alloc 到 dealloc 的生命周期详解

      理解内存管理的基石在Objective-C的编程世界中,内存管理是开发者必须掌握的核心技能之一。它直接关系到应用的性能、稳定性与资源利用效率。与一些采用自动垃圾回收机制的语言不同,Objective-C在很长一段时间里,依赖一套基于引用计数的、需要开发者部分介入的管理规则。这套规则的核心思想是明确的

      如何正确使用 dealloc 以避免 iOS 应用中的内存泄漏
      如何正确使用 dealloc 以避免 iOS 应用中的内存泄漏

      理解 dealloc 的角色与时机在 iOS 应用开发中,内存管理是保障应用性能与稳定性的基石。dealloc 方法是 Objective-C 中对象生命周期结束时的关键回调,它标志着对象即将被系统回收内存。正确理解其触发时机至关重要:当一个对象的引用计数降为零时,运行时系统会自动调用该对象的 de

      深入理解 Objective-C 中的 dealloc 方法:内存管理核心机制
      深入理解 Objective-C 中的 dealloc 方法:内存管理核心机制

      内存管理的基石在Objective-C的世界里,内存管理是开发者必须掌握的核心技能之一。作为一门在手动引用计数(MRC)时代诞生的语言,Objective-C要求程序员对对象的生命周期有清晰的认识。dealloc方法正是这一生命周期中至关重要的终点站。它是一个实例方法,当对象的引用计数降为零时,系统

      理解 native2ascii:Java 国际化开发中的字符编码工具
      理解 native2ascii:Java 国际化开发中的字符编码工具

      native2ascii 工具的基本定位在Ja va应用程序的国际化与本地化开发过程中,处理非拉丁字符集是一个常见且关键的环节。Ja va内部使用Unicode字符集来统一表示全球各种语言的文字,但其属性文件(.properties)在历史上要求使用ASCII编码,或者更准确地说,要求非ASCII字

      如何使用 native2ascii 转换中文字符为 Unicode 转义序列
      如何使用 native2ascii 转换中文字符为 Unicode 转义序列

      理解 native2ascii 工具的基本用途在软件开发,特别是涉及国际化处理的场景中,开发者常常需要处理不同编码的文本资源。native2ascii 是 Ja va 开发工具包(JDK)中提供的一个命令行实用程序,其主要功能是将包含本地字符编码(非ASCII字符)的文件,转换为包含 Unicode

      Java native2ascii 命令详解:解决属性文件乱码问题
      Java native2ascii 命令详解:解决属性文件乱码问题

      native2ascii 命令的由来与作用在Ja va开发中,处理国际化资源文件是一个常见需求。资源文件通常以.properties格式存储,用于支持多语言界面。然而,Ja va属性文件默认采用ISO-8859-1字符集编码,这导致了一个直接的问题:当文件中包含非拉丁字符(如中文、日文、韩文等)时,

      查看更多
      精品专题 更多
      装机必备
      装机必备

      正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

      Windows
      Windows

      正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

      macOS软件
      macOS软件

      正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

      Mac软件 更多
      灵活计算器
      灵活计算器
      macOS/iOS/Android

      灵活计算器是一款笔记式算数应用,支持实时计算、动态关联和云端同步功能。记录、整理和输出之间的过渡会更自然,适合长期写作、做笔记或持续沉淀个人内容。

      赤友清理大师
      赤友清理大师
      macOS

      赤友清理大师是一款为 Mac 设计的智能清理优化工具,可精准扫描垃圾、大文件、重复文件等,释放磁盘空间。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

      极度公式
      极度公式
      Windows/macOS/Linux

      极度公式是一款跨平台专业LaTeX公式识别编辑软件,支持OCR公式识别和多平台编辑。和使用说明,避免使用,享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

      WINDOWS 更多
      Windows 10
      Windows 10
      Windows

      Windows 10 是一款微软推出的经典操作系统,拥有硬件兼容性与多任务处理能力。它更偏向把系统状态查看和常用调节动作放在一起,适合需要持续观察和微调设备状态的场景。

      极度公式
      极度公式
      Windows/macOS/Linux

      极度公式是一款跨平台专业LaTeX公式识别编辑软件,支持OCR公式识别和多平台编辑。和使用说明,避免使用,享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

      密码键盘
      密码键盘
      Windows/macOS/iOS/Android

      密码键盘是一款兼具安全性与便捷性的高效密码管理器。日常使用里的持续防护和信息管理会更突出,适合把安全控制放进长期使用流程中的场景。

      网站备案号:苏ICP备2026018738号-1 联系邮箱:bd@zhengruan.com 网站地图

      Copyright ©2018-2026