使用JAXB将Java对象转换为特定属性格式的XML文件

本教程详细介绍了如何利用java architecture for xml binding (jaxb) 将java对象转换为具有特定属性格式的xml文件。通过使用`@xmlattribute`注解，开发者可以精确控制对象字段在xml中以属性而非元素的形式呈现。同时，文章也涵盖了如何通过包装类处理对象列表，以生成包含根元素和多个子元素的复杂xml结构，确保输出符合预设的xml格式要求。

引言：JAXB与XML数据绑定

在Java应用开发中，经常需要将Java对象转换为XML格式，或将XML数据解析回Java对象。Java Architecture for XML Binding (JAXB) 是一个强大的API和工具集，它提供了一种将Java对象与XML模式进行绑定的机制。通过JAXB，开发者可以简化XML数据的序列化（编组，Marshalling）和反序列化（解组，Unmarshalling）过程，无需手动处理DOM或SAX事件。

问题剖析：Java对象到特定XML属性格式的挑战

JAXB在默认情况下，会将Java对象的字段或属性映射为XML元素。例如，如果有一个DtoPerson类包含name和birthday字段，JAXB通常会生成如下XML：

    09.03.1814
    aaa Sd

然而，在许多场景下，我们可能需要将这些数据以XML属性的形式呈现，并且可能需要一个特定的根元素来包含多个这样的对象，例如：

或者：

立即学习“Java免费学习笔记（深入）”；

知了zKnown

知了zKnown：致力于信息降噪 / 阅读提效的个人知识助手。

下载

这种默认行为与期望格式之间的差异，是JAXB初学者常遇到的问题。核心挑战在于如何指示JAXB将Java对象的字段映射为XML属性，以及如何正确地组织一个包含多个对象的XML结构。

核心注解：@XmlAttribute 与 @XmlRootElement

解决上述问题的关键在于JAXB提供的一系列注解。

1. @XmlAttribute: 这个注解用于标记Java对象的字段或getter方法，指示JAXB在生成XML时将其作为XML元素的属性。
2. @XmlRootElement: 这个注解用于标记Java类，表示该类是XML文档的根元素。它有一个name属性，可以指定XML根元素的名称。
3. @XmlElement: 虽然不是本次问题的核心，但它与@XmlAttribute相对，用于明确指定字段或getter方法应映射为XML元素。在处理集合或复杂对象时，它也用于指定子元素的名称。

定义数据模型：Person 对象与 PersonsWrapper

为了生成我们期望的XML结构（即根元素下包含多个元素，且元素的详细信息以属性形式存在），我们需要定义两个Java类：一个代表单个person的类，以及一个用于包装person列表的根类。

1. Person DTO类

这个类将代表XML中的元素。其字段将通过@XmlAttribute注解映射为属性。

import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType; // 可选，用于控制属性顺序

// 定义XML根元素名称为 "person"。
// 如果这个类直接作为JAXBContext的类型进行编组，将生成 ...
// 如果作为另一个类的成员，则其名称由 @XmlElement(name="person") 控制。
@XmlRootElement(name = "person")
// @XmlType(propOrder = {"name", "surname", "birthday"}) // 可选：控制XML属性的输出顺序
public class Person {
    private String name;
    private String surname;
    private String birthday;

    public Person() {
        // JAXB需要一个无参构造函数
    }

    public Person(String name, String surname, String birthday) {
        this.name = name;
        this.surname = surname;
        this.birthday = birthday;
    }

    // 使用 @XmlAttribute 注解将字段映射为XML属性
    @XmlAttribute(name = "name")
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    @XmlAttribute(name = "surname")
    public String getSurname() {
        return surname;
    }

    public void setSurname(String surname) {
        this.surname = surname;
    }

    @Xml