JAXB中主要的一些註解

@XmlRootElement   將一個Java類映射爲一段XML的根節點

參數：name            定義這個根節點的名稱

          namespace   定義這個根節點命名空間

@XmlAccessorType  定義映射這個類中的何種類型需要映射到XML。可接收四個參數，分別是：

      XmlAccessType.FIELD：映射這個類中的所有字段到XML

      XmlAccessType.PROPERTY：映射這個類中的屬性（get/set方法）到XML

      XmlAccessType.PUBLIC_MEMBER：將這個類中的所有public的field或property同時映射到XML（默認）

      XmlAccessType.NONE：不映射

@XmlElement  指定一個字段或get/set方法映射到XML的節點。如，當一個類的XmlAccessorType 被標註爲PROPERTY時，在某一個沒有get/set方法的字段上標註此註解，即可將該字段映射到XML。

參數：defaultValue  指定節點默認值

         name             指定節點名稱

         namespace    指定節點命名空間

         required         是否必須（默認爲false）

         nillable           該字段是否包含 nillable="true" 屬性（默認爲false）

         type               定義該字段或屬性的關聯類型



@XmlAttribute  指定一個字段或get/set方法映射到XML的屬性。

參數：name             指定屬性名稱

         namespace    指定屬性命名空間

         required         是否必須（默認爲false）

@XmlTransient  定義某一字段或屬性不需要被映射爲XML。如，當一個類的XmlAccessorType 被標註爲PROPERTY時，在某一get/set方法的字段上標註此註解，那麼該屬性則不會被映射。

@XmlType 定義映射的一些相關規則

參數：propOrder        指定映射XML時的節點順序

         factoryClass     指定UnMarshal時生成映射類實例所需的工廠類，默認爲這個類本身

         factoryMethod  指定工廠類的工廠方法

         name               定義XML Schema中type的名稱

         namespace      指定Schema中的命名空間

@XmlElementWrapper  爲數組元素或集合元素定義一個父節點。如，類中有一元素爲List items，若不加此註解，該元素將被映射爲

    <items>...</items>

    <items>...</items>

這種形式，此註解可將這個元素進行包裝，如：

    @XmlElementWrapper(name="items")
    @XmlElement(name="item")
    public List items;

將會生成這樣的XML樣式：

    <items>

        <item>...</item>

        <item>...</item>

    </items>

@XmlJavaTypeAdapter  自定義某一字段或屬性映射到XML的適配器。如，類中包含一個接口，我們可以定義一個適配器（繼承自 javax.xml.bind.annotation.adapters.XmlAdapter類），指定這個接口如何映射到XML。

@XmlSchema 配置整個包的namespace，這個註解需放在package-info.java文件中。

二.常用annotation使用說明

 

1. @XmlType

　　@XmlType用在class類的註解，常與@XmlRootElement，@XmlAccessorType一起使用。它有三個屬性：name、propOrder、namespace，經常使用的只有前兩個屬性。如：

@XmlType(name = "basicStruct", propOrder = {
    "intValue",
    "stringArray",
    "stringValue"
)

在使用@XmlType的propOrder 屬性時，必須列出JavaBean對象中的所有屬性，否則會報錯。

　　2.@XmlElement

　　@XmlElement將java對象的屬性映射爲xml的節點，在使用@XmlElement時，可通過name屬性改變java對象屬性在xml中顯示的名稱。如：

　　@XmlElement(name="Address")　　

　　private String yourAddress;

　　3.@XmlRootElement

　　@XmlRootElement用於類級別的註解，對應xml的跟元素，常與 @XmlType 和 @XmlAccessorType一起使用。如：

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

　　4.@XmlAttribute

　　@XmlAttribute用於把java對象的屬性映射爲xml的屬性,並可通過name屬性爲生成的xml屬性指定別名。如：

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

　　5.@XmlAccessorType

　　@XmlAccessorType用於指定由java對象生成xml文件時對java對象屬性的訪問方式。常與@XmlRootElement、@XmlType一起使用。它的屬性值是XmlAccessType的4個枚舉值，分　　　別爲：

　　XmlAccessType.FIELD:java對象中的所有成員變量

　　XmlAccessType.PROPERTY：java對象中所有通過getter/setter方式訪問的成員變量

　　XmlAccessType.PUBLIC_MEMBER：java對象中所有的public訪問權限的成員變量和通過getter/setter方式訪問的成員變量

　　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文件。

　　6.@XmlAccessorOrder

　　@XmlAccessorOrder用於對java對象生成的xml元素進行排序。它有兩個屬性值：

　　AccessorOrder.ALPHABETICAL：對生成的xml元素按字母書序排序

　　XmlAccessOrder.UNDEFINED:不排序

　　7.@XmlTransient

　　@XmlTransient用於標示在由java對象映射xml時，忽略此屬性。即，在生成的xml文件中不出現此元素。

　　8.@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);
 }