如何使用 Jackson XML 为集合元素自定义标签名称

陌辰大大_6971

发布时间：2026-02-23 14:51:01

497人浏览过

来源于php中文网

原创

如何使用 Jackson XML 为集合元素自定义标签名称

本文详解如何通过 Jackson 的 @JacksonXmlRootElement、@JacksonXmlElementWrapper 和 @JacksonXmlProperty 注解，精准控制 XML 序列化时的标签命名，特别是解决集合项（如）与包装容器（如）标签名混淆的问题。

本文详解如何通过 jackson 的 `@jacksonxmlrootelement`、`@jacksonxmlelementwrapper` 和 `@jacksonxmlproperty` 注解，精准控制 xml 序列化时的标签命名，特别是解决集合项（如 ``）与包装容器（如 ``）标签名混淆的问题。

在使用 Jackson Dataformat XML 进行 Java 对象到 XML 的序列化时，集合字段（如 List）默认会生成同名的嵌套标签——即容器标签（wrapper）和元素标签（item）均采用字段名（如 albums），导致输出为，这显然不符合语义规范与预期结构。

要实现目标结构：

<Artist>
  <name>Some name</name>
  <albums>
    <album name="Some name1" year="1985"/>
    <album name="Some name2" year="1986"/>
  </albums>
</Artist>

关键在于分离容器标签与元素标签的命名职责：

容器标签（）由 List 字段本身控制；
元素标签（）由每个 Album 实例的“根元素名”决定，而非类名自动映射。

✅ 正确做法：组合使用三类核心注解

1. 为集合字段指定容器标签（wrapper）

在 Artist 类中，为 albums 字段添加 @JacksonXmlElementWrapper，显式声明容器名，并禁用默认 wrapper（若需更简洁结构可选）：

public class Artist {
    private String name;

    @JacksonXmlElementWrapper(localName = "albums") // ← 控制外层容器标签
    @JacksonXmlProperty(localName = "album")        // ← 控制每个子元素的标签名（非类名！）
    private List<Album> albums = new ArrayList<>();

    // getter/setter...
}

⚠️ 注意：@JacksonXmlProperty(localName = "album") 必须标注在 字段或 getter 上（而非 Album 类内部），它告诉 Jackson：该 List 中的每个对象应以标签序列化——这是最直接、最推荐的方式。

2. Album 类无需 @JacksonXmlRootElement

原答案中建议在 Album 构造器上加 @JacksonXmlRootElement(localName = "album") 是不正确且无效的：该注解仅对作为根节点直接序列化的对象生效（如 xmlMapper.writeValueAsString(new Album(...))），而当 Album 作为集合元素被嵌套序列化时，该注解会被忽略。因此不应依赖此方式。

正确的 Album 类保持简洁，仅需正确标注属性级注解：

public class Album {
    private String name;
    private int year;

    public Album() {} // Jackson 需要无参构造器（除非启用 @JsonCreator）

    public Album(String name, int year) {
        this.name = name;
        this.year = year;
    }

    @JacksonXmlProperty(isAttribute = true)
    public String getName() {
        return name;
    }

    @JacksonXmlProperty(isAttribute = true)
    public int getYear() {
        return year;
    }
}

3. 完整可运行示例

ObjectMapper xmlMapper = new XmlMapper();
xmlMapper.enable(SerializationFeature.INDENT_OUTPUT);

Artist artist = new Artist();
artist.setName("Some name");
artist.getAlbums().add(new Album("Some name1", 1985));
artist.getAlbums().add(new Album("Some name2", 1986));

String xml = xmlMapper.writeValueAsString(artist);
System.out.println(xml);

输出即为目标格式，且语义清晰、符合 XML 最佳实践。