jaxb使用 | JAXB

一、前言

JAXB——Java Architecture for XML Binding，是一项可以根据XML Schema产生Java类的技术。JAXB提供将XML实例文档反向生成Java对象树的方法，也能将Java对象树的内容重新写到XML实例文档。

二、JAXB相关的class和interface

（1）JAXBContext。 JAXBContext类提供到 JAXB API 的客户端入口点。它提供了管理实现 JAXB 绑定框架操作所需的 XML/Java 绑定信息的抽象，这些操作包括：解组(Unmarshaller )、编组(Marshaller)和验证(Validator)。通常使用JAXBContext.newInstance(XXX.class) 来获取JAXBContext实例（Student是我定义的一个Entity）。

JAXBContext ctx = JAXBContext.newInstance(Student.class)

（2）Unmarshaller。 Unmarshaller 是一个Interface，它管理将 XML 数据反序列化为新创建的 Java 内容树的过程，并可在解组时有选择地验证 XML 数据。它针对如File，InputStream，URL，StringBuffer等各种不同的输入种类，提供各种重载的 unmarshal 方法。unmarshal 方法从不返回 null。如果unmarshal无法将 XML 内容的根解组到 JAXB 映射对象，则抛出 JAXBException。

Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();

Student stu = (Student) unmarshaller.unmarshal(file);

（3）Marshaller。Marshaller使客户端应用程序能够将 Java 内容树转换回 XML 数据。它提供了各种重载的marshal方法。默认情况下，在将 XML 数据生成到 java.io.OutputStream 或 java.io.Writer 中时，Marshaller 将使用 UTF-8 编码。

			Marshaller marshaller = ctx.createMarshaller();

			marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);// 格式化输出

			marshaller.setProperty(Marshaller.JAXB_ENCODING, "UTF-8");// 设置输出编码,默认为UTF-8

			marshaller.marshal(stu, xmlFile);

三、JAXB相关Annotation

（1）@XmlRootElement，将Java类或枚举类型映射到XML元素；

（2）@XmlElement，将Java类的一个属性映射到与属性同名的一个XML元素；

（3）@XmlAttribute，将Java类的一个属性映射到与属性同名的一个XML属性；

注意事项：

（1）对于要序列化（marshal）为XML的Java类，绝不能把成员变量声明为public，否则运行将抛出异常

　　com.sun.xml.internal.bind.v2.runtime.IllegalAnnotationsException

（2）注解不能直接放在成员变量上，可以放在成员变量的getter或setter方法上，任选其一，否则也会抛出IllegalAnnotationsException异常

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