SpringBoot项目中集成JAXB实现XML与Java对象的互相转换
一、前言
最近项目中遇到了一个这种需求：版本经理在上游环境通过配置XML的版本策略文件到我们系统，我们得解析XML的版本策略文件来看这些数据是否和我们系统后台的数据相一致，不一致的话，我们后台会去更新版本文件的数据，再通过定时调度把需要更新的版本文件推送给各个局点的设备进行升级。
通过这个需求，我们可以发现业界的XML与Java对象的互相转换的是JAXB（Java Architecture for XML Binding) ，是一项可以根据XML Schema产生Java类的技术。该过程中，JAXB也提供了将XML实例文档反向生成Java对象树的方法，并能将Java对象树的内容重新写到XML实例文档。从另一方面来讲，JAXB提供了快速而简便的方法将XML模式绑定到Java表示，从而使得Java开发者在Java应用程序中能方便地结合XML数据和处理函数。
二、什么是JAXB
1、JDK中JAXB相关的重要Class和Interface
JAXBContext类，是应用的入口，用于管理XML/Java绑定信息。
Marshaller接口，将Java对象序列化为XML数据。
Unmarshaller接口，将XML数据反序列化为Java对象。
2、JDK中JAXB相关的重要Annotation
- @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属性。
在以上的注解中，用的最多的是@XMLType，@XmlAccessorType，@XmlRootElement。
使用JAXB的缘由：
1，在项目中，有时候会有很多的XML文件，但如果可以将这些文件通过对象的方式去操作，就会减少很多操作问题，而且更加符合程序员的编码方式，
2，在项目中，有时候会遇到一个页面中存在很多的实体类中的数据，而且有时候有些数据不是必需的，就是说可以通过DTO来编写这些实体类，但有时候需要将这些DTO进行预先存储，不是存储到数据库中，这样就有两种思路，可以存储在内存中，也可以存储在硬盘上，此时就可以通过将Java对象转换成XML文件存储，或者变成String类型进行存储在内存中。
3，给出一个场景，比如说，一个页面中有很多个模块构成，但是这些模块都是属于一个整体的模块，当用户有操作其中几个模块的时候，但操作后的数据不是最终的数据，那这个时候首先要保存当前页面中的数据（Done），然后到其他页面进行其他操作后再转到这个页面，那么之前那个页面中的数据应该还会存在，用户可以方便查看。但是由于模块较多，如果之前就存到数据库中就会造成浪费，因为其不是最终的保存效果，而当用户想进行保存（Save），此时才进行将最终的数据保存到数据库中。在这个过程中就会用到大量的临时数据，而解决这个问题很好的方法就是可以用XML保存页面中当前的数据。
接下来我们就来看下项目中怎么进行Java对象和XML之间的相互转换吧，当然我的写得Demo的数据并不全是项目中的，这里举几个字段介绍，能让小伙伴们快速上手就够了。
三、Demo实战
Policy.java 类，就是策略文件的信息，productGroup产品族是一个集合有多个产品。
package com.riemann.springbootdemo.model.objectConvertXML;
import lombok.Data;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
import java.io.Serializable;
import java.util.List;
/**
* @author riemann
* @date 2019/08/29 22:10
*/
@Data
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement(name = "Policy") //XML文件中的根标识
@XmlType(propOrder = {
"productGroup",
"sn",
"updateUser",
"updateLastDate",
}) //控制JAXB 绑定类中属性和字段的排序
public class Policy implements Serializable {
private static final long serialVersionUID = 1L;
// 产品族
private List<ProductGroup> productGroup;
// sn号
private String sn;
// 更新人员
private String updateUser;
// 最后更新时间
private String updateLastDate;
}
ProductGroup.java 类 产品族集合对应的产品与版本
package com.riemann.springbootdemo.model.objectConvertXML;
import lombok.Data;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
import java.io.Serializable;
/**
* @author riemann
* @date 2019/08/29 22:14
*/
@Data
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement(name = "ProductGroup")
@XmlType(propOrder = {
"product",
"version",
})
public class ProductGroup implements Serializable {
private static final long serialVersionUID = 1L;
// 产品
private String product;
// 版本
private String version;
}
此时给出最重要的进行Java对象和XML文件相互操作的核心代码XMLUtil.java，其中有着两种方式进行转换，一种是转换成对象和string类型的xml转换，一种是对象和xml文件进行转换。
XMLUtil.java
package com.riemann.springbootdemo.util;
import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;
import javax.xml.bind.Unmarshaller;
import java.io.*;
/**
* 封装了XML转换成object，object转换成XML的代码
*
* @author riemann
* @date 2019/08/29 22:34
*/
public class XMLUtil {
/**
* 将对象直接转换成String类型的 XML输出
*
* @param obj
* @return
*/
public static String convertToXml(Object obj) {
// 创建输出流
StringWriter sw = new StringWriter();
try {
// 利用jdk中自带的转换类实现
JAXBContext context = JAXBContext.newInstance(obj.getClass());
Marshaller marshaller = context.createMarshaller();
// 格式化xml输出的格式
marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE);
// 将对象转换成输出流形式的xml
marshaller.marshal(obj, sw);
} catch (JAXBException e) {
e.printStackTrace();
}
return sw.toString();
}
/**
* 将对象根据路径转换成xml文件
*
* @param obj
* @param path
*/
public static String convertToXml(Object obj, String path) {
FileWriter fw = null;
try {
// 利用jdk中自带的转换类实现
JAXBContext context = JAXBContext.newInstance(obj.getClass());
Marshaller marshaller = context.createMarshaller();
// 格式化xml输出的格式
marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE);
// 将对象转换成输出流形式的xml
// 创建输出流
fw = new FileWriter(path);
marshaller.marshal(obj, fw);
} catch (JAXBException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
return fw.toString();
}
/**
* 将String类型的xml转换成对象
*
* @param clazz
* @param xmlStr
* @return
*/
public static Object convertXmlStrToObject(Class clazz, String xmlStr) {
Object xmlObject = null;
try {
JAXBContext context = JAXBContext.newInstance(clazz);
// 进行将Xml转成对象的核心接口
Unmarshaller unmarshaller = context.createUnmarshaller();
StringReader sr = new StringReader(xmlStr);
xmlObject = unmarshaller.unmarshal(sr);
} catch (JAXBException e) {
e.printStackTrace();
}
return xmlObject;
}
/**
* 将file类型的xml转换成对象
*
* @param clazz
* @param xmlPath
* @return
*/
public static Object convertXmlFileToObject(Class clazz, String xmlPath) {
Object xmlObject = null;
try {
JAXBContext context = JAXBContext.newInstance(clazz);
Unmarshaller unmarshaller = context.createUnmarshaller();
FileReader fr = null;
fr = new FileReader(xmlPath);
xmlObject = unmarshaller.unmarshal(fr);
} catch (JAXBException e) {
e.printStackTrace();
} catch (FileNotFoundException e) {
e.printStackTrace();
}
return xmlObject;
}
}
ObjectConvertXMLController.java 控制器类
这里为了测试就不写service以及impl类了哈，项目中还是要按照该有的模式去写；这里我就在控制层测试。
package com.riemann.springbootdemo.controller;
import com.riemann.springbootdemo.model.ApiResponse;
import com.riemann.springbootdemo.model.ExportExcelData;
import com.riemann.springbootdemo.model.objectConvertXML.Policy;
import com.riemann.springbootdemo.service.impl.EmailTask;
import com.riemann.springbootdemo.util.ConstantsUtil;
import com.riemann.springbootdemo.util.XMLUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
/**
* @author riemann
* @date 2019/08/29 23:05
*/
@RestController
@RequestMapping(value = "/jaxb")
public class ObjectConvertXMLController {
private static final Logger logger = LoggerFactory.getLogger(ObjectConvertXMLController.class);
@RequestMapping(value = "/objectToXML", method= RequestMethod.POST)
public ApiResponse objectToXML(@RequestBody Policy policy) {
String path = "D:\\Policy.xml";
logger.info("---将对象转换成File类型的xml Start---");
String str = XMLUtil.convertToXml(policy, path);
logger.info(str);
logger.info("---将对象转换成File类型的xml End---");
logger.info("---将File类型的xml转换成对象 Start---");
Policy policyObj = (Policy) XMLUtil.convertXmlFileToObject(Policy.class, path);
logger.info(policyObj.toString());
logger.info("---将File类型的xml转换成对象 End---");
return new ApiResponse(ConstantsUtil.SUCCESS_CODE, null, ConstantsUtil.SUCCESS);
}
}
接下来我用postman模拟请求参数来请求
请求路径：localhost:8080/jaxb/objectToXML
请求参数：
{
"productGroup": [
{
"product":"AR",
"version":"AR120"
},
{
"product":"AC",
"version":"AC160"
}
],
"sn":"sn0001",
"updateUser":"riemann",
"updateLastDate":"2019-08-29 23:45:28"
}
postman 返回结果：
IDEA 控制台返回结果：
2019-08-29 23:54:41.019 [http-nio-8080-exec-4] INFO c.r.s.controller.ObjectConvertXMLController----将对象转换成File类型的xml Start---
2019-08-29 23:54:41.028 [http-nio-8080-exec-4] INFO c.r.s.controller.ObjectConvertXMLController-java.io.FileWriter@2d11c0d8
2019-08-29 23:54:41.029 [http-nio-8080-exec-4] INFO c.r.s.controller.ObjectConvertXMLController----将对象转换成File类型的xml End---
2019-08-29 23:54:41.029 [http-nio-8080-exec-4] INFO c.r.s.controller.ObjectConvertXMLController----将File类型的xml转换成对象 Start---
2019-08-29 23:54:41.043 [http-nio-8080-exec-4] INFO c.r.s.controller.ObjectConvertXMLController-Policy(productGroup=[ProductGroup(product=AR, version=AR120), ProductGroup(product=AC, version=AC160)], sn=sn0001, updateUser=riemann, updateLastDate=2019-08-29 23:45:28)
2019-08-29 23:54:41.043 [http-nio-8080-exec-4] INFO c.r.s.controller.ObjectConvertXMLController----将File类型的xml转换成对象 End---
D盘输出结果：
Policy.xml 成功输出
Policy.xml 策略文件请求也是一样的
JAXB 已经将xml解析转换成对象了，所以输出结果还是一样的。
2019-08-30 00:25:30.270 [http-nio-8080-exec-4] INFO c.r.s.controller.ObjectConvertXMLController----将对象转换成File类型的xml Start---
2019-08-30 00:25:30.280 [http-nio-8080-exec-4] INFO c.r.s.controller.ObjectConvertXMLController-java.io.FileWriter@4aa0cef6
2019-08-30 00:25:30.281 [http-nio-8080-exec-4] INFO c.r.s.controller.ObjectConvertXMLController----将对象转换成File类型的xml End---
2019-08-30 00:25:30.281 [http-nio-8080-exec-4] INFO c.r.s.controller.ObjectConvertXMLController----将File类型的xml转换成对象 Start---
2019-08-30 00:25:30.287 [http-nio-8080-exec-4] INFO c.r.s.controller.ObjectConvertXMLController-Policy(productGroup=[ProductGroup(product=AR, version=AR120), ProductGroup(product=AC, version=AC160)], sn=sn0001, updateUser=riemann, updateLastDate=2019-08-29 23:45:28)
2019-08-30 00:25:30.287 [http-nio-8080-exec-4] INFO c.r.s.controller.ObjectConvertXMLController----将File类型的xml转换成对象 End---