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>