介紹:
Java和xml的互相轉換, 依靠強大的JAXBContext可以輕鬆實現。
JAXBContext是jdk自帶的一個工具,包路徑:javax.xml.bind.JAXBContext。
關於JAXB:
JAXB能夠使用Jackson對JAXB註解的支持實現(jackson-module-jaxb-annotations),既方便生成XML,也方便生成JSON,這樣一來可以更好的標誌可以轉換爲JSON對象的JAVA類。JAXB允許JAVA人員將JAVA類映射爲XML表示方式,常用的註解包括:@XmlRootElement,@XmlElement等等。
JAXB(Java Architecture for XML Binding) 是一個業界的標準,是一項可以根據XML Schema產生Java類的技術。該過程中,JAXB也提供了將XML實例文檔反向生成Java對象樹的方法,並能將Java對象樹的內容重新寫到XML實例文檔。從另一方面來講,JAXB提供了快速而簡便的方法將XML模式綁定到Java表示,從而使得Java開發者在Java應用程序中能方便地結合XML數據和處理函數。
Java SE中的JAXB
JAXB 2.0是JDK 1.6的組成部分。JAXB 2.2.3是JDK 1.7的組成部分。
JDK中JAXB相關的重要Class和Interface:
JAXBContext類,是應用的入口,用於管理XML/Java綁定信息。
Marshaller接口,將Java對象序列化爲XML數據。
Unmarshaller接口,將XML數據反序列化爲Java對象。
JDK中JAXB相關的重要Annotation:
@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屬性。
其他:
對於要序列化(marshal)爲XML的Java類,絕不能把成員變量聲明爲public,否則運行將拋出異常com.sun.xml.internal.bind.v2.runtime.IllegalAnnotationsException。
對於JAXB相關的重要Annotation的聲明,如@Xml…..,可以放在成員變量的setter()或getter()方法上,兩者中任選其一即可,但決不能放在成員變量上,否則運行將拋出異常com.sun.xml.internal.bind.v2.runtime.IllegalAnnotationsException。
示例:
類文件註解:@XmlRootElement不可缺少
Student 實體類
@XmlRootElement
public class Student {
private String name;
private String width;
private String height;
private int age;
public Student(String name, String width, String height, int age) {
super();
this.name = name;
this.width = width;
this.height = height;
this.age = age;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getWidth() {
return width;
}
public void setWidth(String width) {
this.width = width;
}
public String getHeight() {
return height;
}
public void setHeight(String height) {
this.height = height;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
public Student() {
super();
}
}
JavaToXml:
@Test
public void test01(){
try {
JAXBContext jc = JAXBContext.newInstance(Student.class);
Marshaller ms = jc.createMarshaller();
Student st = new Student("zhang", "w", "h", 11);
ms.marshal(st, System.out);
} catch (JAXBException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
XmlToJava:
@Test
public void test02() throws JAXBException{
String xml = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><student><age>11</age><height>h</height><name>zhang</name><width>w</width></student>";
JAXBContext jc = JAXBContext.newInstance(Student.class);
Unmarshaller unmar = jc.createUnmarshaller();
Student stu = (Student) unmar.unmarshal(new StringReader(xml));
System.out.println(stu.getName());
}
其實Marshal 和 UnMarshal的過程並不複雜,只需要從JAXBContext中獲得Marshaller或Unmarshaller對象,就可以讓JAXB幫我們來進行轉換了。我們需要操作的主要內容是定義一個規則,告訴JAXB如何將一個類、按照什麼樣的格式轉換爲XML,下面是JAXB中主要的一些註解。
常用annotation使用說明
1.@XmlType
@XmlType用在class類的註解,常與@XmlRootElement,@XmlAccessorType一起使用。它有三個屬性:name、propOrder、namespace,經常使用的只有前兩個屬性。如:
@XmlType(name = "basicStruct", propOrder = {
"intValue",
"stringArray",
"stringValue"
)
在使用@XmlType的propOrder 屬性時,必須列出JavaBean對象中的所有屬性,否則會報錯。
參數:
propOrder 指定映射XML時的節點順序
factoryClass 指定UnMarshal時生成映射類實例所需的工廠類,默認爲這個類本身
factoryMethod 指定工廠類的工廠方法
name 定義XML Schema中type的名稱
namespace 指定Schema中的命名空間
2.@XmlElement
@XmlElement將java對象的屬性映射爲xml的節點,在使用@XmlElement時,可通過name屬性改變java對象屬性在xml中顯示的名稱。如:
@XmlElement(name="Address")
private String yourAddress;
當一個類的XmlAccessorType 被標註爲PROPERTY時,在某一個沒有get/set方法的字段上標註此註解,即可將該字段映射到XML。
參數:
defaultValue 指定節點默認值
name 指定節點名稱
namespace 指定節點命名空間
required 是否必須(默認爲false)
nillable 該字段是否包含 nillable=”true” 屬性(默認爲false)
type 定義該字段或屬性的關聯類型
3.@XmlRootElement
@XmlRootElement用於類級別的註解,對應xml的跟元素,常與 @XmlType 和 @XmlAccessorType一起使用。如:
@XmlType
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement
public class Address {}
參數:
name 定義這個根節點的名稱
namespace 定義這個根節點命名空間
4.@XmlAttribute
@XmlAttribute用於把java對象的屬性映射爲xml的屬性,並可通過name屬性爲生成的xml屬性指定別名。如:
@XmlAttribute(name="Country")
private String state;
參數:
name 指定屬性名稱
namespace 指定屬性命名空間
required 是否必須(默認爲false)
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 定義某一字段或屬性不需要被映射爲XML。如,當一個類的XmlAccessorType 被標註爲PROPERTY時,在某一get/set方法的字段上標註此註解,那麼該屬性則不會被映射。注意:當某一字段或屬性添加了@XmlElement,那麼該字段或屬性的get/set方法必須使用@XmlTransient, 否則將會報異常:1 counts of IllegalAnnotationExceptions
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);
}
9.@XmlElementWrapper
@XmlElementWrapper 爲數組元素或集合元素定義一個父節點。如,類中有一元素爲List items,若不加此註解,該元素將被映射爲
<items>...</items>
<items>...</items>
這種形式,此註解可將這個元素進行包裝,如:
@XmlElementWrapper(name="items")
@XmlElement(name="item")
public List items;
將會生成這樣的XML樣式:
<items>
<item>...</item>
<item>...</item>
</items>
10.@XmlSchema
@XmlSchema這個註解需放在package-info.java文件中。
jaxb編碼:
JAXBContext jaxbContext = JAXBContext.newInstance(clazz);
Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
InputStreamReader reader=new InputStreamReader(inputStream,"GBK"); //在此修改編碼
return unmarshaller.unmarshal(reader);