0

0

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

霞舞

霞舞

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

|

612人浏览过

|

来源于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 注解(除非需自定义其内部字段映射)。

ChatMind
ChatMind

ChatMind是一款AI生成思维导图的效率工具,可以通过AI对话生成和编辑思维导图。

下载

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

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工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
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

xml是什么格式的文件
xml是什么格式的文件

xml是一种纯文本格式的文件。xml指的是可扩展标记语言,标准通用标记语言的子集,是一种用于标记电子文件使其具有结构性的标记语言。想了解更多相关的内容,可阅读本专题下面的相关文章。

1167

2024.11.28

Go高并发任务调度与Goroutine池化实践
Go高并发任务调度与Goroutine池化实践

本专题围绕 Go 语言在高并发任务处理场景中的实践展开,系统讲解 Goroutine 调度模型、Channel 通信机制以及并发控制策略。内容包括任务队列设计、Goroutine 池化管理、资源限制控制以及并发任务的性能优化方法。通过实际案例演示,帮助开发者构建稳定高效的 Go 并发任务处理系统,提高系统在高负载环境下的处理能力与稳定性。

2

2026.03.10

Kotlin Android模块化架构与组件化开发实践
Kotlin Android模块化架构与组件化开发实践

本专题围绕 Kotlin 在 Android 应用开发中的架构实践展开,重点讲解模块化设计与组件化开发的实现思路。内容包括项目模块拆分策略、公共组件封装、依赖管理优化、路由通信机制以及大型项目的工程化管理方法。通过真实项目案例分析,帮助开发者构建结构清晰、易扩展且维护成本低的 Android 应用架构体系,提升团队协作效率与项目迭代速度。

24

2026.03.09

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

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

80

2026.03.06

Rust内存安全机制与所有权模型深度实践
Rust内存安全机制与所有权模型深度实践

本专题围绕 Rust 语言核心特性展开,深入讲解所有权机制、借用规则、生命周期管理以及智能指针等关键概念。通过系统级开发案例,分析内存安全保障原理与零成本抽象优势,并结合并发场景讲解 Send 与 Sync 特性实现机制。帮助开发者真正理解 Rust 的设计哲学,掌握在高性能与安全性并重场景中的工程实践能力。

187

2026.03.05

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

339

2026.03.04

热门下载

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

精品课程

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

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