一、简介
JAXB(Java Architecture for XML Binding) 是一个业界的标准,是一项可以根据XML Schema产生Java类的技术。该过程中,JAXB也提供了将XML实例文档反向生成Java对象树的方法,并能将Java对象树的内容重新写到XML实例文档。从另一方面来讲,JAXB提供了快速而简便的方法将XML模式绑定到Java表示,从而使得Java开发者在Java应用程序中能方便地结合XML数据和处理函数。
JAXBContext 类提供到 JAXB API 的客户端入口点。它提供了管理实现 JAXB 绑定框架操作所需的 XML/Java 绑定信息的抽象,这些操作包括:解组、编组和验证。
二、重要的类和接口
JAXBContext类,是应用的入口,用于管理XML/Java绑定信息。
Marshaller接口,将Java对象序列化为XML数据
Unmarshaller接口,将XML数据反序列化为Java对象。
三、JDK中JAXB相关重要的注解
@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属性。
四、JavaBean与XML字符串互转实例
//******************************基础类
@Data
@XmlRootElement
public class Group {
private String groupName;
private List<User> userList = new ArrayList<User>();
}
@Data
public class User {
private String name;
private Date birthDay;
private Integer age;
}
//********************************XML工具类
public class XmlUtils {
/**
* 功能描述:实例化JAXBContext对象,每种类型只实例化一次。 因为 JAXBContext.newInstance()方法在并发量高时有性能问题。
*/
public static ConcurrentHashMap<Class<?> , JAXBContext> map = new ConcurrentHashMap<Class<?> , JAXBContext>() ;
/**
* 功能描述:获取JAXBContext实例
*/
public static JAXBContext getInstance(Class<?> cla){
try {
if(map.contains(cla)){
return map.get(cla);
}else{
JAXBContext jaxbContext = JAXBContext.newInstance(cla);
map.put(cla , jaxbContext);
return jaxbContext;
}
} catch (JAXBException e) {
e.printStackTrace();
}
return null;
}
/**
* 功能描述:序列化---JavaBean 转 Xml字符串
*/
public static String marshal(Object obj){
String xmlStr = "";
try {
JAXBContext jaxbContext = getInstance(obj.getClass());
Marshaller marshaller = jaxbContext.createMarshaller();
marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);//格式化输出xml
//marshaller.setProperty(Marshaller.JAXB_FRAGMENT, true);// 是否省略xml头信息
marshaller.setProperty(Marshaller.JAXB_ENCODING, "UTF-8");//设置编码格式
StringWriter writer = new StringWriter();
marshaller.marshal(obj , new StreamResult(writer));
xmlStr = writer.toString();
} catch (JAXBException e) {
e.printStackTrace();
}
return xmlStr.toString();
}
/**
* 功能描述:反序列化---Xml字符串 转 JavaBean
*/
public static <T> T unmarshal(String xmlStr , Class<T> cla){
try {
JAXBContext jaxbContext = getInstance(cla);
Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
return (T) unmarshaller.unmarshal(new StringReader(xmlStr));
} catch (JAXBException e) {
e.printStackTrace();
}
return null;
}
}
//********************************测试类
public class XMLTest1 {
public Group init(){
ArrayList<User> users = new ArrayList<>();
for (int i = 0; i < 3; i++) {
User user = new User();
user.setName("zhangsan"+i);
user.setAge(10+i);
user.setBirthDay(new Date());
users.add(user);
}
Group group = new Group();
group.setGroupName("1组");
group.setUserList(users);
return group;
}
//JavaBean转XML字符串
@Test
public void JavaBean2XML() throws JAXBException {
Group goup = init();
String xmlStr = XmlUtils.marshal(goup);
System.out.println(xmlStr);
}
/**结果:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<group>
<groupName>1组</groupName>
<userList>
<age>10</age>
<birthDay>2018-11-07T16:21:20.558+08:00</birthDay>
<name>zhangsan0</name>
</userList>
<userList>
<age>11</age>
<birthDay>2018-11-07T16:21:20.558+08:00</birthDay>
<name>zhangsan1</name>
</userList>
</group>
*/
//XML字符串转JavaBean
@Test
public void XML2JavaBean() throws JAXBException {
Group group = init();
String xmlStr = XmlUtils.marshal(group);
Group group2 = XmlUtils.unmarshal(xmlStr, Group.class);
System.out.println(group2);
}
/**结果:
*Group(groupName=1组, userList=[User(name=zhangsan0, birthDay=Wed Nov 07 16:23:22 CST 2018, age=10), User(name=zhangsan1, birthDay=Wed Nov 07 16:23:22 CST 2018, age=11)])
/
}