0

0

Jackson XML 反序列化深度指南:处理列表类型数据的常见陷阱与解决方案

DDD

DDD

发布时间:2025-09-26 11:24:34

|

531人浏览过

|

来源于php中文网

原创

Jackson XML 反序列化深度指南:处理列表类型数据的常见陷阱与解决方案

本文探讨Jackson XML反序列化过程中,针对列表类型数据(如List)出现的MismatchedInputException和no String-argument constructor错误。核心问题在于Jackson默认无法正确识别XML中的列表结构,将其误解为单个字符串值。解决方案是利用@JacksonXmlElementWrapper(useWrapping = false)和@JacksonXmlProperty注解,明确指定XML元素的包装方式和名称映射,确保Jackson能正确解析嵌套的列表数据,从而实现XML到Java对象的顺利转换。

Jackson XML反序列化概述

jackson是一个功能强大的java库,用于处理json和xml数据。通过jackson-dataformat-xml模块,jackson能够方便地将xml字符串或文件反序列化为java对象,或将java对象序列化为xml。然而,在处理复杂的xml结构,特别是包含列表(list)类型数据时,可能会遇到一些挑战,需要借助特定的注解来指导jackson的解析行为。

列表类型数据反序列化常见问题:MismatchedInputException

当尝试将一个包含嵌套列表的XML文件反序列化为Java对象时,如果未正确配置,Jackson可能会抛出com.fasterxml.jackson.databind.exc.MismatchedInputException异常,并伴随“Cannot construct instance of YourBean (although at least one Creator exists): no String-argument constructor/factory method to deserialize from String value ('...')”的错误信息。

示例场景:

假设有以下Java数据传输对象(DTO):

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

import java.util.List;

@JsonIgnoreProperties(ignoreUnknown = true)
@Getter @Setter @NoArgsConstructor
public class FINSTABean {
    @JsonProperty("STA_VER")
    String STA_VER;
    @JsonProperty("FINSTA03")
    List FINSTA03BeanList; // 期望解析为列表
}

@JsonIgnoreProperties(ignoreUnknown = true)
@Getter @Setter @NoArgsConstructor
public class FINSTA03Bean {
    @JsonProperty("S28_CISLO_VYPISU")
    String S28_CISLO_VYPISU;
    String S25_CISLO_UCTU; // 假设此字段在XML中存在,但未显式注解
}

以及对应的XML数据片段:



    01.0000
    
        10
    
    
        20
    

当使用XmlMapper尝试反序列化时:

XmlMapper xmlMapper = new XmlMapper();
FINSTABean bean = xmlMapper.readValue(file, FINSTABean.class);

可能会遇到如下错误:

Caused by: com.fasterxml.jackson.databind.exc.MismatchedInputException: Cannot construct instance of `com.lelifin.alfa.parsers.csob_xml.FINSTA03Bean` (although at least one Creator exists): no String-argument constructor/factory method to deserialize from String value ('10')
 at [Source: (File); line: 5, column: 29] (through reference chain: com.lelifin.alfa.parsers.csob_xml.FINSTABean["FINSTA03"]->java.util.ArrayList[0])

这个错误表明Jackson尝试将XML中的元素的内容(例如10)直接反序列化为一个FINSTA03Bean对象,而不是将其识别为一个包含FINSTA03Bean对象的列表。由于FINSTA03Bean没有接受单个字符串参数的构造函数或工厂方法,导致反序列化失败。

问题根源:Jackson对XML列表结构的默认处理

Jackson在处理XML时,对于集合类型的字段,默认行为是期望有一个包装元素(wrapper element)来包含列表中的所有项。例如,如果XML结构是:

 
    ...
    ...

而我们的XML中元素直接作为父元素的子元素重复出现,并没有一个额外的包装元素来明确表示这是一个列表。在这种情况下,Jackson会误将第一个元素视为一个独立的、非列表的字段,并尝试将其内容(例如10)作为一个字符串值来构建FINSTA03Bean,从而引发MismatchedInputException。

DeepL
DeepL

DeepL是一款强大的在线AI翻译工具,可以翻译31种不同语言的文本,并可以处理PDF、Word、PowerPoint等文档文件

下载

解决方案:使用@JacksonXmlElementWrapper和@JacksonXmlProperty

为了正确指导Jackson处理这种扁平化的列表结构,我们需要使用jackson-dataformat-xml提供的特定注解:@JacksonXmlElementWrapper和@JacksonXmlProperty。

  1. @JacksonXmlElementWrapper(useWrapping = false) 这个注解用于指示Jackson如何处理集合或数组类型的字段。当useWrapping设置为false时,它告诉Jackson该集合的元素不是由一个额外的包装XML元素所包裹,而是直接作为父元素的子元素出现。这正是我们当前XML结构所需要的。

  2. @JacksonXmlProperty(localName = "...")@JacksonXmlProperty是Jackson XML模块特有的注解,用于将Java对象的字段映射到XML元素或属性。它类似于@JsonProperty,但专为XML设计,提供了更多XML相关的控制。localName属性用于指定XML元素的名称。

修正后的DTO代码:

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

import java.util.List;

@JsonIgnoreProperties(ignoreUnknown = true)
@Getter @Setter @NoArgsConstructor
public class FINSTABean {
    @JacksonXmlProperty(localName = "STA_VER") // 使用JacksonXmlProperty映射XML元素名
    String STA_VER;

    // 关键修正:
    // 1. @JacksonXmlProperty(localName = "FINSTA03"):将Java字段FINSTA03BeanList映射到XML元素FINSTA03。
    // 2. @JacksonXmlElementWrapper(useWrapping = false):指示FINSTA03BeanList的元素不是由一个额外的包装元素包裹,
    //    而是FINSTA03元素本身就代表列表中的一个项。
    @JacksonXmlProperty(localName = "FINSTA03")
    @JacksonXmlElementWrapper(useWrapping = false)
    List FINSTA03BeanList;
}

@JsonIgnoreProperties(ignoreUnknown = true) // 仍然保留,忽略XML中Java对象未定义的字段
@Getter @Setter @NoArgsConstructor
public class FINSTA03Bean {
    @JacksonXmlProperty(localName = "S28_CISLO_VYPISU")
    String S28_CISLO_VYPISU;
    @JacksonXmlProperty(localName = "S25_CISLO_UCTU") // 如果XML中存在此元素,也应明确映射
    String S25_CISLO_UCTU;
}

通过上述修改,Jackson现在能够正确地识别FINSTA03BeanList字段对应的XML结构。它会知道元素并不是一个单一的字符串值,而是列表中的一个对象实例,并且会逐个解析所有同名的元素,并将它们收集到FINSTA03BeanList中。

注意事项与最佳实践

  • @JsonProperty vs. @JacksonXmlProperty: 尽管@JsonProperty在某些情况下也能用于XML映射,但@JacksonXmlProperty是Jackson XML模块提供的更专业、更强大的注解,建议在处理XML时优先使用它,尤其是在需要精细控制XML元素或属性映射时。
  • useWrapping = true 的场景: 如果XML结构中确实存在一个包装元素,例如:
    
        ...
        ...
    

    那么在FINSTABean中,FINSTA03BeanList字段应该这样注解:

    @JacksonXmlElementWrapper(localName = "FINSTA03List") // 包装元素名称
    @JacksonXmlProperty(localName = "FINSTA03") // 列表项元素名称
    List FINSTA03BeanList;

    此时,useWrapping默认为true,或者可以显式设置为true。

  • 忽略未知属性: @JsonIgnoreProperties(ignoreUnknown = true) 是一个非常有用的注解,它指示Jackson在反序列化时忽略XML中存在但Java对象中没有对应字段的元素或属性,这可以提高代码的健壮性。
  • Lombok集成: @Getter, @Setter, @NoArgsConstructor等Lombok注解与Jackson完美兼容,它们在编译时生成了必要的getter/setter方法和无参构造函数,满足Jackson反序列化的要求。
  • XML编码: XML文件头部的encoding="windows-1250"指定了字符编码。在Java中读取文件时,确保使用正确的编码方式,例如new InputStreamReader(new FileInputStream(file), "windows-1250"),以避免乱码问题。

总结

在Jackson XML反序列化过程中,处理列表类型数据是一个常见的陷阱。MismatchedInputException通常是由于Jackson未能正确识别XML中的列表结构导致的。通过巧妙地运用@JacksonXmlElementWrapper和@JacksonXmlProperty这两个Jackson XML模块特有的注解,我们可以精确地指导Jackson如何解析复杂的XML结构,特别是当列表元素没有显式包装器时,使用@JacksonXmlElementWrapper(useWrapping = false)能够有效解决问题。理解并正确应用这些注解,是实现高效、健壮Jackson XML数据处理的关键。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

832

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

738

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

734

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

397

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

398

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

446

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

430

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

16926

2023.08.03

Golang gRPC 服务开发与Protobuf实战
Golang gRPC 服务开发与Protobuf实战

本专题系统讲解 Golang 在 gRPC 服务开发中的完整实践,涵盖 Protobuf 定义与代码生成、gRPC 服务端与客户端实现、流式 RPC(Unary/Server/Client/Bidirectional)、错误处理、拦截器、中间件以及与 HTTP/REST 的对接方案。通过实际案例,帮助学习者掌握 使用 Go 构建高性能、强类型、可扩展的 RPC 服务体系,适用于微服务与内部系统通信场景。

8

2026.01.15

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 2.5万人学习

C# 教程
C# 教程

共94课时 | 6.8万人学习

Java 教程
Java 教程

共578课时 | 46.4万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号