讲师中心 微信公众号
AI工具推荐 视频效率加速

Jackson XML序列化中去除集合包装节点的完整实践指南

阿辰君_8210

阿辰君_8210

发布时间:2026-03-10 09:01:19

|

274人浏览过

|

来源于php中文网

原创

Jackson XML序列化中去除集合包装节点的完整实践指南

本文详解如何使用Jackson的@JacksonXmlElementWrapper(useWrapping = false)配合@JacksonXmlProperty,实现POJO转XML时跳过默认集合外层标签(如),直接将列表元素平铺为同级XML节点。

本文详解如何使用jackson的`@jacksonxmlelementwrapper(usewrapping = false)`配合`@jacksonxmlproperty`,实现pojo转xml时跳过默认集合外层标签(如``),直接将列表元素平铺为同级xml节点。

在使用Jackson进行Java对象到XML的序列化(即XmlMapper)时,一个常见需求是:对List字段,不生成默认的包装容器标签(如),而是让每个列表项以指定名称作为独立子元素直接嵌入父节点。例如,期望输出...并列结构,而非被包裹在...中。仅靠@JacksonXmlElementWrapper(useWrapping = false)往往无效——这是因Jackson默认仍需明确“每个列表元素应以什么XML标签名呈现”,而该信息必须通过@JacksonXmlProperty显式声明。

✅ 正确配置方式

关键在于对List字段同时应用两个注解:

  • @JacksonXmlElementWrapper(useWrapping = false):禁用集合外层包装标签;
  • @JacksonXmlProperty(localName = "xxx"):指定每个列表元素在XML中的实际标签名(即)。

二者缺一不可。若只加useWrapping = false,Jackson会退回到默认行为(使用字段名作为元素名,如),或抛出异常;只有明确告知“每个子项叫什么”,才能实现真正的扁平化输出。

以下为精简、可运行的示例代码:

import com.fasterxml.jackson.dataformat.xml.XmlMapper;
import com.fasterxml.jackson.dataformat.xml.ser.ToXmlGenerator;
import com.fasterxml.jackson.annotation.*;

import java.util.List;

@JacksonXmlRootElement(localName = "my_company")
public class Company {

    public String comName;
    public String comEmail;

    // ✅ 核心配置:禁用包装 + 指定子元素名称
    @JacksonXmlElementWrapper(useWrapping = false)
    @JacksonXmlProperty(localName = "my_child")
    public List<Child> childs;

    public Company(String comName, String comEmail, List<Child> childs) {
        this.comName = comName;
        this.comEmail = comEmail;
        this.childs = childs;
    }

    // 子类无需任何Jackson XML注解
    public static class Child {
        public String street;
        public String state;
        public String city;

        public Child(String street, String state, String city) {
            this.street = street;
            this.state = state;
            this.city = city;
        }
    }

    // 测试入口
    public static void main(String[] args) throws Exception {
        List<Child> children = List.of(
            new Child("123 Main St", "CA", "San Francisco"),
            new Child("456 Oak Ave", "NY", "New York")
        );
        Company company = new Company("Acme Corp", "contact@acme.com", children);

        XmlMapper xmlMapper = new XmlMapper();
        xmlMapper.enable(ToXmlGenerator.Feature.WRITE_XML_DECLARATION);
        xmlMapper.writerWithDefaultPrettyPrinter()
                  .writeValue(System.out, company);
    }
}

执行后输出符合预期:

<?xml version='1.0' encoding='UTF-8'?>
<my_company>
  <comName>Acme Corp</comName>
  <comEmail>contact@acme.com</comEmail>
  <my_child>
    <street>123 Main St</street>
    <state>CA</state>
    <city>San Francisco</city>
  </my_child>
  <my_child>
    <street>456 Oak Ave</street>
    <state>NY</state>
    <city>New York</city>
  </my_child>
</my_company>

⚠️ 注意事项与常见误区

  • 勿混淆@Json*与@JacksonXml*注解:本场景必须使用com.fasterxml.jackson.dataformat.xml.annotation下的XML专用注解(如@JacksonXmlProperty),@JsonProperty等JSON注解对XML序列化完全无效。
  • 泛型类型需具体化:List中Child必须是具体、可实例化的类;避免使用抽象基类(如原问题中的Parent)而未配置多态序列化,否则可能引发InvalidDefinitionException或静默忽略。
  • localName值须与目标XML结构严格一致:它直接决定生成的标签名,大小写、下划线均需匹配预期Schema。
  • 静态内部类推荐:如示例所示,将Child定义为static内部类或独立顶层类,可避免隐式持有外部类引用导致的序列化异常。
  • 版本兼容性:该方案适用于Jackson 2.12+(推荐2.15+),旧版本可能存在@JacksonXmlProperty在集合字段上支持不完善的问题。

✅ 总结

要实现Jackson XML中列表的“无包装扁平化”输出,核心口诀是:
useWrapping = false + @JacksonXmlProperty(localName = "...") 二者成对出现,且仅作用于List字段本身。
无需修改子类、无需启用多态注解、无需自定义序列化器——标准Jackson XML模块即可优雅达成目标。这一模式广泛适用于生成符合第三方XML Schema(如SOAP、EDI片段)要求的轻量级数据交换格式。

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

3529

2023.06.20

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2408

2023.07.25

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

1360

2023.08.02

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1298

2023.08.09

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

1416

2023.09.05

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2318

2023.09.20

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

3800

2023.09.20

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

17815

2023.09.22

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

60

2026.10.28

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn