一、前言
1、XStream官网
http://x-stream.github.io
2、XStream是什么
XStream是一个简单的基于Java的类库,用来将Java对象序列化成XML(JSON)或反序列化为对象(即:可以轻易的将Java对象和XML文档相互转换)
3、XSteam能干什么
XStream在运行时使用Java反射机制对要进行序列化的对象树的结构进行探索,并不需要对对象作出修改。XStream可以序列化内部字段,包括私private和final字段,并且支持非公开类以及内部类。
在缺省情况下,XStream不需要配置映射关系,对象和字段将映射为同名XML元素。但是当对象和字段名与XML中的元素名不同时,XStream支持指定别名。XStream支持以方法调用的方式,或是Java 标注的方式指定别名。
XStream在进行数据类型转换时,使用系统缺省的类型转换器。同时,也支持用户自定义的类型转换器。
4、XStream特点
-
使用方便 - XStream的API提供了一个高层次外观,以简化常用的用例
-
无需创建映射 - XStream的API提供了默认的映射大部分对象序列化
-
性能 - XStream快速和低内存占用,适合于大对象图或系统
-
干净的XML - XStream创建一个干净和紧凑XML结果,这很容易阅读
-
不需要修改对象 - XStream可序列化的内部字段,如private和final字段,支持非公开类和内部类。默认构造函数不是强制性的要求
-
完整对象图支持 - XStream允许保持在对象模型中遇到的重复引用,并支持循环引用
-
可自定义的转换策略 - 定制策略可以允许特定类型的定制被表示为XML的注册
-
安全框架 - XStream提供了一个公平控制有关解组的类型,以防止操纵输入安全问题
-
错误消息 - 出现异常是由于格式不正确的XML时,XStream抛出一个统一的例外,提供了详细的诊断,以解决这个问题
-
另一种输出格式 - XStream支持其它的输出格式,如JSON
5、XStream常见的用途
传输、持久化、配置、单元测试
二、XStream入门
1、添加XSteam依赖
2、XStream基本使用
3、程序运行结果
注意:文中使用到的Lombok注解,Lombok依赖自行添加;XStream序列化XML时需要引用的jar包:xstream-[version].jar、xpp3-[version].jar、xmlpull-[version].jar,当引入xstream依赖后会自动依赖xpp3、xmlpull依赖。XStream序列化JSON需要引用的jar包:jettison-[version].jar。
使用XStream序列化时,对JavaBean没有任何限制。JavaBean的字段可以是私有的,也可以没有getter或setter方法,还可以没有默认的构造函数。
XStream序列化XML时可以允许用户使用不同的XML解析器,用户可以使用一个标准的JAXP DOM解析器或自Java 6集成STAX解析器。这样用户就不需要依赖xpp3-[version].jar。
三、XStream混叠
1、混叠是一种技术来定制生成XML或者使用XStream特定的格式化XML。假设,一个下面的XML格式是用于序列化/反序列化Student对象。
2、根椐上面的XML格式,我们创建实体类
3、执行代码
4、验证输出
在上面的结果,我们已经看到了Student对象名称是完全合格的。要替换它作为学生的标签,按照四、XStream类混叠的步骤
另外,在上述结果中可以看出,所需studentName要重命名来命名。要替换它,按照五、XStream字段混叠的步骤
在上面的结果,我们可以看到手机标记被添加成为手机列表。替换它,按照六、XStream隐式集合混叠的步骤
在上面的结果,我们可以看到这个名字来作为一个子节点,需要将它作为根节点的属性。替换它,按照七、XStream属性混叠的步骤
四、XStream类混叠
1、类混叠是用来创建一个类的XML完全限定名称的别名。让我们修改XStreamTest02例子,将下面的代码添加到XStreamTest02例子里面
2、执行代码
3、执行结果
可以看到
五、XStream字段混叠
1、字段混叠用于创建以XML字段的别名。让我们再次修改原来的XStreamTest02例子,将下面的代码添加到XStreamTest02例子里面
2、执行代码
3、执行结果
可以看到
六、XStream隐式集合混叠
1、隐式集合混叠时使用的集合是表示在XML无需显示根。例如,在我们的例子中,我们需要一个接一个,但不是在根节点来显示每一个节点。让我们再次修改原来的XStreamTest02例子,将下面的代码添加到XStreamTest02例子里面
2、执行代码
3、执行结果
可以看到
七、XStream属性混叠
1、属性混叠用于创建一个成员变量作为XML属性序列化。让我们再次修改原来的XStreamTest02例子,将下面的代码添加到XStreamTest02例子里面
2、执行代码
3、执行结果
可以看到
八、XStream包混叠
1、包混叠用于创建一个类XML的完全限定名称的别名到一个新的限定名称。让我们再次修改原来的XStreamTest02例子,将下面代码
修改为
2、执行代码
3、执行结果
可以看到包名由io.github.xstream.test02替换为了xx.xx.xx.xx
九、XStream注解
1、前面的四、五、六、七、八步骤都是通过代码操作的
2、XStream同时也支持注解,使用注解会变得简单也会达到相同的效果
3、使用注解的话,需要XML序列化之前添加如下代码
或者
4、执行结果
使用注解我们也可以看到也能达到相同的效果
注意:当使用XStream对象处理一个被注解的类型时,XStream对象也会处理所有与其相关的类型的注解信息,即该类型的父类、父接口、所有子类的注解。
十、XStream自定义转换器
1、XStream自带的转换器
XStream内部有许多转换器,用于JavaBean对象到XML或JSON之间的转换。这些转换器的详细信息网址:http://x-stream.github.io/converters.html
2、使用自定义转换器
自定义转换器
3、执行结果
4、常用的转换器接口与抽象类
十一、XStream对象流
1、对象输出流
2、在指定路径中打开test.txt文件,查看执行结果
注意:XStream对象流是通过标准java.io.ObjectOutputStream和java.io.ObjectInputStream对象。因为XML文档只能有一个根节点,必须包装在一个序列化的所有元素额外的根节点。这个根节点默认为
3、对象输入流
4、执行结果
十二、XStream持久化API
1、保存Java对象
2、运行程序结果,在F磁盘的根路径可以看到有三个文件:[email protected]、[email protected]、[email protected],每个对象都被序列化到XML文件里
3、读取并删除JavaBean对象
4、运行程序结果,可以看到把F磁盘的根路径[email protected]、[email protected]、[email protected]文件删除了
十三、XStream操作JSON
1、XStream序列化JSON的重命名
2、运行结果
注意:XStream序列化JSON的重命名的方式与其序列化成XML的方式一样!
3、去掉序列化JSON的根节点
4、运行结果
注意:去掉根节点后的JSON串是不能反序列化的,因为XStream不知道它的类型。
5、JSON的解析器区别
前面两个例子使用了不同的JSON解析器,这里说明他们的不同之处:
-
JettisonMappedXmlDriver:是支持序列化和反序列化Json的。
-
JsonHierarchicalStreamDriver:只支持序列化,不支持反序列化。
参考:
http://x-stream.github.io
https://www.yiibai.com/xstream
https://www.cnblogs.com/LiZhiW/p/4313493.html
● 别在 Java 代码里乱打日志了,这才是正确的打日志姿势!
● 高可用Redis服务架构分析与搭建
● 8 种方案,帮你解决重复提交问题!请拿走
● IDEA 解决 Maven 依赖冲突的高能神器,这一篇够不够?
● 你连微服务的网关都说不清楚,还天天鼓捣着要把项目拆分微服务?