JAXB實現JavaBean和xml互相轉換
一、簡介
JAXB(Java API for XML Binding)是一個業界的標準,是一項可以根據XML Schema產生Java類的技術。JAXB也提供了將XML例項文件反向生成Java物件樹的方法,並能將Java物件樹的內容重新寫到 XML例項文件。
Jaxb 2.0是JDK 1.6的組成部分。我們不需要下載第三方jar包即可做到輕鬆轉換。Jaxb2使用了JDK的新特性,如:Annotation、GenericType等,需要在即將轉換的JavaBean中新增annotation註解。
二、用法
1、JAXBContext類,是應用的入口,用於管理XML/Java繫結資訊。
2、Marshaller介面,將Java物件轉化為XML資料。
3、Unmarshaller介面,將XML資料轉化為Java物件。
註解:
1>@XmlRootElement,用於類上的註解,將一個Java類及其成員變數對映為XML的根節點以及子節點。其中:屬性name定義根節點的名稱,namespace定義這個根節點名稱空間。常與@XmlType和@XmlAccessorType一起使用。
2>@XmlType,用在類上的註解。其中:屬性name指定XML Schema中type的名稱,namespace指定Schema中的名稱空間,factoryClass指定unMarshal時生成對映類例項所需的工廠類,預設為這個類本身,factoryMethod指定工廠類的工廠方法,propOrder指定序列化的順序:
①所有轉為XML元素的屬性都必須出現在@XmlType的propOrder列表中;
②所有@XmlElementWrapper標註的屬性都不能出現在@XmlType的propOrder列表中。
3>@XmlAccessorType,用於類上的註解,用於指定物件的哪些成員變數會生成xml。常與@XmlRootElement、@XmlType一起使用。其中屬性XmlAccessType的4個列舉值,分別為:
①XmlAccessType.FIELD:物件中的所有成員變數
②XmlAccessType.PROPERTY:物件中所有通過getter/setter方式訪問的成員變數
③XmlAccessType.PUBLIC_MEMBER:物件中所有有public訪問許可權的成員變數和通過getter/setter方式訪問的成員變數
④XmlAccessType.NONE:物件的所有屬性都不對映為xml的元素
注意:@XmlAccessorType的預設訪問級別是XmlAccessType.PUBLIC_MEMBER,因此,如果物件中的private成員變數設定了getter/setter方法,就不要在private變數上使用@XmlElement和@XmlAttribute註解,否則在由物件生成xml時會報該屬性在java類裡存在兩次的錯誤。同理,如果@XmlAccessorType的訪問許可權為XmlAccessType.NONE,如果在成員變數上使用了@XmlElement或@XmlAttribute註解,這些成員變數依然可以對映到xml檔案。
4>@XmlAccessorOrder,用於類上的註解,對元素進行排序。它有兩個值:
①XmlAccessOrder.ALPHABETICAL:按字母書序排序
②XmlAccessOrder.UNDEFINED:不排序
5>@XmlElement,用於成員變數或getter/setter方法上,將對應的變數對映到同名的一個XML節點。其中:屬性name指定節點名稱,namespace指定節點名稱空間,required指定節點是否必輸,nillable指定節點是否是nillable,type指定節點關聯的型別。
6>@XmlElementWrapper ,用於成員變數或getter/setter方法上,對於陣列或集合(即包含多個元素的成員變數),生成一個包裝該陣列或集合的XML元素。其中:屬性name指定集合名稱,namespace指定集合名稱空間,required指定集合是否必輸,nillable指定集合是否是nillable。
7>@XmlAttribute,用於成員變數或getter/setter方法上,將對應的變數對映到同名的一個XML節點屬性。其中:屬性name指定屬性名稱,namespace指定屬性名稱空間,required指定屬性是否必輸。
8>@XmlTransient,用於標示在由java物件對映xml時,忽略此屬性。即在生成的xml檔案中不出現此元素。
9>@XmlSchema,配置整個包的namespace,這個註解需放在package-info.java檔案中。
10>@XmlJavaTypeAdapter以及@XmlJavaTypeAdapters,用於包、類、成員變數或getter/setter方法上,常用在轉換比較複雜的物件時,如map型別或者格式化日期等。使用此註解時,需要自己寫一個adapter類繼承XmlAdapter抽象類,並實現裡面的方法。使用格式是:@XmlJavaTypeAdapter(value=xxx.class),xxx為自己定義的adapter類。
三、示例
1、物件轉為xml
People.java
@XmlRootElement(name="employee")
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name="emp",namespace="aa",propOrder={"id","name","sex","age"})
public class People{
public String id="001";
public String name="張三";
public String sex="男";
private String age="30";
}
Test.java
public class Test {
public static void main(String args[]){
People p = new People();
convertToXml(p,"utf-8");
}
public static String convertToXml(Object obj, String encoding){
String result = null;
try {
JAXBContext context = JAXBContext.newInstance(obj.getClass());
Marshaller marshaller = context.createMarshaller();
marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
marshaller.setProperty(Marshaller.JAXB_ENCODING, encoding);
marshaller.setProperty(Marshaller.JAXB_FRAGMENT,false);
StringWriter writer = new StringWriter();
marshaller.marshal(obj, writer);
result = writer.toString();
System.out.println(result);
} catch (Exception e) {
e.printStackTrace();
}
return result;
}
}
2、xml轉為物件
People.java
@XmlRootElement(name="employee")
public class People{
public String id;
public String name;
public String sex;
public String age;
public String toString(){
return this.id+","+this.name+","+this.sex+","+this.age;
}
}
Test.javapublic class Test {
public static void main(String args[]){
People p = new People();
String xml="<?xml version='1.0' encoding='utf-8' standalone='yes'?>" +
"<employee>"+
"<id>002</id>"+
"<name>李四</name>"+
"<sex>女</sex>"+
"<age>28</age>"+
"</employee>";
convertToObject(p, xml);
}
public static String convertToObject(People p, String xml){
String result = null;
try {
StringReader sr = new StringReader(xml);
JAXBContext context = JAXBContext.newInstance(p.getClass());
Unmarshaller unmarshaller = context.createUnmarshaller();
p=(People)unmarshaller.unmarshal(sr);
result=p.toString();
System.out.println(result);
} catch (Exception e) {
e.printStackTrace();
}
return result;
}
}
參考:http://blog.csdn.net/lw371496536/article/details/6942045
http://www.cnblogs.com/qiyebao/p/4573665.html