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

Jackson XML 序列化中移除集合包装节点的正确实践

星枫吖_5975

星枫吖_5975

发布时间:2026-03-10 11:25:18

|

672人浏览过

|

来源于php中文网

原创

Jackson XML 序列化中移除集合包装节点的正确实践

本文详解如何使用 Jackson 的 @JacksonXmlElementWrapper(useWrapping = false) 与 @JacksonXmlProperty 组合,实现 POJO 列表字段在 XML 输出中无包装标签(如 )的扁平化序列化。

本文详解如何使用 jackson 的 `@jacksonxmlelementwrapper(usewrapping = false)` 与 `@jacksonxmlproperty` 组合,实现 pojo 列表字段在 xml 输出中无包装标签(如 ``)的扁平化序列化。

在基于 Jackson 进行 XML 序列化(jackson-dataformat-xml)时,一个常见需求是:将 Java 中的 List 字段直接渲染为多个同名子元素(如多个 ),而非默认的「包装容器 + 多个子元素」结构(如 ......)。仅添加 @JacksonXmlElementWrapper(useWrapping = false) 往往无效——这正是许多开发者踩坑的关键点:该注解必须与 @JacksonXmlProperty 配合使用,才能精准控制每个列表项的 XML 元素名称。

✅ 正确配置方式

核心在于对 List 字段同时施加两个注解:

  • @JacksonXmlElementWrapper(useWrapping = false):禁用外层包装节点(即不生成 );
  • @JacksonXmlProperty(localName = "my_child"):显式指定每个列表元素应使用的 XML 标签名(即每个 Child 实例渲染为 )。

⚠️ 注意:@JacksonXmlProperty 必须标注在字段上(而非类或 getter),且 localName 值需与你期望的子元素名完全一致;Child 类本身无需任何 Jackson XML 注解(除非需自定义其内部字段映射)。

以下是精简、可运行的完整示例:

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;
    }

    // 子类无需额外注解(除非需多态或重命名)
    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("Main St", "CA", "San Francisco"),
            new Child("Oak Ave", "NY", "New York")
        );
        Company company = new Company("TechCorp", "contact@techcorp.com", children);

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

运行后输出符合预期的扁平化 XML:

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

? 常见误区与注意事项

  • 勿遗漏 @JacksonXmlProperty:仅设 useWrapping = false 会导致 Jackson 使用字段名(如 childs)作为每个子元素名,输出 ...... —— 这并非扁平化,而是错误降级。
  • 避免嵌套泛型或复杂继承干扰:原问题中 Parent 抽象类及 @JsonTypeInfo 在 XML 场景下非必需,且易引发类型解析歧义;如确需多态 XML,应改用 @JsonSubTypes + @JsonTypeName 配合 @JacksonXmlDiscriminator(Jackson 2.12+),但本场景纯扁平列表无需此复杂度。
  • 字段可见性要求:确保字段为 public 或提供 public getter/setter,否则需配置 Visibility 或启用 @JsonAutoDetect。
  • 依赖版本建议:使用 jackson-dataformat-xml ≥ 2.12,并确认 XmlMapper 已正确初始化(推荐通过 new XmlMapper() 而非 new ObjectMapper().registerModule(new JaxbAnnotationModule()))。

掌握这一组合注解模式,即可优雅解决 Jackson XML 中列表扁平化的核心诉求,显著提升生成 XML 的语义清晰度与下游系统兼容性。

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

热门AI工具

更多
咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

讯飞智文

一款面向学习和办公场景的AI文档创作工具,可辅助生成PPT与Word文档,提高资料整理和内容制作效率。

WorkBuddy

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

豆包大模型

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

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

码上飞
码上飞 Hot

一款基于自然语言的AI应用开发平台,可根据用户描述自动生成应用程序,帮助个人和团队快速完成应用原型与开发。

DeepSeek

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

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

小橡皮AI

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

相关专题

更多
java
java

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

12037

2023.06.15

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

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

9122

2023.07.05

java自学难吗
java自学难吗

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

7792

2023.07.31

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

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

1264

2023.08.01

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

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

1028

2023.08.02

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

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

1516

2023.08.02

java有什么用
java有什么用

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

3149

2023.08.02

java在线网站
java在线网站

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

20391

2023.08.03

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

20

2026.11.05

热门下载

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

精品课程

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

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