一、簡介
JAXB(Java Architecture for XML Binding) 是一個業界的標準,是一項可以根據XML Schema產生Java類的技術。該過程中,JAXB也提供了將XML實例文檔反向生成Java對象樹的方法,並能將Java對象樹的內容重新寫到 XML實例文檔。
Jaxb 2.0是JDK 1.6的組成部分。我們不需要下載第三方jar包 即可做到輕鬆轉換。Jaxb2使用了JDK的新特性,如:Annotation、GenericType等,需要在即將轉換的JavaBean中添加annotation註解。
二、重要概念
- JAXBContext類,是應用的入口,用於管理XML/Java綁定信息。
- Marshaller接口,將Java對象序列化爲XML數據。
- Unmarshaller接口,將XML數據反序列化爲Java對象。
- @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屬性。
三、示例
1、準備工作
Java代碼
package utils;
import java.io.StringReader;
import java.io.StringWriter;
import javax.xml.bind.JAXBContext;
import javax.xml.bind.Marshaller;
import javax.xml.bind.Unmarshaller;
/**
* Jaxb2工具類
* @author zhuc
* @create 2013-3-29 下午2:40:14
*/
public class JaxbUtil {
/**
* JavaBean轉換成xml
* 默認編碼UTF-8
* @param obj
* @param writer
* @return
*/
public static String convertToXml(Object obj) {
return convertToXml(obj, "UTF-8");
}
/**
* JavaBean轉換成xml
* @param obj
* @param encoding
* @return
*/
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);
StringWriter writer = new StringWriter();
marshaller.marshal(obj, writer);
result = writer.toString();
} catch (Exception e) {
e.printStackTrace();
}
return result;
}
/**
* xml轉換成JavaBean
* @param xml
* @param c
* @return
*/
@SuppressWarnings("unchecked")
public static <T> T converyToJavaBean(String xml, Class<T> c) {
T t = null;
try {
JAXBContext context = JAXBContext.newInstance(c);
Unmarshaller unmarshaller = context.createUnmarshaller();
t = (T) unmarshaller.unmarshal(new StringReader(xml));
} catch (Exception e) {
e.printStackTrace();
}
return t;
}
}
非常簡單易懂,需要注意的是
marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
marshaller.setProperty(Marshaller.JAXB_ENCODING, encoding);
Marshaller.JAXB_FORMATTED_OUTPUT 決定是否在轉換成xml時同時進行格式化(即按標籤自動換行,否則即是一行的xml)
Marshaller.JAXB_ENCODING xml的編碼方式
另外,Marshaller 還有其他Property可以設置,可以去查閱api。
2、最簡單轉換
package t1;
import java.util.Date;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
/**
* @author zhuc
* @create 2013-3-29 下午2:49:48
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement
@XmlType(name = "book", propOrder = { "author", "calendar", "price", "id" })
public class Book {
@XmlElement(required = true)
private String author;
@XmlElement(name = "price_1", required = true)
private float price;
@XmlElement
private Date calendar;
@XmlAttribute
private Integer id;
/**
* @return the author
*/
public String getAuthor() {
return author;
}
/**
* @return the price
*/
public float getPrice() {
return price;
}
/**
* @return the calendar
*/
public Date getCalendar() {
return calendar;
}
/**
* @return the id
*/
public Integer getId() {
return id;
}
/**
* @param author the author to set
*/
public void setAuthor(String author) {
this.author = author;
}
/**
* @param price the price to set
*/
public void setPrice(float price) {
this.price = price;
}
/**
* @param calendar the calendar to set
*/
public void setCalendar(Date calendar) {
this.calendar = calendar;
}
/**
* @param id the id to set
*/
public void setId(Integer id) {
this.id = id;
}
/* (non-Javadoc)
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
return "Book [author=" + author + ", price=" + price + ", calendar=" + calendar + ", id=" + id + "]";
}
}
Java代碼
package t1;
import java.util.Date;
import javax.xml.bind.JAXBException;
import org.junit.Test;
import utils.JaxbUtil;
/**
* @author zhuc
* @create 2013-3-29 下午2:50:00
*/
public class JaxbTest1 {
/**
* @throws JAXBException
*/
@Test
public void showMarshaller() {
Book book = new Book();
book.setId(100);
book.setAuthor("James");
book.setCalendar(new Date());
book.setPrice(23.45f); //默認是0.0
String str = JaxbUtil.convertToXml(book);
System.out.println(str);
}
/**
* @throws JAXBException
*/
@Test
public void showUnMarshaller() {
String str = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>" +
"<book id=\"100\">" +
" <author>James</author>" +
" <calendar>2013-03-29T09:25:56.004+08:00</calendar>" +
" <price_1>23.45</price_1>" +
"</book>";
Book book = JaxbUtil.converyToJavaBean(str, Book.class);
System.out.println(book);
}
}
輸出結果分別爲:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<book id="100">
<author>James</author>
<calendar>2013-03-29T14:50:58.974+08:00</calendar>
<price_1>23.45</price_1>
</book>
Book [author=James, price=23.45, calendar=Fri Mar 29 09:25:56 CST 2013, id=100]
3、類中包含複雜對象的轉換