Jackson序列化去除集合节点详解

本文深入解析了如何利用Jackson的`@JacksonXmlElementWrapper(useWrapping = false)`与`@JacksonXmlProperty`双注解协同配置，精准实现Java集合字段在XML序列化时跳过默认冗余包装标签（如``），直接将每个列表元素以指定名称（如``）平铺为父节点下的同级子元素——既满足严格XML Schema兼容性要求，又避免自定义序列化器或复杂配置，用最简洁、标准的Jackson XML模块能力，高效生成符合SOAP、EDI等场景需求的扁平化、可读性强的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片段）要求的轻量级数据交换格式。

理论要掌握，实操不能落！以上关于《Jackson序列化去除集合节点详解》的详细介绍，大家都掌握了吧！如果想要继续提升自己的能力，那么就来关注golang学习网公众号吧！