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

 待续...