0

0

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

碧海醫心

碧海醫心

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

|

214人浏览过

|

来源于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工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

454

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

546

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

333

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

82

2025.09.10

java多态详细介绍
java多态详细介绍

本专题整合了java多态相关内容,阅读专题下面的文章了解更多详细内容。

27

2025.11.27

java多态详细介绍
java多态详细介绍

本专题整合了java多态相关内容,阅读专题下面的文章了解更多详细内容。

27

2025.11.27

pdf怎么转换成xml格式
pdf怎么转换成xml格式

将 pdf 转换为 xml 的方法:1. 使用在线转换器;2. 使用桌面软件(如 adobe acrobat、itext);3. 使用命令行工具(如 pdftoxml)。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1945

2024.04.01

xml怎么变成word
xml怎么变成word

步骤:1. 导入 xml 文件;2. 选择 xml 结构;3. 映射 xml 元素到 word 元素;4. 生成 word 文档。提示:确保 xml 文件结构良好,并预览 word 文档以验证转换是否成功。想了解更多xml的相关内容,可以阅读本专题下面的文章。

2119

2024.08.01

JavaScript浏览器渲染机制与前端性能优化实践
JavaScript浏览器渲染机制与前端性能优化实践

本专题围绕 JavaScript 在浏览器中的执行与渲染机制展开,系统讲解 DOM 构建、CSSOM 解析、重排与重绘原理,以及关键渲染路径优化方法。内容涵盖事件循环机制、异步任务调度、资源加载优化、代码拆分与懒加载等性能优化策略。通过真实前端项目案例,帮助开发者理解浏览器底层工作原理,并掌握提升网页加载速度与交互体验的实用技巧。

59

2026.03.06

热门下载

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

精品课程

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

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