JAXB序列化常用註解
一.Jaxb處理java物件和xml之間轉換常用的annotation有:
- @XmlType
- @XmlElement
- @XmlRootElement
- @XmlAttribute
- @XmlAccessorType
- @XmlAccessorOrder
- @XmlTransient
- @XmlJavaTypeAdapter
二.常用annotation使用說明
-
@XmlType
@XmlType用在class類的註解,常與@XmlRootElement,@XmlAccessorType一起使用。它有三個屬性:name、propOrder、namespace,經常使用的只有前兩個屬性。如:
@XmlType(name = "basicStruct", propOrder = {"intValue", "stringArray", "stringValue" )
在使用@XmlType的propOrder 屬性時,必須列出JavaBean物件中的所有屬性,否則會報錯。
[email protected]
@XmlElement將java物件的屬性對映為xml的節點,在使用@XmlElement時,可通過name屬性改變java物件屬性在xml中顯示的名稱。如:
@XmlElement(name="Address") private String yourAddress;
[email protected]
@XmlRootElement用於類級別的註解,對應xml的跟元素,常與 @XmlType 和 @XmlAccessorType一起使用。如:
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement
public class Address {}
[email protected]
@XmlAttribute用於把java物件的屬性對映為xml的屬性,並可通過name屬性為生成的xml屬性指定別名。如: @XmlAttribute(name="Country")private String state;
[email protected]
@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檔案。
[email protected]
@XmlAccessorOrder用於對java物件生成的xml元素進行排序。它有兩個屬性值:
AccessorOrder.ALPHABETICAL:對生成的xml元素按字母書序排序
XmlAccessOrder.UNDEFINED:不排序
[email protected]
@XmlTransient用於標示在由java物件對映xml時,忽略此屬性。即,在生成的xml檔案中不出現此元素。
[email protected]
@XmlJavaTypeAdapter常用在轉換比較複雜的物件時,如map型別或者格式化日期等。使用此註解時,需要自己寫一個adapter類繼承XmlAdapter抽象類,並實現裡面的方法。
@XmlJavaTypeAdapter(value=xxx.class[,type=yy.class]),value為自己定義的adapter類,也可以省略value直接寫成@XmlJavaTypeAdapter(xxx.class)
type在包註解上時是必需的,指定要轉化的型別。