JAXB使用方式

Posted 2020-10-11 H.U.C-王子

JAXB（Java Architecture for XML Binding) 是一个业界的标准，是一项可以根据XML Schema产生Java类的技术。该过程中，JAXB也提供了将XML实例文档反向生成Java对象树的方法，并能将Java对象树的内容重新写到 XML实例文档。

现在在软件开发中，主要也就是使用它XML与JAVA类互相转换的功能了

一些常用的属性解释：

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

@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属性。

 

下面是代码演示：

import java.io.Serializable;

import javax.inject.Named;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;

/**
 * @XmlAccessorType(XmlAccessType.FIELD)指定映射本类的所有字段
 * @XmlRootElement 用在class类的注解，常与@XmlRootElement，@XmlAccessorType一起使用.也可以单独使用,如果单独使用,需要在get方法上加@XmlElement等注解.
 * @XmlType,在使用@XmlType的propOrder 属性时，必须列出JavaBean对象中的所有XmlElement，否则会报错。
 * @author smn
 * 
 */
@Named
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement(name = "Customer")
@XmlType(name = "Customer", propOrder = { "age", "name" })
public class Customer implements Serializable {

    private static final long serialVersionUID = 1L;
    
    // 其实@XmlType已经默认会读取下面的name和[email protected]在@XmlType存在的情况下,只会起到一个标识作用.
    @XmlAttribute
    int id;
    @XmlElement
    String name;
    @XmlElement
    int age;

    public int getId() {
        return id;
    }

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

    public int getAge() {
        return age;
    }

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

    public String getName() {
        return name;
    }

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

JAVA转为XML

    public static void main(String[] args) {
        Customer cus=new Customer();
        cus.setId(1);
        cus.setName("Hello World!");
        cus.setAge(26);
        
        try {
            File file=new File("D:\\HelloWorld.xml");
            //初始化JAXBContext.JAXBContext类提供的JAXB API的客户端的入口点。
            //它提供一个抽象的用于管理XML / Java绑定的必要信息，以实现JAXB绑定框架行动：解组，编组和验证。
            JAXBContext jc=JAXBContext.newInstance(Customer.class);
            //将Java对象Marshal成XML内容的Marshal的初始化设置.
            Marshaller jaxbMarshaller=jc.createMarshaller();
            //output
            jaxbMarshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
            jaxbMarshaller.marshal(cus, file);
            jaxbMarshaller.marshal(cus, System.out);
            
        } catch (JAXBException e) {
            System.out.println("output xml error!");
            e.printStackTrace();
        }
    }

XML转为JAVA

    public static void main(String[] args) {
        File file=new File("D:\\HelloWorld.xml");
        try {
            //反着来
            JAXBContext jc=JAXBContext.newInstance(Customer.class);
            Unmarshaller unmarshaller=jc.createUnmarshaller();
            Customer cus=(Customer) unmarshaller.unmarshal(file);
            System.out.println("data:"+cus);
            System.out.println("data:"+cus.getId());
            System.out.println("data:"+cus.getName());
            System.out.println("data:"+cus.getAge());
        } catch (JAXBException e) {
            System.out.println("input xml error!");
            e.printStackTrace();
        }
        
    }

通常情况下就像上面的代码一样，转换后存储在本地，但这样并不能完成项目的实际应用，所以我们可以进行一下下面的优化

public static void main(String[] args) {
        Customer cus=new Customer();
        cus.setId(1);
        cus.setName("Hello World!");
        cus.setAge(26);
        
        try {
            //初始化JAXBContext.JAXBContext类提供的JAXB API的客户端的入口点。
            //它提供一个抽象的用于管理XML / Java绑定的必要信息，以实现JAXB绑定框架行动：解组，编组和验证。
            JAXBContext jc=JAXBContext.newInstance(Customer.class);
            //将Java对象Marshal成XML内容的Marshal的初始化设置.
            Marshaller jaxbMarshaller=jc.createMarshaller();
            StringWriter writer=new StringWriter();
            jaxbMarshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
            jaxbMarshaller.marshal(cus, writer);
　　　　　　　　
            System.out.println(writer);
            
        } catch (JAXBException e) {
            System.out.println("output xml error!");
            e.printStackTrace();
        }
    }

可以看到我们并不需要把XML存储到本地，可以在生成后直接将其转换为字符串，这样我们就可以通过dom4j、jdom等三方jar包对XML格式的字符串进行解析处理，如果把上面代码优化封装成一个泛型方法，就可以很方便的实现自动解析XML或者自动将实体类生成XML文件等操作，而只有这样做才可以更方便的应用于平时的项目开发中去。