20190329学习笔记 - JAXB注解的使用详解

在开始介绍jaxb注解的使用方法之前，我们先来看看具体是什么？有什么用？

一、 JAXB是什么？

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

二、 注解介绍

1. Jaxb中处理java和xml之间转换的常用注解有：

1. @XmlType

2. @XmlElement

3. @XmlRootElement

4. @XmlAttribute

5. @XmlAccessorType

6. @XmlAccessorOrder

7. @XmlTransient

8. @XmlJavaTypeAdapter

2. 常用annotation使用说明

@XmlType

该注解用在class类上，常与@XmlRootElement，@XmlAccessorType一起使用。它有三个属性：name、propOrder、namespace，经常使用的只有前两个属性。如：

	@XmlType(name = "basicStruct", propOrder = {"intValue","stringArray","stringValue")
	Public class myType{…}

在使用@XmlType的propOrder属性时，必须列出JavaBean对象中的所有属性（也要在所有属性上加上xml注解），否则会报错。

@XmlElement

该注解用在java类的属性上，用于将属性映射为xml的子节点。可通过在后面配置name属性值来改变java属性在xml文件中的名称。如：

@XmlElement(name="Address")　　
private String yourAddress;

此处配置后，在xml文件中的节点为< Address>，而不是< yourAddress/>。

@XmlRootElement

类级别的注解，对应的是xml文件中的根节点。常与 @XmlType 和 @XmlAccessorType一起使用。如：

@XmlType
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement
public class Address {}

@XmlAttribute

用于把java对象的属性映射为xml的属性,并可通过name属性为生成的xml属性指定别名。如：

@XmlAttribute(name="Country")
private String state;

@XmlAccessorType

@XmlAccessorType用于指定由java对象生成xml文件时对java对象属性的访问方式。常与@XmlRootElement、@XmlType一起使用。它的属性值是XmlAccessType的4个枚举值，分别为：

1. XmlAccessType.FIELD：java对象中的所有成员变量；
2. XmlAccessType.PROPERTY：java对象中所有通过getter/setter方式访问的成员变量；
3. XmlAccessType.PUBLIC_MEMBER：java对象中所有的public访问权限的成员变量和通过getter/setter方式访问的成员变量；
4. XmlAccessType.NONE：java对象的所有属性都不映射为xml的元素。

注意：@XmlAccessorType的默认访问级别是XmlAccessType.PUBLIC_MEMBER。因此，如果java对象中的private成员变量设置了public权限的getter/setter方法，就不要在private变量上使用@XmlElement和@XmlAttribute注解，否则在由java对象生成xml时会报同一个属性在java类里存在两次的错误。同理，如果@XmlAccessorType的访问权限为XmlAccessType.NONE，如果在java的成员变量上使用了@XmlElement或@XmlAttribute注解，这些成员变量依然可以映射到xml文件。

@XmlAccessorOrder

用于对java对象生成的xml元素进行排序。它有两个属性值：

1. AccessorOrder.ALPHABETICAL：对生成的xml元素按字母顺序排序；
2. XmlAccessOrder.UNDEFINED：不排序。

@XmlTransient

用于标示在由java对象映射xml时，忽略此属性。即，在生成的xml文件中不出现此元素。

@XmlJavaTypeAdapter

@XmlJavaTypeAdapter常用在转换比较复杂的对象时，如map类型或者格式化日期等。使用此注解时，需要自己写一个adapter类继承XmlAdapter抽象类，并实现里面的方法。
@XmlJavaTypeAdapter(value=xxx.class),value为自己定义的adapter类

XmlAdapter如下：

public abstract class XmlAdapter<ValueType,BoundType> {
    // Do-nothing constructor for the derived classes.
    protected XmlAdapter() {}
    // Convert a value type to a bound type.
    public abstract BoundType unmarshal(ValueType v);
    // Convert a bound type to a value type.
    public abstract ValueType marshal(BoundType v);
 }