JAXB介紹一

參考博客: https://www.cnblogs.com/chenbenbuyi/p/8283657.html

https://www.cnblogs.com/cnsdhzzl/p/8390514.html

JAXB（Java Architecture for XML Binding) 是一個業界的標准，是一項可以根據XML Schema產生Java類的技術。該過程中，JAXB也提供了將XML實例文檔反向生成Java對象樹的方法，並能將Java對象樹的內容重新寫到XML實例文檔。從另一方面來講，JAXB提供了快速而簡便的方法將XML模式綁定到Java表示，從而使得Java開發者在Java應用程序中能方便地結合XML數據和處理函數。JAXB 2.0是JDK 1.6的組成部分。JAXB 2.2.3是JDK 1.7的組成部分。

　1 常用API

• JAXBContext類，是應用的入口，通過該類創建序列化和反序列化對象，也即編組對象和解組對象；
• Marshaller 編組接口，將Java對象序列化為XML數據；
• Unmarshaller 解組接口，將XML數據反序列化為Java對象。

　2 常用注解

• @XmlRootElement，將Java類或枚舉映射成XML元素根節點，是唯一一個必須注解，name屬性指定根節點名稱，不指定默認為類名的小寫；
• @XmlElement，將Java類的一個屬性映射為XML節點元素，name屬性可自定義元素名；
• @XmlAttribute，將Java類的一個屬性映射為XML節點元素的屬性，name屬性可自定義屬性名；
• @XmlType，將Java類或枚舉類型映射到XML模式類型，常與@XmlRootElement、@XmlAccessorType共用，propOrder屬性定義字段生成的XML節點順序；
• @XmlAccessorType，控制字段或屬性的序列化。屬性XmlAccessType有4個常量值:

　　FIELD表示JAXB將自動綁定Java類中的每個非靜態的（static）、非瞬態的（由@XmlTransient標注）字段到XML；

　　PROPERTY表示java對象中所有通過getter/setter方式綁定成屬性到XML；

　　PUBLIC_MEMBER表示Java對象中所有的public訪問權限的成員變量和通過getter/setter方式訪問的成員變量，該值為默認值；

　　NONE表示Java對象的所有屬性都不映射為XML的元素；

• @XmlAccessorOrder，控制JAXB 綁定類中屬性和字段的排序，有兩個屬性，AccessorOrder.ALPHABETICAL——對生成的XML元素按字母書序排序，XmlAccessOrder.UNDEFINED——不排序，默認為該值；
• @XmlJavaTypeAdapter，自定義適配器（即擴展抽象類XmlAdapter並覆蓋marshal()和unmarshal()方法），解決日期（Date）,數字（Number）格式化問題；
• @XmlElementWrapper ，對於數組或集合（即包含多個元素的成員變量），生成一個包裝該數組或集合的XML元素（稱為包裝器），該注解只能用在集合上；
• @XmlTransient ，用於標示在由Java對象映射XML時，忽略此屬性，在生成的XML文件中將不出現此元素。

　3 實際應用中注意的問題

　　① 如果JavaBean中定義了有參的構造器，那么必須同時定義無參構造器，否則轉XML會拋無默認構造函數的異常;

　　② 成員變量值為NULL時，將不會映射成對應的XML元素——由於基本數據類型默認值不為空，所以基本數據類型不設值也會映射成XML元素，值為默認值,所以如果模型需要基本數據，在屬性定義的時候盡量使用包裝類型；

　　③ @XmlAccessorType 注解中如果屬性值為XmlAccessType.FIELD，則表示通過成員變量來映射，set/get方法上的映射注解就是多余的，所以如果此時set/get方法上再標注元素或者屬性映射注解，將拋屬性重復性異常；屬性值為XmlAccessType.NONE不映射為XML元素的前提是Java字段或set/get方法上都沒有映射注解；

　　④ @XmlType propOrder屬性能夠自定義字段的排序，該屬性如果設置，要么寫成{}的形式，否則在就必須將所有@XmlElement標注或者沒有@XmlElement標注的但實際上會被映射為XML節點的字段添加到排序列表，不然會拋異常；如果propOrder屬性設置有值，@XmlAccessorOrder注解的元素排序規則將失效；

　4 測試實例

首先給出User的JavaBean代碼:

package com.test.util;

import javax.xml.bind.annotation.XmlAccessorOrder;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElementWrapper;

import java.util.Date;
import java.util.List;

import javax.xml.bind.annotation.XmlAccessOrder;

@XmlType(propOrder = {"userName","age","role","date","menu"})
@XmlRootElement(name = "user")
@XmlAccessorOrder(XmlAccessOrder.ALPHABETICAL)
public class User {

    private String userName;
    private int age;
    private String role;
    private Date date;
    private List<Menu> menu;

    public User() {
    }

    public User(String userName, int age, String role, Date date) {
        this.userName = userName;
        this.role = role;
        this.age = age;
        this.date = date;
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

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

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

    @XmlElement
    public String getRole() {
        return role;
    }

    public void setRole(String role) {
        this.role = role;
    }
    
    @XmlJavaTypeAdapter(DateAdapter.class)
    @XmlElement
    public Date getDate() {
        return date;
    }

    public void setDate(Date date) {
        this.date = date;
    }
    
    @XmlElementWrapper(name = "menus")
    @XmlElement
    public List<Menu> getMenu() {
        return menu;
    }

    public void setMenu(List<Menu> menu) {
        this.menu = menu;
    }

    @Override
    public String toString() {
        return "User{" +
                "userName='" + userName + '\'' +
                ", age=" + age +
                ", role='" + role + '\'' +
                ", date='" + date + '\'' +
                ", menu=" + menu +
                '}';
    }
    
}

在給出DateAdapter的代碼:

package com.test.util;

import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;

import javax.xml.bind.annotation.adapters.XmlAdapter;

public class DateAdapter extends XmlAdapter<String, Date> {
    private static final DateFormat SDF = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");

    @Override
    public Date unmarshal(String date) throws Exception {
        return SDF.parse(date);
    }

    @Override
    public String marshal(Date date) throws Exception {
        return SDF.format(date);
    }
}

再給出Menu的代碼:

package com.test.util;

import java.util.List;

import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement
public class Menu {
    private String name;
    private String id;
    private List<Menu> child;

    public Menu() {
    }

    public Menu(String name, String id) {
        this.name = name;
        this.id = id;
    }
    
    @XmlAttribute
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
    
    @XmlAttribute
    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public List<Menu> getChild() {
        return child;
    }

    public void setChild(List<Menu> child) {
        this.child = child;
    }

    @Override
    public String toString() {
        return "Menu{" +
                "name='" + name + '\'' +
                ", id='" + id + '\'' +
                '}';
    }
}

給出Main方法里調用解析xml的代碼:

package com.test;

import java.util.List;
import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;
import javax.xml.bind.Unmarshaller;

import com.test.util.Menu;
import com.test.util.User;

public class Test {
public static void main(String[] args) {
        // TODO Auto-generated method stub
        
        DateFormat SDF = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        User user = new User("UserName1", 2018, "SuperMan", new Date());
        
        List<Menu> list1 = new ArrayList<>();
        Menu menu1 = new Menu("SystemManage", "1111");
        Menu child1 = new Menu("AuthoriManage", "2222");
        Menu child2 = new Menu("UserManage", "3333");
        list1.add(child1);
        list1.add(child2);
        menu1.setChild(list1);
        
        List<Menu> list2 = new ArrayList<>();
        Menu menu2 = new Menu("SystemManage", "4444");
        Menu child3 = new Menu("AuthoriManage", "5555");
        Menu child4 = new Menu("UserManage", "6666");
        list2.add(child3);
        list2.add(child4);
        menu2.setChild(list2);
        
        List<Menu> menus = new ArrayList<>();
        menus.add(menu1);
        menus.add(menu2);
        
        user.setMenu(menus);
       
        try {
            JAXBContext jaxbContext = JAXBContext.newInstance(User.class);
            Marshaller marshaller = jaxbContext.createMarshaller();
            marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
            File file = new File("E://user.xml");
            marshaller.marshal(user, file);
            marshaller.marshal(user, System.out);
        } catch (JAXBException e1) {
            System.out.println("e1="+e1.getMessage());
        }
        
        try {
            File file1 = new File("E://user.xml");
            JAXBContext jaxbContext = JAXBContext.newInstance(User.class);
            Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
            User u = (User)unmarshaller.unmarshal(file1);
            System.out.println("userName="+u.getUserName()+",role="+u.getRole());
            System.out.println("date="+SDF.format(u.getDate()));
            List<Menu> menuss = u.getMenu();
            Menu menu = null;
            for(int i=0;i<menuss.size();i++){
                menu = menuss.get(i);
                List<Menu> menuChild = menuss.get(i).getChild();
                System.out.println("id="+menu.getId()+",name="+menu.getName());
                for(int j=0;j<menuChild.size();j++){
                    System.out.println(" child=>id="+menuChild.get(j).getId()+",name="+menuChild.get(j).getName());
                }
            }
        } catch (JAXBException e2) {
            System.out.println("e2="+e2.getMessage());
        }
    }

 最后給出結果(控制台(Console)打印出來的結果):

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<user age="2018">
    <userName>UserName1</userName>
    <role>SuperMan</role>
    <date>2018-09-17 15:30:47</date>
    <menus>
        <menu id="1111" name="SystemManage">
            <child id="2222" name="AuthoriManage"/>
            <child id="3333" name="UserManage"/>
        </menu>
        <menu id="4444" name="SystemManage">
            <child id="5555" name="AuthoriManage"/>
            <child id="6666" name="UserManage"/>
        </menu>
    </menus>
</user>

userName=UserName1,role=SuperMan
date=2018-09-17 15:30:47
id=1111,name=SystemManage
  child=>id=2222,name=AuthoriManage
  child=>id=3333,name=UserManage
id=4444,name=SystemManage
  child=>id=5555,name=AuthoriManage
  child=>id=6666,name=UserManage

 待續...