JAXB應用實例

　　過往的項目中數據存儲都離不開數據庫，不過最近做的一個項目的某些數據（比如人員信息、菜單、權限等等）卻完全沒有涉及任何數據庫操作，直接XML搞定。這里無意比較優劣，因為數據庫存儲和XML存儲本就有不同的適用場景，盲目比較毫無意義，只是因為業務需要，僅此而已。先來概念一下——XML，可擴展標記語言，設計宗旨是用來傳輸數據而非顯示數據，其遵循W3C標准，是一種通用的數據交換格式,具有很強的跨平台性，並且數據無需轉換，所以，如果你要將數據做跨平台傳輸，那么把數據保存在 XML 文件中是有好處的。當然，這里要說明，由於XML僅僅是作為一種文檔模式的結構化存儲，所以並不適用於大數據量的存儲。現在的Java中有很多類庫比如DOM、SAX、JDOM和DOM4J等等都可以操作XML，但如果僅僅是想做JavaBean和XML節點元素的互相轉換，而不涉及動態XML的處理，那么JAXB絕對是一個不錯的選擇。在比較新的jdk版本中，JAXB都是jdk的擴展包javax中自帶的類庫，不需要你引入第三方jar包。下面，博主正式給看客上菜，詳細介紹一下JAXB的實際用法——

 一 JavaBean和XML相互轉換初體驗

package model;

import javax.xml.bind.annotation.*;
import java.io.Serializable;

//JavaBean代碼

@XmlType(propOrder = {})
@XmlRootElement(name = "user")
@XmlAccessorType(XmlAccessType.PROPERTY)
@XmlAccessorOrder(XmlAccessOrder.ALPHABETICAL)
public class User implements Serializable {

    private String userName;
    private int age;
    private String role;
    private String bibi;

    public User() {
    }

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

    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;
    }

    @XmlTransient
    public String getBibi() {
        return bibi;
    }

    public void setBibi(String bibi) {
        this.bibi = bibi;
    }

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

//測試
public class test {
    @Test
    public void saveXmlTest() {
        User user = new User("陳本布衣", 2018, "超級管理員","瞎嗶嗶");
        File file = new File("E://user.xml");
        try {
            JAXBContext jaxbContext = JAXBContext.newInstance(User.class);
            Marshaller marshaller = jaxbContext.createMarshaller();
            //格式化輸出，即按標簽自動換行，否則就是一行輸出
            marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
            //設置編碼（默認編碼就是utf-8）
            marshaller.setProperty(Marshaller.JAXB_ENCODING, "UTF-8");
            //是否省略xml頭信息，默認不省略（false）
            marshaller.setProperty(Marshaller.JAXB_FRAGMENT, false);
            marshaller.marshal(user, file);
        } catch (JAXBException e) {
            e.printStackTrace();
        }
    }

    @Test
    public void getUserTest() {
        File file = new File("E://user.xml");
        try {
            JAXBContext jaxbContext = JAXBContext.newInstance(User.class);
            Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
            User user = (User) unmarshaller.unmarshal(file);
            System.out.println(user.toString());
        } catch (JAXBException e) {
            e.printStackTrace();
        }
    }
}

生成的XML:

二 JAXB使用基礎介紹

　　① 常用API

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

　　② 常用注解

• @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文件中將不出現此元素。

　　③ 實際應用中注意的問題

　　① 如果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注解的元素排序規則將失效；

三 應用實際

　　先准備好測試用的工具方法：

package util;


import model.User;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;
import javax.xml.bind.Unmarshaller;
import java.io.File;

public class JaxbUtil {

    public static void convertToXml(Object obj, File file) {
        try {
            JAXBContext jaxbContext = JAXBContext.newInstance(User.class);
            Marshaller marshaller = jaxbContext.createMarshaller();
            //格式化輸出，即按標簽自動換行，否則就是一行輸出
            marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
            //設置編碼（默認編碼就是utf-8）
            marshaller.setProperty(Marshaller.JAXB_ENCODING, "UTF-8");
            //是否省略xml頭信息，默認不省略（false）
            marshaller.setProperty(Marshaller.JAXB_FRAGMENT, false);
            marshaller.marshal(obj, file);
            //控制台輸出
            marshaller.marshal(obj,System.out);
        } catch (JAXBException e) {
            e.printStackTrace();
        }
    }

    public static <T> T convertToJavaBean(Class<T> clz, File file) {
        try {
            JAXBContext jaxbContext = JAXBContext.newInstance(clz);
            Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
            T t = (T) unmarshaller.unmarshal(file);
            return t;
        } catch (JAXBException e) {
            e.printStackTrace();
        }
        return null;
    }
}

　　① 簡單對象處理

　　簡單對象處理起來比較簡單，譬如人員對象User中包含菜單Menu,只需將定義的普通Menu對象也按照JAXB的注解進行標注，在User對象中當成普通字段一樣的定義即可——

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

    private String userName;
    private int age;
    private String role;
    private String bibi;
    private Menu menu;
    public User() {
    }

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

    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(nillable=true)
    public String getRole() {
        return role;
    }

    public void setRole(String role) {
        this.role = role;
    }

    @XmlTransient
    public String getBibi() {
        return bibi;
    }

    public void setBibi(String bibi) {
        this.bibi = bibi;
    }

    @XmlElement
    public Menu getMenu() {
        return menu;
    }

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

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


//菜單對象

@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
public class Menu {
    private String name;
    private String id;

    public Menu() {
    }

    public Menu(String name, String id) {
        this.name = name;
        this.id = id;
    }

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

　

　　② 集合處理

　　實際應用場景中集合應用要更常見一些，比如上面的用戶菜單，一個用戶肯定會有多個不同的菜單，所以，我們來將上面的菜單改用集合處理——

package model;

import javax.xml.bind.annotation.*;
import java.io.Serializable;
import java.util.Date;
import java.util.List;

@XmlType(propOrder = {"userName", "role", "menus"})
@XmlRootElement(name = "user")
@XmlAccessorOrder(XmlAccessOrder.ALPHABETICAL)
public class User implements Serializable {

    private String userName;
    private int age;
    private String role;
    private String bibi;
    private List<Menu> menus;

    public User() {
    }

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

    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;
    }

    @XmlTransient
    public String getBibi() {
        return bibi;
    }

    public void setBibi(String bibi) {
        this.bibi = bibi;
    }

    @XmlElement
    public List<Menu> getMenus() {
        return menus;
    }

    public void setMenus(List<Menu> menus) {
        this.menus = menus;
    }

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

package model;

import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlRootElement;
import java.util.List;

@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 + '\'' +
                '}';
    }
}

package test;


import model.Menu;
import model.User;
import org.junit.Test;
import util.JaxbUtil;
import java.io.File;
import java.util.ArrayList;
import java.util.List;

public class test {
    @Test
    public void saveXmlTest() {
        User user = new User("陳本布衣", 2018, "超級管理員","瞎嗶嗶");
        List<Menu> list1 = new ArrayList<>();
        Menu menu1 = new Menu("系統管理","9527");
        Menu child1 = new Menu("權限管理","9999");
        Menu child2 = new Menu("用戶管理","2322");
        list1.add(child1);
        list1.add(child2);
        menu1.setChild(list1);
        List<Menu> list2 = new ArrayList<>();
        Menu menu2 = new Menu("參數配置","2222");
        Menu child3 = new Menu("權限管理","3333");
        Menu child4 = new Menu("用戶管理","4444");
        list2.add(child3);
        list2.add(child4);
        menu2.setChild(list2);
        List<Menu> menus = new ArrayList<>();
        menus.add(menu1);
        menus.add(menu2);
        user.setMenus(menus);
        File file = new File("E://user.xml");
        JaxbUtil.convertToXml(user,file);
    }

    @Test
    public void getUserTest() {
        File file = new File("E://user.xml");
        User user = JaxbUtil.convertToJavaBean(User.class, file);
        System.out.println(user);
    }
}

　

　　上面的菜單中似乎少了點層次關系，這個時候可以使用集合包裝器注解@XmlElementWrapper自定義一個包裝節點，這樣產生的XML文檔才更有層次：

    @XmlElementWrapper(name = "menu")
    @XmlElement
    public List<Menu> getMenus() {
        return menus;
    }

　　最終產生的XML文檔就是這樣的：

　

　　③ 格式化處理

 　　業務數據中日期、數值通常是必不可少的，在數據存儲的時候，這些數據通常都需要做格式化處理，比如將日期格式化，貨幣型數值處理等等。JAXB中格式化處理需要繼承適配器抽象類XmlAdapter，並覆寫其序列化和反序列化的方法，這里僅用常用的日期格式化為例：

package adapter;

import javax.xml.bind.annotation.adapters.XmlAdapter;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;

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);
    }
}

　　將該適配器通過注解應用到User類表時間的date字段上：

    @XmlJavaTypeAdapter(DateAdapter.class)
    public Date getDate() {
        return date;
    }

    public void setDate(Date date) {
        this.date = date;
    }

 　　最后的時間就是按照格式化輸出——

　　

　　④ 數據的修改

　　由於XML是文檔數據類型，對於文檔數據的修改操作，通常采用的都是先將文本內容全部讀取到內存，修改完成后再寫回去文本的方式——雖然Java中有RandomAccessFile類可以實現對文本任意位置的訪問修改，但博主以為，在JAXB這種對象模型映射成XML的業務中並不適用。我們將上面的模型稍微簡化一下，完成根據用戶id修改用戶數據的測試——

@XmlType(propOrder = {"users", "userName", "role", "remark"})
@XmlRootElement(name = "user")
@XmlAccessorOrder(XmlAccessOrder.ALPHABETICAL)
public class User implements Serializable {

    private String userName;
    private Integer id;
    private String role;
    private String remark;
    private List<User> users;

    public User() {
    }

    public User(String userName, Integer id, String role, String remark) {
        this.userName = userName;
        this.id = id;
        this.role = role;
        this.remark = remark;
    }

    public String getUserName() {
        return userName;
    }

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

    @XmlAttribute
    public Integer getId() {
        return id;
    }

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

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

    public void setRole(String role) {
        this.role = role;
    }

    public String getRemark() {
        return remark;
    }

    public void setRemark(String remark) {
        this.remark = remark;
    }

    public List<User> getUsers() {
        return users;
    }

    public void setUsers(List<User> users) {
        this.users = users;
    }
}

//測試代碼
public class test {

    @Test
    public void editUser() {
        User root  = new User();
        File file = new File("E://user.xml");
        //模擬修改后的一條數據
        User editUser = new User("陳本布衣", 2018, "超級管理員","數據修改后");
        User user = JaxbUtil.convertToJavaBean(User.class, file);
        List<User> users = user.getUsers();
        for (int i = 0; i < users.size(); i++) {
            if(users.get(i).getId().equals(editUser.getId())){
                users.set(i,editUser);
            }
        }
        root.setUsers(users);
        JaxbUtil.convertToXml(root,file);
    }
}

　　最后，在XML文檔中你可以看到文檔內容已經被修改了——

  　　　

四 問題補充

　　上述博文中描述的工具方法僅僅是出於學習中追根問本的目的寫得稍微冗余了些，實際上，我所知道的是最遲從jdk1.7開始，JAXB就對解組和編組的方法進行了更簡單的封裝，所以，實際項目中除非自己要進行個性化設置，否則大可不用自己再創建JAXBContext實例，直接通過JAXB靜態調用相應的工具方法就行了，有興趣的看官稍微跟蹤一下源碼就能了然，於是上面的工具方法可以寫得更簡單——

package util;


import javax.xml.bind.JAXB;
import java.io.File;

public class JaxbUtil {

    public static void convertToXml(Object obj, File file) {
        JAXB.marshal(obj,file);
    }

    public static <T> T convertToJavaBean(Class<T> clz, File file) {
        return JAXB.unmarshal(file, clz);
    }
}

　　OK,對於JAXB的知識分享就差不多這么些了。對於這種比較單一技能點的學習，就是根據API多寫點代碼練習測試，從測試的結果對錯中總結出自己的深層理解，並在實際項目學以致用，不變應萬變，望看官讀畢都有所收獲！