XStream学习手册
一、前言
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依赖
<dependency> <groupId>com.thoughtworks.xstream</groupId> <artifactId>xstream</artifactId> <version>1.4.12</version> </dependency> <dependency> <groupId>org.codehaus.jettison</groupId> <artifactId>jettison</artifactId> <version>1.4.1</version> </dependency>
2、XStream基本使用
package io.github.xstream.test01;
import com.thoughtworks.xstream.XStream;
import com.thoughtworks.xstream.io.json.JettisonMappedXmlDriver;
import lombok.AllArgsConstructor;
import lombok.ToString;
public class XStreamTest01 {
public static void main(String[] args) {
Student student = new Student("张三", 20);
XStream xStream = new XStream();//需要XPP3库
//XStream xStream = new XStream(new DomDriver());//不需要XPP3库
//XStream xStream = new XStream(new StaxDriver());//不需要XPP3库开始使用Java 6
//XML序列化
String xml = xStream.toXML(student);
System.out.println(xml);
//XML反序列化
student = (Student) xStream.fromXML(xml);
System.out.println(student);
xStream = new XStream(new JettisonMappedXmlDriver());
xStream.setMode(XStream.NO_REFERENCES);
//Json序列化
String json = xStream.toXML(student);
System.out.println(json);
//Json反序列
student = (Student) xStream.fromXML(json);
System.out.println(student);
}
}
@AllArgsConstructor
@ToString
class Student {
private String name;
private int age;
}3、程序运行结果
<io.github.xstream.test01.Student>
<name>张三</name>
<age>20</age>
</io.github.xstream.test01.Student>
Security framework of XStream not initialized, XStream is probably vulnerable.
Student(name=张三, age=20)
{"io.github.xstream.test01.Student":{"name":"张三","age":20}}
Student(name=张三, age=20)
Security framework of XStream not initialized, XStream is probably vulnerable.注意：文中使用到的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对象。
<student name="张三"> <phone> <brand>小米</brand> <description>小米手机的描述</description> </phone> <phone> <brand>苹果</brand> <description>苹果手机的描述</description> </phone> </student>
2、根椐上面的XML格式，我们创建实体类
@AllArgsConstructor
@ToString
class Student {
private String studentName;
private List<Phone> phones;
}
@AllArgsConstructor
@ToString
class Phone {
private String brand;
private String description;
}3、执行代码
package io.github.xstream.test02;
import com.thoughtworks.xstream.XStream;
import lombok.AllArgsConstructor;
import lombok.ToString;
import java.util.ArrayList;
import java.util.List;
public class XStreamTest02 {
public static void main(String[] args) {
List<Phone> phones = new ArrayList<>();
phones.add(new Phone("小米手机", "小米手机的描述"));
phones.add(new Phone("苹果手机", "苹果手机的描述"));
Student student = new Student("张三", phones);
XStream xStream = new XStream();//需要XPP3库
//XML序列化
String xml = xStream.toXML(student);
System.out.println(xml);
}
}
@AllArgsConstructor
@ToString
class Student {
private String studentName;
private List<Phone> phones;
}
@AllArgsConstructor
@ToString
class Phone {
private String brand;
private String description;
}4、验证输出
<io.github.xstream.test02.Student> <studentName>张三</studentName> <phones> <io.github.xstream.test02.Phone> <brand>小米手机</brand> <description>小米手机的描述</description> </io.github.xstream.test02.Phone> <io.github.xstream.test02.Phone> <brand>苹果手机</brand> <description>苹果手机的描述</description> </io.github.xstream.test02.Phone> </phones> </io.github.xstream.test02.Student>
在上面的结果，我们已经看到了Student对象名称是完全合格的。要替换它作为学生的标签，按照四、XStream类混叠的步骤
另外，在上述结果中可以看出，所需studentName要重命名来命名。要替换它，按照五、XStream字段混叠的步骤
在上面的结果，我们可以看到手机标记被添加成为手机列表。替换它，按照六、XStream隐式集合混叠的步骤
在上面的结果，我们可以看到这个名字来作为一个子节点，需要将它作为根节点的属性。替换它，按照七、XStream属性混叠的步骤
四、XStream类混叠
1、类混叠是用来创建一个类的XML完全限定名称的别名。让我们修改XStreamTest02例子，将下面的代码添加到XStreamTest02例子里面
xStream.alias("student", Person02.class);
xStream.alias("phone", Phone.class);2、执行代码
package io.github.xstream.test02;
import com.thoughtworks.xstream.XStream;
import lombok.AllArgsConstructor;
import lombok.ToString;
import java.util.ArrayList;
import java.util.List;
public class XStreamTest02 {
public static void main(String[] args) {
List<Phone> phones = new ArrayList<>();
phones.add(new Phone("小米手机", "小米手机的描述"));
phones.add(new Phone("苹果手机", "苹果手机的描述"));
Student student = new Student("张三", phones);
XStream xStream = new XStream();//需要XPP3库
xStream.alias("student", Student.class);
xStream.alias("phone", Phone.class);
//XML序列化
String xml = xStream.toXML(student);
System.out.println(xml);
}
}
@AllArgsConstructor
@ToString
class Student {
private String studentName;
private List<Phone> phones;
}
@AllArgsConstructor
@ToString
class Phone {
private String brand;
private String description;
}3、执行结果
<student> <studentName>张三</studentName> <phones> <phone> <brand>小米手机</brand> <description>小米手机的描述</description> </phone> <phone> <brand>苹果手机</brand> <description>苹果手机的描述</description> </phone> </phones> </student>
可以看到<io.github.xstream.test02.Student>和<io.github.xstream.test02.Phone>分别被修改为了<student>和<phone>
五、XStream字段混叠
1、字段混叠用于创建以XML字段的别名。让我们再次修改原来的XStreamTest02例子，将下面的代码添加到XStreamTest02例子里面
xStream.aliasField("name", Student.class, "studentName");2、执行代码
package io.github.xstream.test02;
import com.thoughtworks.xstream.XStream;
import lombok.AllArgsConstructor;
import lombok.ToString;
import java.util.ArrayList;
import java.util.List;
public class XStreamTest02 {
public static void main(String[] args) {
List<Phone> phones = new ArrayList<>();
phones.add(new Phone("小米手机", "小米手机的描述"));
phones.add(new Phone("苹果手机", "苹果手机的描述"));
Student student = new Student("张三", phones);
XStream xStream = new XStream();//需要XPP3库
xStream.alias("student", Student.class);
xStream.alias("phone", Phone.class);
xStream.aliasField("name", Student.class, "studentName");
//XML序列化
String xml = xStream.toXML(student);
System.out.println(xml);
}
}
@AllArgsConstructor
@ToString
class Student {
private String studentName;
private List<Phone> phones;
}
@AllArgsConstructor
@ToString
class Phone {
private String brand;
private String description;
}3、执行结果
<student> <name>张三</name> <phones> <phon
原创不易，完成人机校验，阅读全文