XML编程总结（六）——使用JAXB进行java对象和xml格式之间的相互转换

（六）使用JAXB进行java对象和xml格式之间的相互转换

JAXB能够使用Jackson对JAXB注解的支持实现(jackson-module-jaxb-annotations)，既方便生成XML，也方便生成JSON，这样一来可以更好的标志可以转换为JSON对象的JAVA类。

JAXB（Java Architecture for XML Binding) 是一个业界的标准，是一项可以根据XML Schema产生Java类的技术。该过程中，JAXB也提供了将XML实例文档反向生成Java对象树的方法，并能将Java对象树的内容重新写到XML实例文档。从另一方面来讲，JAXB提供了快速而简便的方法将XML模式绑定到Java表示，从而使得Java开发者在Java应用程序中能方便地结合XML数据和处理函数。

JDK中JAXB相关的重要Class和Interface：

JAXBContext类，是应用的入口，用于管理XML/Java绑定信息。

Marshaller接口，将Java对象序列化为XML数据。

Unmarshaller接口，将XML数据反序列化为Java对象。

JDK中JAXB相关的重要Annotation：注解不能使用在字段上，只能使用在getter/setter方法上

@XmlType，将Java类或枚举类型映射到XML模式类型

@XmlAccessorType(XmlAccessType.FIELD) ，控制字段或属性的序列化。FIELD表示JAXB将自动绑定Java类中的每个非静态的（static）、非瞬态的（由@XmlTransient标注）字段到XML。其他值还有XmlAccessType.PROPERTY和XmlAccessType.NONE。

@XmlAccessorOrder，控制JAXB 绑定类中属性和字段的排序。

@XmlJavaTypeAdapter，使用定制的适配器（即扩展抽象类XmlAdapter并覆盖marshal()和unmarshal()方法），以序列化Java类为XML。

@XmlElementWrapper ，对于数组或集合（即包含多个元素的成员变量），生成一个包装该数组或集合的XML元素（称为包装器）。

@XmlRootElement，将Java类或枚举类型映射到XML元素。

@XmlElement，将Java类的一个属性映射到与属性同名的一个XML元素。

@XmlAttribute，将Java类的一个属性映射到与属性同名的一个XML属性。

测试代码：

Student.java：

public class Student {
    private String name;
    private int age;
    private String sex;
    private Date birthday;
    private String address;
    private List<Friend> friends;

    public Student() {
    }

    public Student(String name, int age, String sex, Date birthday, String address) {
        this.name = name;
        this.age = age;
        this.sex = sex;
        this.birthday = birthday;
        this.address = address;
    }

    public String getName() {
        return name;
    }

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

    //将age字段变成student的一个属性
    @XmlAttribute
    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public String getSex() {
        return sex;
    }

    public void setSex(String sex) {
        this.sex = sex;
    }

    public Date getBirthday() {
        return birthday;
    }

    public void setBirthday(Date birthday) {
        this.birthday = birthday;
    }

    public String getAddress() {
        return address;
    }

    public void setAddress(String address) {
        this.address = address;
    }

    //指定用<friends>标签包围，子标签为<friend>
    @XmlElementWrapper(name="friends")
    @XmlElement(name="friend")
    public List<Friend> getFriends() {
        return friends;
    }

    public void setFriends(List<Friend> friends) {
        this.friends = friends;
    }
}

Friend.java：

public class Friend {

    private String name;
    private int age;
    private String address;

    public Friend() {
    }

    public Friend(String name,int age,String address) {
        this.name = name;
        this.age=age;
        this.address=address;
    }

    public String getName() {
        return name;
    }

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

    @XmlAttribute
    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public String getAddress() {
        return address;
    }

    public void setAddress(String address) {
        this.address = address;
    }
}

Students.java：

@XmlRootElement(name="students")
public class Students {

    private List<Student> students;

    @XmlElement(name="student")
    public List<Student> getStudents() {
        return students;
    }

    public void setStudents(List<Student> students) {
        this.students = students;
    }
}

JAXBTest.java：

public class JAXBTest {

    /**
     * 将java对象转换成xml，并用注解指定生成规则，是生成属性还是生成节点
     * @throws Exception
     */
    @Test
    public void testMarshaller() throws Exception{
        //获得转换的上下文对象
        JAXBContext context = JAXBContext.newInstance(Students.class);
        //获得Marshaller对象
        Marshaller marshaller = context.createMarshaller();
        marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
        //将java对象进行转换成xml
        Students students=new Students();
        List<Student> list=new ArrayList<Student>();
        //第一个Student
        Student student1=new Student("张三",19,"男",new Date(),"北京市怀柔区");
        List<Friend> friends1=new ArrayList<Friend>();
        Friend f11=new Friend("李四",20,"北京市新城区");
        friends1.add(f11);
        Friend f12=new Friend("王五",18,"北京市朝阳区");
        friends1.add(f12);
        student1.setFriends(friends1);
        list.add(student1);
        // 第二个Student
        Student student2 = new Student("李四", 18, "男", new Date(), "北京市怀柔区");
        List<Friend> friends2 = new ArrayList<Friend>();
        Friend f21 = new Friend("张三", 20, "北京市新城区");
        friends2.add(f21);
        Friend f22 = new Friend("赵六", 18, "北京市朝阳区");
        friends2.add(f22);
        student2.setFriends(friends2);
        list.add(student2);
        //添加到Students
        students.setStudents(list);
        
        //打印到控制台
        FileWriter writer=new FileWriter(new File("students.xml"));
        marshaller.marshal(students, writer);
        marshaller.marshal(students, System.out);
    }
    
    /**
     * 读取xml文档，并将xml文档反序列化为java对象
     * @throws Exception
     */
    @Test
    public void testUnMarshaller() throws Exception{
        JAXBContext context = JAXBContext.newInstance(Students.class);
        Unmarshaller unmarshaller = context.createUnmarshaller();
        File f=new File("students.xml");
        Students students = (Students) unmarshaller.unmarshal(f);
        List<Student> list = students.getStudents();
        for(Student student:list){
            System.out.println("name:"+student.getName());
            System.out.println("age:"+student.getAge());
            System.out.println("address:"+student.getAddress());
            System.out.println("-----------------------");
        }
    }
}

输出保存的students.xml：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<students>
    <student age="19">
        <address>北京市怀柔区</address>
        <birthday>2016-10-15T14:59:45.126+08:00</birthday>
        <friends>
            <friend age="20">
                <address>北京市新城区</address>
                <name>李四</name>
            </friend>
            <friend age="18">
                <address>北京市朝阳区</address>
                <name>王五</name>
            </friend>
        </friends>
        <name>张三</name>
        <sex>男</sex>
    </student>
    <student age="18">
        <address>北京市怀柔区</address>
        <birthday>2016-10-15T14:59:45.126+08:00</birthday>
        <friends>
            <friend age="20">
                <address>北京市新城区</address>
                <name>张三</name>
            </friend>
            <friend age="18">
                <address>北京市朝阳区</address>
                <name>赵六</name>
            </friend>
        </friends>
        <name>李四</name>
        <sex>男</sex>
    </student>
</students>