
本文详细介绍了如何利用jaxb(java architecture for xml binding)框架将java对象序列化为特定格式的xml文件,重点讲解了如何通过`@xmlattribute`注解将对象字段映射为xml元素的属性,而非子元素。文章提供了完整的java代码示例,包括数据模型定义和jaxb编组过程,旨在帮助开发者精确控制xml输出结构,满足复杂的格式要求。
在Java开发中,将对象转换为XML(即编组,Marshalling)是一项常见任务,JAXB(Java Architecture for XML Binding)是实现这一目标的标准API。然而,JAXB的默认行为通常会将对象的字段映射为XML元素的子元素。当需要将字段表示为XML元素的属性时,就需要借助特定的JAXB注解来定制化输出格式。
JAXB通过一系列注解来指导Java对象与XML之间的映射关系。要将Java对象的字段映射为XML元素的属性,核心在于使用@XmlAttribute注解。
考虑以下XML结构需求:
<?xml version="1.0" encoding="UTF-8"?>
<persons>
    <person name="Nick" birthday="09.03.1814"/>
    <person surname="Sd" name="aaa" birthday="09.03.1814"/>
</persons>这个结构包含一个根元素<persons>,其下是多个<person>元素。每个<person>元素都通过属性(如name、birthday、surname)来承载数据,而不是通过嵌套的子元素。
立即学习“Java免费学习笔记(深入)”;
如果直接使用JAXB默认方式,可能会生成如下结构:
<dtoPerson>
    <birthday>09.03.1814</birthday>
    <name>aaa Sd</name>
</dtoPerson>这显然不符合需求。为了实现所需的属性化XML结构,我们需要精心设计Java对象模型并应用正确的JAXB注解。
为了生成上述XML结构,我们需要定义两个Java类:一个用于表示单个<person>元素,另一个用于表示包含多个<person>元素的根元素<persons>。
Person类将包含name、birthday和可选的surname字段,它们都将被映射为XML属性。
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlRootElement; // 如果Person可以单独作为根元素,则需要
/**
 * 表示XML中的<person>元素,其数据通过属性表示。
 */
@XmlAccessorType(XmlAccessType.FIELD) // 指定JAXB通过字段访问数据
public class Person {
    @XmlAttribute(name = "name") // 将此字段映射为XML属性"name"
    private String name;
    @XmlAttribute(name = "birthday") // 将此字段映射为XML属性"birthday"
    private String birthday;
    @XmlAttribute(name = "surname") // 可选字段,映射为XML属性"surname"
    private String surname;
    // JAXB需要一个无参构造函数
    public Person() {
    }
    public Person(String name, String birthday, String surname) {
        this.name = name;
        this.birthday = birthday;
        this.surname = surname;
    }
    // Getters and Setters
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String getBirthday() {
        return birthday;
    }
    public void setBirthday(String birthday) {
        this.birthday = birthday;
    }
    public String getSurname() {
        return surname;
    }
    public void setSurname(String surname) {
        this.surname = surname;
    }
    @Override
    public String toString() {
        return "Person{" +
               "name='" + name + '\'' +
               ", birthday='" + birthday + '\'' +
               ", surname='" + surname + '\'' +
               '}';
    }
}注解说明:
Persons类将作为一个容器,包含一个Person对象的列表。
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import java.util.ArrayList;
import java.util.List;
/**
 * 表示XML中的<persons>根元素,包含一个Person对象的列表。
 */
@XmlRootElement(name = "persons") // 将此类映射为XML根元素"persons"
@XmlAccessorType(XmlAccessType.FIELD) // 指定JAXB通过字段访问数据
public class Persons {
    @XmlElement(name = "person") // 将列表中的每个元素映射为XML子元素"person"
    private List<Person> personsList;
    // JAXB需要一个无参构造函数
    public Persons() {
        this.personsList = new ArrayList<>();
    }
    public Persons(List<Person> personsList) {
        this.personsList = personsList;
    }
    // Getters and Setters
    public List<Person> getPersonsList() {
        return personsList;
    }
    public void setPersonsList(List<Person> personsList) {
        this.personsList = personsList;
    }
    public void addPerson(Person person) {
        if (this.personsList == null) {
            this.personsList = new ArrayList<>();
        }
        this.personsList.add(person);
    }
}注解说明:
有了定义好的Java对象模型,接下来就可以使用JAXBContext和Marshaller进行编组操作,将Java对象转换为XML文件。
import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
public class XmlGenerator {
    public static void main(String[] args) {
        // 1. 准备数据
        List<Person> personData = new ArrayList<>();
        personData.add(new Person("Nick", "09.03.1814", null)); // 没有surname
        personData.add(new Person("Alice", "15.06.1990", "Smith"));
        personData.add(new Person("Bob", "22.11.1985", "Johnson"));
        // 2. 创建根对象 (Persons) 并填充数据
        Persons personsWrapper = new Persons(personData);
        try {
            // 3. 创建JAXBContext实例,指定根元素类
            // JAXBContext需要知道哪些类参与到XML的生成中
            JAXBContext jaxbContext = JAXBContext.newInstance(Persons.class);
            // 4. 创建Marshaller实例
            Marshaller marshaller = jaxbContext.createMarshaller();
            // 5. 配置Marshaller属性
            // 设置XML输出格式化,使其具有缩进和换行,提高可读性
            marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
            // 可选:设置XML头编码
            marshaller.setProperty(Marshaller.JAXB_ENCODING, "UTF-8");
            // 6. 执行编组操作
            // 输出到控制台
            System.out.println("--- Generated XML (to console) ---");
            marshaller.marshal(personsWrapper, System.out);
            // 输出到文件
            File file = new File("persons_with_attributes.xml");
            marshaller.marshal(personsWrapper, file);
            System.out.println("\n--- XML file created successfully ---");
            System.out.println("File path: " + file.getAbsolutePath());
        } catch (JAXBException e) {
            System.err.println("Error during JAXB marshalling: " + e.getMessage());
            e.printStackTrace();
        }
    }
}运行上述XmlGenerator的main方法,将会在控制台输出格式化的XML,并生成一个名为persons_with_attributes.xml的文件,其内容如下:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<persons>
    <person name="Nick" birthday="09.03.1814"/>
    <person name="Alice" birthday="15.06.1990" surname="Smith"/>
    <person name="Bob" birthday="22.11.1985" surname="Johnson"/>
</persons>这个输出完全符合我们最初的XML格式要求。
通过上述方法,开发者可以灵活地使用JAXB注解来精确控制Java对象到XML的序列化过程,满足各种复杂的XML格式要求,包括将对象字段映射为XML元素的属性。掌握这些JAXB核心注解和使用模式,将极大地提高XML数据处理的效率和准确性。
以上就是使用JAXB将Java对象序列化为带属性的XML文件的详细内容,更多请关注php中文网其它相关文章!
 
                        
                        每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
 
                Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号