简介
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属性。
开发JaxbUtil 工具类
package com.example.demo.util;
import java.io.StringReader;
import java.io.StringWriter;
import javax.xml.bind.JAXBContext;
import javax.xml.bind.Marshaller;
import javax.xml.bind.Unmarshaller;
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的编码方式
一个对象的转换
创建javaBean
package com.example.demo.javaBean;
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;
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement
@XmlType(name = "book", propOrder = {})
public class Book {
@XmlAttribute
private Integer id;
@XmlElement(required = true)
private float price;
@XmlElement(required = true)
private String author;
@XmlElement
private Date date;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public float getPrice() {
return price;
}
public void setPrice(float price) {
this.price = price;
}
public String getAuthor() {
return author;
}
public void setAuthor(String author) {
this.author = author;
}
public Date getDate() {
return date;
}
public void setDate(Date date) {
this.date = date;
}
@Override
public String toString() {
return "Book [id=" + id + ", price=" + price + ", author=" + author + ", date=" + date + "]";
}
}
测试类javaBean转XML
package com.example.demo.test;
import java.util.Date;
import com.example.demo.javaBean.Book;
import com.example.demo.util.JaxbUtil;
public class JavaBeanToXmlTest {
public static void main(String[] args) {
Book book = new Book();
book.setId(100);
book.setAuthor("James");
book.setDate(new Date());
book.setPrice(23.45f); //默认是0.0
String str = JaxbUtil.convertToXml(book);
System.out.println(str);
}
}
输出结果
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<book id="100">
<price>23.45</price>
<author>James</author>
<date>2019-04-17T20:22:57.790+08:00</date>
</book>
测试类XML转javaBean
package com.example.demo.test;
import java.util.Date;
import com.example.demo.javaBean.Book;
import com.example.demo.util.JaxbUtil;
public class JavaBeanToXmlTest {
public static void main(String[] args) {
String str = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>" +
"<book id=\"100\">" +
" <author>James</author>" +
" <date>2019-04-17T16:11:22.326+08:00</date>" +
" <price_1>23.45</price_1>" +
"</book>";
Book book = JaxbUtil.converyToJavaBean(str, Book.class);
System.out.println(book);
}
}
输出结果
Book [id=100, price=23.45, author=James, date=Wed Apr 17 20:22:57 CST 2019]
复杂对象的转换
创建javaBean
package com.example.demo.javaBean;
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;
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement(name = "student")
@XmlType(propOrder = {"id","name","role"})
public class Student {
@XmlAttribute(name="id")
private Integer id;
@XmlElement(name="name")
private String name;
@XmlElement(name = "role")
private Role role;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Role getRole() {
return role;
}
public void setRole(Role role) {
this.role = role;
}
@Override
public String toString() {
return "Student [id=" + id + ", name=" + name + ", role=" + role + "]";
}
}
package com.example.demo.javaBean;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement(name="role")
@XmlType(propOrder = { "roleName", "desc" })
public class Role {
@XmlElement(name="roleName")
private String roleName;
@XmlElement(name="desc")
private String desc;
public String getRoleName() {
return roleName;
}
public void setRoleName(String roleName) {
this.roleName = roleName;
}
public String getDesc() {
return desc;
}
public void setDesc(String desc) {
this.desc = desc;
}
@Override
public String toString() {
return "Role [roleName=" + roleName + ", desc=" + desc + "]";
}
}
测试类javaBean转XML
package com.example.demo.test;
import com.example.demo.javaBean.Role;
import com.example.demo.javaBean.Student;
import com.example.demo.util.JaxbUtil;
public class JavaBeanToXmlTest1 {
public static void main(String[] args) {
Student student = new Student();
student.setId(524);
student.setName("话化系级");
Role role = new Role();
role.setDesc("肉坦克");
role.setRoleName("上单");
student.setRole(role);
String str = JaxbUtil.convertToXml(student);
System.out.println(str);
}
}
输出结果
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<student id="524">
<name>话化系级</name>
<role>
<roleName>上单</roleName>
<desc>肉坦克</desc>
</role>
</student>
测试类XML转javaBean
package com.example.demo.test;
import com.example.demo.javaBean.Book;
import com.example.demo.javaBean.Role;
import com.example.demo.javaBean.Student;
import com.example.demo.util.JaxbUtil;
public class JavaBeanToXmlTest1 {
public static void main(String[] args) {
String str = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>" +
"<student id=\"524\">" +
" <name>话化系级</name>" +
" <role>" +
" <roleName>上单</roleName>" +
" <desc>肉坦克</desc>" +
" </role>" +
"</student>";
Student student = JaxbUtil.converyToJavaBean(str, Student.class);
System.out.println(student);
}
}
输出结果
Student [id=524, name=话化系级, role=Role [roleName=上单, desc=肉坦克]]
集合对象的转换
创建javaBean
package com.example.demo.javaBean;
import java.util.List;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElementWrapper;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement(name = "country")
@XmlType(propOrder = {"name","provinceList"})
public class Country {
@XmlElement(name="country_name")
private String name;
@XmlElementWrapper(name = "provinces")
@XmlElement(name="province")
private List<Province> provinceList;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public List<Province> getProvinceList() {
return provinceList;
}
public void setProvinceList(List<Province> provinceList) {
this.provinceList = provinceList;
}
@Override
public String toString() {
return "Country [name=" + name + ", provinceList=" + provinceList + "]";
}
}
package com.example.demo.javaBean;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlType;
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(propOrder = {"name","provCity"})
public class Province {
@XmlElement(name = "province_name")
private String name;
@XmlElement(name = "prov_city")
private String provCity;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getProvCity() {
return provCity;
}
public void setProvCity(String provCity) {
this.provCity = provCity;
}
@Override
public String toString() {
return "Province [name=" + name + ", provCity=" + provCity + "]";
}
}
测试类javaBean转XML
package com.example.demo.test;
import java.util.ArrayList;
import java.util.List;
import com.example.demo.javaBean.Country;
import com.example.demo.javaBean.Province;
import com.example.demo.util.JaxbUtil;
public class JavaBeanToXmlTest2 {
public static void main(String[] args) {
Country country = new Country();
country.setName("中国");
List<Province> list = new ArrayList<Province>();
Province province = new Province();
province.setName("陕西省");
province.setProvCity("西安市");
Province province2 = new Province();
province2.setName("浙江省");
province2.setProvCity("杭州市");
list.add(province);
list.add(province2);
country.setProvinceList(list);
String str = JaxbUtil.convertToXml(country);
System.out.println(str);
}
}
输出结果
<?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>
测试类XML转javaBean
package com.example.demo.test;
import java.util.ArrayList;
import java.util.List;
import com.example.demo.javaBean.Country;
import com.example.demo.javaBean.Province;
import com.example.demo.util.JaxbUtil;
public class JavaBeanToXmlTest2 {
public static void main(String[] args) {
/*Country country = new Country();
country.setName("中国");
List<Province> list = new ArrayList<Province>();
Province province = new Province();
province.setName("陕西省");
province.setProvCity("西安市");
Province province2 = new Province();
province2.setName("浙江省");
province2.setProvCity("杭州市");
list.add(province);
list.add(province2);
country.setProvinceList(list);
String str = JaxbUtil.convertToXml(country);
System.out.println(str);*/
String str = "<?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 country = JaxbUtil.converyToJavaBean(str, Country.class);
System.out.println(country);
}
}
输出结果
Country [name=中国, provinceList=[Province [name=陕西省, provCity=西安市], Province [name=浙江省, provCity=杭州市]]]