【开发心得】Jaxb使用珠玑

2023-10-17 19:52
文章标签 使用 开发 心得 珠玑 jaxb

本文主要是介绍【开发心得】Jaxb使用珠玑,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

前言

    Java操作xml转换成javaBean,或者javaBean转换为xml的方式有很多。常见的有dom4j等工具直接操作dom,或者使用jaxb.

jaxb介绍:

JAXB(Java Architecture for XML Binding简称JAXB)允许Java开发人员将Java类映射为XML表示方式。JAXB提供两种主要特性:将一个Java对象序列化为XML,以及反向操作,将XML解析成Java对象。换句话说,JAXB允许以XML格式存储和读取数据,而不需要程序的类结构实现特定的读取XML和保存XML的代码。

工具类

package com.test.tms.backend.service.utils;import com.test.tms.backend.service.xml.ParseXmlExceptionHandler;
import com.sun.xml.internal.bind.marshaller.CharacterEscapeHandler;
import com.sun.xml.internal.bind.marshaller.NoEscapeHandler;
import com.sun.xml.internal.bind.v2.runtime.JAXBContextImpl;
import com.sun.xml.internal.bind.v2.runtime.JaxBeanInfo;
import com.sun.xml.internal.bind.v2.runtime.unmarshaller.UnmarshallerImpl;
import com.sun.xml.internal.bind.v2.util.XmlFactory;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang3.StringEscapeUtils;
import org.apache.commons.lang3.StringUtils;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import org.xml.sax.XMLReader;import javax.xml.bind.*;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParserFactory;
import javax.xml.transform.sax.SAXSource;
import java.io.InputStream;
import java.io.StringWriter;
import java.nio.charset.StandardCharsets;/*** @Author: martin* @Date: 2023/8/15 09:44* @Description:*/@Slf4j
public class XMLUtils {/*** 将String类型的xml转换成对象*/public static Object convertXmlStrToObject(Class clazz, String xmlStr) {Object xmlObject = null;try {JAXBContext context = JAXBContext.newInstance(clazz);Unmarshaller unmarshaller = context.createUnmarshaller();unmarshaller.setEventHandler(new ValidationEventHandler() {@Overridepublic boolean handleEvent(ValidationEvent event) {if (event.getSeverity() == 2) {Throwable t = event.getLinkedException();if (t != null) {log.error(t.getMessage(), t);}return true;}return true;}});InputStream inputStream = IOUtils.toInputStream(xmlStr, StandardCharsets.UTF_8);InputSource inputSource = new InputSource(inputStream);XMLReader reader = getXMLReader(context);reader.setFeature("http://apache.org/xml/features/continue-after-fatal-error", true);ParseXmlExceptionHandler errorHandler = new ParseXmlExceptionHandler();reader.setErrorHandler(errorHandler);SAXSource source = new SAXSource(reader, inputSource);xmlObject = ((UnmarshallerImpl) unmarshaller).unmarshal0(source, (JaxBeanInfo) null);} catch (Exception e) {log.error(e.getMessage(), e);}return xmlObject;}public static XMLReader getXMLReader(JAXBContext context) throws JAXBException {try {SAXParserFactory parserFactory = XmlFactory.createParserFactory(((JAXBContextImpl) context).disableSecurityProcessing);parserFactory.setValidating(false);return parserFactory.newSAXParser().getXMLReader();} catch (ParserConfigurationException var2) {throw new JAXBException(var2);} catch (SAXException var3) {throw new JAXBException(var3);}}/*** @param javaBean* @param <T>* @return* @description: 将包含@XmlRootElement的jaxb javaBean转换Xml*/public static <T> String javaBeanToXmlStr(T javaBean, Boolean noHeadFlag, Boolean keepSpecCharFlag) {try {JAXBContext context = JAXBContext.newInstance(javaBean.getClass());Marshaller marshaller = context.createMarshaller();marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);// 去掉报文头if (noHeadFlag) {marshaller.setProperty(Marshaller.JAXB_FRAGMENT, true);}// 禁止转义if (keepSpecCharFlag) {CharacterEscapeHandler escapeHandler = NoEscapeHandler.theInstance;marshaller.setProperty("com.sun.xml.internal.bind.characterEscapeHandler", escapeHandler);}StringWriter writer = new StringWriter();marshaller.marshal(javaBean, writer);return writer.toString();} catch (Exception e) {log.error(e.getMessage(), e);}return null;}/*** @param str* @return* @description: 将xml字符串进行加密*/public static String escapeXmlStr(String str) {if (StringUtils.isNotBlank(str)) {String escapedData = StringEscapeUtils.escapeXml11(str);return escapedData;}return null;}
}

珠玑

聊点心得:

1. 关于jaxb实体类的快速生成。

可以借助jxc或者 jdk自带tools,参考博主另一篇博文

【开发心得】Java xsd文件转JavaBean-CSDN博客最近又要对接友商老的系统,依然采用http + xml方式的请求,客方提供了xsd,这里提供windows平台两种转换xsd文件为javaBean的方式。https://blog.csdn.net/qq_26834611/article/details/133788946?spm=1001.2014.3001.55012. jaxb生成xml去掉报文头

参考如下设置:

JAXBContext context = JAXBContext.newInstance(javaBean.getClass());Marshaller marshaller = context.createMarshaller();marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);// 去掉报文头if (noHeadFlag) {marshaller.setProperty(Marshaller.JAXB_FRAGMENT, true);}

3. 控制是否需要转义字符

jaxb控制字符转义,jaxb不转义字符。如下

// 禁止转义if (keepSpecCharFlag) {CharacterEscapeHandler escapeHandler = NoEscapeHandler.theInstance;marshaller.setProperty("com.sun.xml.internal.bind.characterEscapeHandler", escapeHandler);}StringWriter writer = new StringWriter();marshaller.marshal(javaBean, writer);return writer.toString();

有资料显示设置如下参数即可。

com.sun.xml.bind.characterEscapeHandler

但是实际上,java1.8 (331) 是

com.sun.xml.internal.bind.characterEscapeHandler

暂时没有去探究哪个版本开始变更的,遇到这种情况,直接翻一下源码即可。

它总共有4个实现类,如果不满足你的需求,可以手动实现并且替换即可。

 4. 单独转义特殊字符。

实际上jaxb对于特殊字符的转义,默认不包含引号,这里使用StringEscapeUtils.escapeXml11()进行转义。

 String escapedData = StringEscapeUtils.escapeXml11(str);return escapedData;

总结: 主要在实际开发中遇到了"JAXB嵌套,其中一个字段为String,存储的是xml"的情况。

这篇关于【开发心得】Jaxb使用珠玑的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/227599

相关文章

Spring StateMachine实现状态机使用示例详解

《SpringStateMachine实现状态机使用示例详解》本文介绍SpringStateMachine实现状态机的步骤,包括依赖导入、枚举定义、状态转移规则配置、上下文管理及服务调用示例,重点解... 目录什么是状态机使用示例什么是状态机状态机是计算机科学中的​​核心建模工具​​,用于描述对象在其生命

使用Python删除Excel中的行列和单元格示例详解

《使用Python删除Excel中的行列和单元格示例详解》在处理Excel数据时,删除不需要的行、列或单元格是一项常见且必要的操作,本文将使用Python脚本实现对Excel表格的高效自动化处理,感兴... 目录开发环境准备使用 python 删除 Excphpel 表格中的行删除特定行删除空白行删除含指定

深入理解Go语言中二维切片的使用

《深入理解Go语言中二维切片的使用》本文深入讲解了Go语言中二维切片的概念与应用,用于表示矩阵、表格等二维数据结构,文中通过示例代码介绍的非常详细,需要的朋友们下面随着小编来一起学习学习吧... 目录引言二维切片的基本概念定义创建二维切片二维切片的操作访问元素修改元素遍历二维切片二维切片的动态调整追加行动态

prometheus如何使用pushgateway监控网路丢包

《prometheus如何使用pushgateway监控网路丢包》:本文主要介绍prometheus如何使用pushgateway监控网路丢包问题,具有很好的参考价值,希望对大家有所帮助,如有错误... 目录监控网路丢包脚本数据图表总结监控网路丢包脚本[root@gtcq-gt-monitor-prome

Python通用唯一标识符模块uuid使用案例详解

《Python通用唯一标识符模块uuid使用案例详解》Pythonuuid模块用于生成128位全局唯一标识符,支持UUID1-5版本,适用于分布式系统、数据库主键等场景,需注意隐私、碰撞概率及存储优... 目录简介核心功能1. UUID版本2. UUID属性3. 命名空间使用场景1. 生成唯一标识符2. 数

SpringBoot中如何使用Assert进行断言校验

《SpringBoot中如何使用Assert进行断言校验》Java提供了内置的assert机制,而Spring框架也提供了更强大的Assert工具类来帮助开发者进行参数校验和状态检查,下... 目录前言一、Java 原生assert简介1.1 使用方式1.2 示例代码1.3 优缺点分析二、Spring Fr

Android kotlin中 Channel 和 Flow 的区别和选择使用场景分析

《Androidkotlin中Channel和Flow的区别和选择使用场景分析》Kotlin协程中,Flow是冷数据流,按需触发,适合响应式数据处理;Channel是热数据流,持续发送,支持... 目录一、基本概念界定FlowChannel二、核心特性对比数据生产触发条件生产与消费的关系背压处理机制生命周期

java使用protobuf-maven-plugin的插件编译proto文件详解

《java使用protobuf-maven-plugin的插件编译proto文件详解》:本文主要介绍java使用protobuf-maven-plugin的插件编译proto文件,具有很好的参考价... 目录protobuf文件作为数据传输和存储的协议主要介绍在Java使用maven编译proto文件的插件

SpringBoot线程池配置使用示例详解

《SpringBoot线程池配置使用示例详解》SpringBoot集成@Async注解,支持线程池参数配置(核心数、队列容量、拒绝策略等)及生命周期管理,结合监控与任务装饰器,提升异步处理效率与系统... 目录一、核心特性二、添加依赖三、参数详解四、配置线程池五、应用实践代码说明拒绝策略(Rejected

C++ Log4cpp跨平台日志库的使用小结

《C++Log4cpp跨平台日志库的使用小结》Log4cpp是c++类库,本文详细介绍了C++日志库log4cpp的使用方法,及设置日志输出格式和优先级,具有一定的参考价值,感兴趣的可以了解一下... 目录一、介绍1. log4cpp的日志方式2.设置日志输出的格式3. 设置日志的输出优先级二、Window