使用XStream是实现XML与Java对象的转换(1)--简介及入门示例

一、简单介绍

XStream是thoughtworks开发的开源框架，用于实现XML数据于Java对象、Json数据的转换。它不需要schema或其他的mapping文件就可以进行java对象和xml文件之间的转换，API调用起来非常方便，并且扩展功能强大。

1，XStream的特点

a)灵活易用：在更高的层次上提供了简单、灵活、易用的统一接口，用户无需了解项目的底层细节

b)无需映射：大多数对象都可以在无需映射的情况下进行序列化与反序列化的操作

c)高速稳定：设计时力求达到的最重要的指标是解析速度快、占用内存少，以使之能够适用于大的对象处理或是对信息吞吐量要求高的系统

d)清晰易懂：项目采用reflection机制得到无冗余信息的XML文件。所生成的XML文件较本地Java序列化产物更简洁，格式更清晰，更便于用户阅读

e)无需修改：完全序列化包括private和final类型在内的全部内部字段。支持非公有类和内部类，类可以没有缺省的构造函数。

f)易于集成：通过实现特定的接口，XStream可以直接与其它任何树型结构进行序列化与反序列化操作（而不仅仅是XML格式）

g)灵活转换：转换策略是可以定制的，允许用户自定义特殊类型的对象如何以XML格式存储。

h)错误处理：由于XML文本不合法而造成异常时，会提供详细地诊断信息帮助处理问题。

2，应用场合

a)数据对象的持久化

b)数据交换

c)配置文件

3，架构分析

a)Converters（转换器）

当XStream遇到需要转换的对象时，它会委派给合适的转换器实现，XStream为通用类型提供了多种转换器实现，包括基本数据类型、String、Collections、Arrays、null、Date，等等。

XStream提供了缺省的转换器，当需要转换的数据对象没有匹配的转换器时会使用。是通过反射机制自动完成对对象内所有字段的映射。

b)IO（输入/输出）

XStream是通过接口HierarchicalStramWriter和HierarchialStreamReader从底层XML数据中抽象而来的，上面的接口分别用于序列化和反序列化操作。

该特性使得XStream可以直接使用XML解析类从数据流中读取数据，或者是直接从已经存在的结构中提取数据（比如DOM）。如果XStream所操作的 XML数据已经部分被其它XML解析类处理过了（比如SOAP类的实例），这样就可以避免在我们这一层的再次解析操作。

c)Context（上下文引用）

在XStream序列化或反序列化对象时，它会创建两个类MarshallingContext和UnmarshallingContext，由它们来处理数据，以及委派合适的转换器。

XStream提供了三对上下文的缺省实现，它们之间有着细微的差别。缺省值可以通过方法XStream.setMode()来改变，需要传递下面参数中的一个：

i)XStream.XPATH_REFERENCES，(缺省的)通过XPath引用来标识重复的引用。这样产生的XML具有最小的混乱性。

ii)XStream.ID_REFERENCES，使用ID引用来标识重复的引用。在一些场合，比如使用手写XML时，这样将会更易于操作

iii)XStream.NO_REFERENCES，这种情况将失去对图形对象的支持，仅把对象看作为树型结构。重复的引用被视作两个不同的对象，循环引用会导致异常产生。相对于上面两种模式，这种模式速度会更快，占用内存会更

d)Facade（统一入口）

主要类XStream用作所有项目的入口点。它将上面所提及的重要组件集成在一起，提供更简单易用的API操作。

二、资源网址

项目主页：

http://xstream.codehaus.org/

在线帮助文档：http://xstream.codehaus.org/javadoc/index.html

lib和源码下载：http://xstream.codehaus.org/download.html

 

三、注意事项：

1，XStream将Java对象序列化为XML数据时，不关心属性字段是否是final、private类型，也不关心是否有对应的get/set方法，更不关心你是否有一个默认的无参构造方法。

2，项目的classpath中应该有3个包：xstream-[版本].jar，xpp3-[版本].jar，xmlpull-[版本].jar。

四、使用入门示例及介绍

 

 1，示例代码

Java代码  

1. import com.thoughtworks.xstream.XStream;  
2. import com.thoughtworks.xstream.io.xml.DomDriver;  
3. import com.thoughtworks.xstream.io.xml.StaxDriver;  
4.    
5. public class XStreamTest {  
6.    public static void main(String[] args) {  
7.       Person p = new Person();  
8.       p.sex = new StringBuffer("未知");  
9.       p.set("如花");  
10.       p.age = 70;  
11.       System.out.println("转换之前的Person对象p="+p);  
12.    
13.       //这样创建XStream实例时，上面那3个jar包必须都有  
14. //    XStream xstream = new XStream();  
15.       //这里不需要XPP3库了，而是使用标准的JAXP DOM解析XML  
16. //    XStream xstream = new XStream(new DomDriver());  
17.       //这里不需要XPP3库了但是需要你使用java 6  
18.       XStream xstream = new XStream(new StaxDriver());  
19.       String xml = xstream.toXML(p);  
20.       System.out.println("转换生成XML字符串=="+xml);  
21.       Person p2 = (Person) xstream.fromXML(xml);  
22.       System.out.println("转换之后的Person对象p2="+p2);  
23.    }  
24.    
25. }  
26. class Person{  
27.    private String name;  
28.    int age;  
29.    public StringBuffer sex;  
30.    public void set(String name){  
31.       this.name = name;  
32.    }  
33.    public String toString(){  
34.       return "{name="+name+";age="+age+";sex="+sex+"}";  
35.    }  
36. }  

 

 

 

运行结果：

转换之前的Person对象p={name=如花;age=70;sex=未知}

转换生成XML字符串==<?xml version="1.0" ?><cn.tjpu.zhw.xml.Person><name>如花</name><age>70</age><sex>未知</sex></cn.tjpu.zhw.xml.Person>

转换之后的Person对象p2={name=如花;age=70;sex=未知}

 2，创建XStream对象

a)无参构造函数，默认使用XPP3包

Java代码  

1. //这样创建XStream实例时，上面那3个jar包必须都有  
2.       XStream xstream = new XStream();  

 

b)有参构造函数，使用标准的JAXP DOM

Java代码  

1. //这里不需要XPP3和xmlpull库了，而是使用标准的JAXP DOM解析XML  
2.       XStream xstream = new XStream(new DomDriver());  

 

c)有参构造函数，使用StAX解析XML

Java代码  

1. //这里不需要XPP3库了但是需要你使用java 6  
2.       XStream xstream = new XStream(new StaxDriver());  

 

3，将Java对象转换成为XML字符串

String xml = xstream.toXML(p);

结果是：

 

Xml代码  

1. <?xml version="1.0" ?>  
2. <cn.tjpu.zhw.xml.Person>  
3.    <name>如花</name>  
4.    <age>70</age>  
5.    <sex>未知</sex>  
6. </cn.tjpu.zhw.xml.Person>  

 

 4，将XML转换成为Java对象

 

Person p2 = (Person) xstream.fromXML(xml);