XStream是一个Java对象和XML相互转换的工具,很好很强大。提供了所有的基础类型、数组、集合等类型直接转换的支持。因此XML常用于数据交换、对象序列化(这种序列化和Java对象的序列化技术有着本质的区别)。
XStream对象相当Java对象和XML之间的转换器,转换过程是双向的。创建XSteam对象的方式很简单,只需要new XStream()即可。
Java到xml,用toXML()方法。
Xml到Java,用fromXML()方法。
在没有任何设置默认情况下,java到xml的映射,是java成员名对应xml的元素名,java类的全名对应xml根元素的名字。而实际中,往往是xml和java类都有了,要完成相互转换,必须进行别名映射。
别名配置包含三种情况:
1、类别名,用alias(String name, Class type)。
2、类成员别名,用aliasField(String alias, Class definedIn, String fieldName)
3、类成员作为属性别名,用 aliasAttribute(Class definedIn, String attributeName, String alias),单独命名没有意义,还要通过useAttributeFor(Class definedIn, String fieldName) 应用到某个类上。
别名的配置是非常重要的,但是其中有些细节问题很重要,在例子中会专门做详细说明。
另外还有不太常用的方法:
addImplicitCollection(Class ownerType, String fieldName),去掉集合类型生成xml的父节点。
registerConverter(Converter converter) ,注册一个转换器。
如果你的xml很大,或者为了安全性,以流的方式传输,那么XStream也提供丰富的API,
如果这些基本的操作还不能满足你应用的需求,XStream提供丰富的扩展点。你可以实现自己的转换器。还可以利用XStream完成更负责的功能,比如输出其他非xml格式的数据,还可以输出html,还支持XML Dom类型数据,这些应用起来稍微复杂些。当然这些不是XStream应用的重点,也不用理会,真正需要的时候再查看API和源码研究研究。
XStream的优点很多,但是也有一些小bug,比如在定义别名中的下划线“_”转换为xml后会变成“__”这个符号,很变态。因此,尽量避免在别名中实用任何符号,却是需要下划线的时候,可以考虑实用连接符“-”,这个没有问题。
另外,我们的Java Bean中,常常有一些常量,在转换过程,XStream也会将这些常量转换过去,形成常量的xml节点,这显然不是想要的结果,对于常量字段,就不做转换了。
下面给出一个非常典型的而且实用的例子,作为对总结的补充:
[java] view plain copy
- import java.util.List;
- public class Person {
- private String name;
- private String age;
- private Profile profile;
- private List<Address> addlist;
- public Person(String name, String age, Profile profile, List<Address> addlist) {
- this.name = name;
- this.age = age;
- this.profile = profile;
- this.addlist = addlist;
- }
- public String toString() {
- return "Person{" + "name='" + name + '\'' + ", age='" + age + '\'' + ", profile=" + profile + ", addlist=" + addlist + '}';
- }
- }
[java] view plain copy
- public class Profile {
- private String job;
- private String tel;
- private String remark;
- public Profile(String job, String tel, String remark) {
- this.job = job;
- this.tel = tel;
- this.remark = remark;
- }
- public String toString() {
- return "Profile{" + "job='" + job + '\'' + ", tel='" + tel + '\'' + ", remark='" + remark + '\'' + '}';
- }
- }
[java] view plain copy
- import java.util.List;
- public class Person {
- private String name;
- private String age;
- private Profile profile;
- private List<Address> addlist;
- public Person(String name, String age, Profile profile, List<Address> addlist) {
- this.name = name;
- this.age = age;
- this.profile = profile;
- this.addlist = addlist;
- }
- public String toString() {
- return "Person{" + "name='" + name + '\'' + ", age='" + age + '\'' + ", profile=" + profile + ", addlist=" + addlist + '}';
- }
- }
[java] view plain copy
- import java.util.ArrayList;
- import java.util.List;
- import com.thoughtworks.xstream.XStream;
- import com.thoughtworks.xstream.io.xml.DomDriver;
- public class TestXStream {
- public static void main(String args[]) {
- Address address1 = new Address("郑州市经三路", "450001");
- Address address2 = new Address("北京市海淀区", "100000");
- List<Address> addList = new ArrayList<Address>();
- addList.add(address1);
- addList.add(address2);
- Profile profile = new Profile("软件工程师", "13051594850", "备注说明");
- Person person = new Person("X-rapido", "22", profile, addList);
- // 转换装配
- XStream xStream = new XStream(new DomDriver());
- /************** 设置类别名,不设默认类全路径 ****************/
- xStream.alias("PERSON", Person.class);