
本文详解如何使用Jackson的@JacksonXmlElementWrapper(useWrapping = false)配合@JacksonXmlProperty,实现POJO转XML时跳过默认集合外层标签(如),直接将列表元素平铺为同级XML节点。
本文详解如何使用jackson的`@jacksonxmlelementwrapper(usewrapping = false)`配合`@jacksonxmlproperty`,实现pojo转xml时跳过默认集合外层标签(如`
在使用Jackson进行Java对象到XML的序列化(即XmlMapper)时,一个常见需求是:对List
✅ 正确配置方式
关键在于对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片段)要求的轻量级数据交换格式。









