一、前言
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屬性。