Jaxb2 实现JavaBean与xml互转

一、简介

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、准备工作

1. package utils;
2. import java.io.StringReader;
3. import java.io.StringWriter;
4. import javax.xml.bind.JAXBContext;
5. import javax.xml.bind.Marshaller;
6. import javax.xml.bind.Unmarshaller;
7. /**
8. * Jaxb2工具类
9. * @author      zhuc
10. * @create      2013-3-29 下午2:40:14
11. */
12. public class JaxbUtil {
13. /**
14. * JavaBean转换成xml
15. * 默认编码UTF-8
16. * @param obj
17. * @param writer
18. * @return
19. */
20. public static String convertToXml(Object obj) {
21. return convertToXml(obj, "UTF-8");
22. }
23. /**
24. * JavaBean转换成xml
25. * @param obj
26. * @param encoding
27. * @return
28. */
29. public static String convertToXml(Object obj, String encoding) {
30. String result = null;
31. try {
32. JAXBContext context = JAXBContext.newInstance(obj.getClass());
33. Marshaller marshaller = context.createMarshaller();
34. marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
35. marshaller.setProperty(Marshaller.JAXB_ENCODING, encoding);
36. StringWriter writer = new StringWriter();
37. marshaller.marshal(obj, writer);
38. result = writer.toString();
39. } catch (Exception e) {
40. e.printStackTrace();
41. }
42. return result;
43. }
44. /**
45. * xml转换成JavaBean
46. * @param xml
47. * @param c
48. * @return
49. */
50. @SuppressWarnings("unchecked")
51. public static <T> T converyToJavaBean(String xml, Class<T> c) {
52. T t = null;
53. try {
54. JAXBContext context = JAXBContext.newInstance(c);
55. Unmarshaller unmarshaller = context.createUnmarshaller();
56. t = (T) unmarshaller.unmarshal(new StringReader(xml));
57. } catch (Exception e) {
58. e.printStackTrace();
59. }
60. return t;
61. }
62. }

非常简单易懂，需要注意的是

1. marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
2. marshaller.setProperty(Marshaller.JAXB_ENCODING, encoding);

Marshaller.JAXB_FORMATTED_OUTPUT 决定是否在转换成xml时同时进行格式化（即按标签自动换行，否则即是一行的xml）

Marshaller.JAXB_ENCODING xml的编码方式

另外，Marshaller 还有其他Property可以设置，可以去查阅api。

2、最简单转换

1. package t1;
2. import java.util.Date;
3. import javax.xml.bind.annotation.XmlAccessType;
4. import javax.xml.bind.annotation.XmlAccessorType;
5. import javax.xml.bind.annotation.XmlAttribute;
6. import javax.xml.bind.annotation.XmlElement;
7. import javax.xml.bind.annotation.XmlRootElement;
8. import javax.xml.bind.annotation.XmlType;
9. /**
10. * @author      zhuc
11. * @create      2013-3-29 下午2:49:48
12. */
13. @XmlAccessorType(XmlAccessType.FIELD)
14. @XmlRootElement
15. @XmlType(name = "book", propOrder = { "author", "calendar", "price", "id" })
16. public class Book {
17. @XmlElement(required = true)
18. private String author;
19. @XmlElement(name = "price_1", required = true)
20. private float price;
21. @XmlElement
22. private Date calendar;
23. @XmlAttribute
24. private Integer id;
25. /**
26. * @return the author
27. */
28. public String getAuthor() {
29. return author;
30. }
31. /**
32. * @return the price
33. */
34. public float getPrice() {
35. return price;
36. }
37. /**
38. * @return the calendar
39. */
40. public Date getCalendar() {
41. return calendar;
42. }
43. /**
44. * @return the id
45. */
46. public Integer getId() {
47. return id;
48. }
49. /**
50. * @param author the author to set
51. */
52. public void setAuthor(String author) {
53. this.author = author;
54. }
55. /**
56. * @param price the price to set
57. */
58. public void setPrice(float price) {
59. this.price = price;
60. }
61. /**
62. * @param calendar the calendar to set
63. */
64. public void setCalendar(Date calendar) {
65. this.calendar = calendar;
66. }
67. /**
68. * @param id the id to set
69. */
70. public void setId(Integer id) {
71. this.id = id;
72. }
73. /* (non-Javadoc)
74. * @see java.lang.Object#toString()
75. */
76. @Override
77. public String toString() {
78. return "Book [author=" + author + ", price=" + price + ", calendar=" + calendar + ", id=" + id + "]";
79. }
80. }

1. package t1;
2. import java.util.Date;
3. import javax.xml.bind.JAXBException;
4. import org.junit.Test;
5. import utils.JaxbUtil;
6. /**
7. * @author      zhuc
8. * @create      2013-3-29 下午2:50:00
9. */
10. public class JaxbTest1 {
11. /**
12. * @throws JAXBException
13. */
14. @Test
15. public void showMarshaller()  {
16. Book book = new Book();
17. book.setId(100);
18. book.setAuthor("James");
19. book.setCalendar(new Date());
20. book.setPrice(23.45f);   //默认是0.0
21. String str = JaxbUtil.convertToXml(book);
22. System.out.println(str);
23. }
24. /**
25. * @throws JAXBException
26. */
27. @Test
28. public void showUnMarshaller() {
29. String str = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>" +
30. "<book id=\"100\">" +
31. "    <author>James</author>" +
32. "   <calendar>2013-03-29T09:25:56.004+08:00</calendar>" +
33. "  <price_1>23.45</price_1>" +
34. "</book>";
35. Book book = JaxbUtil.converyToJavaBean(str, Book.class);
36. System.out.println(book);
37. }
38. }

输出结果分别为：

<?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、类中包含复杂对象的转换

1. package t2;
2. import javax.xml.bind.annotation.XmlAccessType;
3. import javax.xml.bind.annotation.XmlAccessorType;
4. import javax.xml.bind.annotation.XmlAttribute;
5. import javax.xml.bind.annotation.XmlElement;
6. import javax.xml.bind.annotation.XmlRootElement;
7. import javax.xml.bind.annotation.XmlType;
8. /**
9. * @author      zhuc
10. * @create      2013-3-29 下午2:51:44
11. */
12. @XmlAccessorType(XmlAccessType.FIELD)
13. @XmlRootElement(name = "student")
14. @XmlType(propOrder = {})
15. public class Student {
16. @XmlAttribute
17. private Integer id;
18. @XmlElement
19. private String name;
20. @XmlElement(name = "role")
21. private Role role;
22. /**
23. * @return the id
24. */
25. public Integer getId() {
26. return id;
27. }
28. /**
29. * @return the name
30. */
31. public String getName() {
32. return name;
33. }
34. /**
35. * @return the role
36. */
37. public Role getRole() {
38. return role;
39. }
40. /**
41. * @param id the id to set
42. */
43. public void setId(Integer id) {
44. this.id = id;
45. }
46. /**
47. * @param name the name to set
48. */
49. public void setName(String name) {
50. this.name = name;
51. }
52. /**
53. * @param role the role to set
54. */
55. public void setRole(Role role) {
56. this.role = role;
57. }
58. /* (non-Javadoc)
59. * @see java.lang.Object#toString()
60. */
61. @Override
62. public String toString() {
63. return "Student [id=" + id + ", name=" + name + ", role=" + role + "]";
64. }
65. }

1. package t2;
2. import javax.xml.bind.annotation.XmlAccessType;
3. import javax.xml.bind.annotation.XmlAccessorType;
4. import javax.xml.bind.annotation.XmlElement;
5. import javax.xml.bind.annotation.XmlType;
6. /**
7. * @author      zhuc
8. * @create      2013-3-29 下午2:51:52
9. */
10. @XmlAccessorType(XmlAccessType.FIELD)
11. @XmlType(propOrder = { "name", "desc" })
12. public class Role {
13. @XmlElement
14. private String name;
15. @XmlElement
16. private String desc;
17. /**
18. * @return the name
19. */
20. public String getName() {
21. return name;
22. }
23. /**
24. * @return the desc
25. */
26. public String getDesc() {
27. return desc;
28. }
29. /**
30. * @param name the name to set
31. */
32. public void setName(String name) {
33. this.name = name;
34. }
35. /**
36. * @param desc the desc to set
37. */
38. public void setDesc(String desc) {
39. this.desc = desc;
40. }
41. /* (non-Javadoc)
42. * @see java.lang.Object#toString()
43. */
44. @Override
45. public String toString() {
46. return "Role [name=" + name + ", desc=" + desc + "]";
47. }
48. }

1. package t2;
2. import org.junit.Test;
3. import utils.JaxbUtil;
4. /**
5. * @author      zhuc
6. * @create      2013-3-29 下午2:52:00
7. */
8. public class JaxbTest2 {
9. @Test
10. public void showMarshaller() {
11. Student student = new Student();
12. student.setId(12);
13. student.setName("test");
14. Role role = new Role();
15. role.setDesc("管理");
16. role.setName("班长");
17. student.setRole(role);
18. String str = JaxbUtil.convertToXml(student);
19. System.out.println(str);
20. }
21. @Test
22. public void showUnMarshaller() {
23. String str = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>"+
24. "<student id=\"12\">"+
25. "    <name>test</name>"+
26. "   <role>"+
27. "      <name>班长</name>"+
28. "     <desc>管理</desc>"+
29. "</role>"+
30. "</student>";
31. Student student = JaxbUtil.converyToJavaBean(str, Student.class);
32. System.out.println(student);
33. }
34. }

输出结果分别为：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<student id="12">
    <name>test</name>
    <role>
        <name>班长</name>
        <desc>管理</desc>
    </role>
</student>

Student [id=12, name=test, role=Role [name=班长, desc=管理]]

4、集合对象的转换（同样适用于Set）

1. package t3;
2. import java.util.List;
3. import javax.xml.bind.annotation.XmlAccessType;
4. import javax.xml.bind.annotation.XmlAccessorType;
5. import javax.xml.bind.annotation.XmlElement;
6. import javax.xml.bind.annotation.XmlElementWrapper;
7. import javax.xml.bind.annotation.XmlRootElement;
8. import javax.xml.bind.annotation.XmlType;
9. /**
10. * @author      zhuc
11. * @create      2013-3-29 下午2:55:56
12. */
13. @XmlAccessorType(XmlAccessType.FIELD)
14. @XmlRootElement(name = "country")
15. @XmlType(propOrder = { "name", "provinceList" })
16. public class Country {
17. @XmlElement(name = "country_name")
18. private String name;
19. @XmlElementWrapper(name = "provinces")
20. @XmlElement(name = "province")
21. private List<Province> provinceList;
22. /**
23. * @return the name
24. */
25. public String getName() {
26. return name;
27. }
28. /**
29. * @return the provinceList
30. */
31. public List<Province> getProvinceList() {
32. return provinceList;
33. }
34. /**
35. * @param name the name to set
36. */
37. public void setName(String name) {
38. this.name = name;
39. }
40. /**
41. * @param provinceList the provinceList to set
42. */
43. public void setProvinceList(List<Province> provinceList) {
44. this.provinceList = provinceList;
45. }
46. /* (non-Javadoc)
47. * @see java.lang.Object#toString()
48. */
49. @Override
50. public String toString() {
51. return "Country [name=" + name + ", provinceList=" + provinceList + "]";
52. }
53. }

1. package t3;
2. import javax.xml.bind.annotation.XmlAccessType;
3. import javax.xml.bind.annotation.XmlAccessorType;
4. import javax.xml.bind.annotation.XmlElement;
5. import javax.xml.bind.annotation.XmlType;
6. /**
7. * @author      zhuc
8. * @create      2013-3-29 下午2:56:03
9. */
10. @XmlAccessorType(XmlAccessType.FIELD)
11. @XmlType(propOrder = { "name", "provCity" })
12. public class Province {
13. @XmlElement(name = "province_name")
14. private String name;
15. @XmlElement(name = "prov_city")
16. private String provCity;
17. /**
18. * @return the provCity
19. */
20. public String getProvCity() {
21. return provCity;
22. }
23. /**
24. * @param provCity the provCity to set
25. */
26. public void setProvCity(String provCity) {
27. this.provCity = provCity;
28. }
29. /**
30. * @return the name
31. */
32. public String getName() {
33. return name;
34. }
35. /**
36. * @param name the name to set
37. */
38. public void setName(String name) {
39. this.name = name;
40. }
41. /* (non-Javadoc)
42. * @see java.lang.Object#toString()
43. */
44. @Override
45. public String toString() {
46. return "Province [name=" + name + ", provCity=" + provCity + "]";
47. }
48. }

1. package t3;
2. import java.util.ArrayList;
3. import java.util.List;
4. import org.junit.Test;
5. import utils.JaxbUtil;
6. /**
7. * @author      zhuc
8. * @create      2013-3-29 下午2:56:11
9. */
10. public class JaxbTest3 {
11. /**
12. * @throws JAXBException
13. */
14. @Test
15. public void showMarshaller() {
16. Country country = new Country();
17. country.setName("中国");
18. List<Province> list = new ArrayList<Province>();
19. Province province = new Province();
20. province.setName("江苏省");
21. province.setProvCity("南京市");
22. Province province2 = new Province();
23. province2.setName("浙江省");
24. province2.setProvCity("杭州市");
25. list.add(province);
26. list.add(province2);
27. country.setProvinceList(list);
28. String str = JaxbUtil.convertToXml(country);
29. System.out.println(str);
30. }
31. /**
32. *
33. */
34. @Test
35. public void showUnMarshaller() {
36. String str = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>"+
37. "<country>"+
38. "    <country_name>中国</country_name>"+
39. "    <provinces>"+
40. "        <province>"+
41. "            <province_name>江苏省</province_name>"+
42. "           <prov_city>南京市</prov_city>"+
43. "        </province>"+
44. "       <province>"+
45. "           <province_name>浙江省</province_name>"+
46. "           <prov_city>杭州市</prov_city>"+
47. "       </province>"+
48. "    </provinces>"+
49. "</country>";
50. Country country = JaxbUtil.converyToJavaBean(str, Country.class);
51. System.out.println(country);
52. }
53. }

输出结果分别为：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<country>
    <country_name>中国</country_name>
    <provinces>
        <province>
            <province_name>江苏省</province_name>
            <prov_city>南京市</prov_city>
        </province>
        <province>
            <province_name>浙江省</province_name>
            <prov_city>杭州市</prov_city>
        </province>
    </provinces>
</country>

Country [name=中国, provinceList=[Province [name=江苏省, provCity=南京市], Province [name=浙江省, provCity=杭州市]]]