一、XStream的用途
XStream是一个Java对象和XML相互转换的工具,很好很强大。提供了所有的基础类型、数组、集合等类型直接转换的支持。
因此XML常用于数据交换、对象序列化(这种序列化和Java对象的序列化技术有着本质的区别)。
Stream对象相当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) ,注册一个转换器。
三、
如果这些基本的操作还不能满足你应用的需求,XStream提供丰富的扩展点。你可以实现自己的转换器。还可以利用XStream完成更负责的功能,比如输出其他非xml格式的数据,还可以输出html,还支持XML Dom类型数据,这些应用起来稍微复杂些。当然这些不是XStream应用的重点,也不用理会,真正需要的时候再查看API和源码研究研究。
XStream的优点很多,但是也有一些小bug,比如在定义别名中的下划线“_”转换为xml后会变成“__”这个符号,很变态。因此,尽量避免在别名中实用任何符号,却是需要下划线的时候,可以考虑实用连接符“-”,这个没有问题。
另外,我们的Java Bean中,常常有一些常量,在转换过程,XStream也会将这些常量转换过去,形成常量的xml节点,这显然不是想要的结果,对于常量字段,就不做转换了。
四、
简单例子:
package test;
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 Person(){
}
public String toString() {
return "Person{" + "name='" + name + '\'' + ", age='" + age + '\''
+ ", profile=" + profile + ", addlist=" + addlist + '}';
}
}//=======================================================
package test;
public class Address {
private String add;
private String zipcode; public Address(String add, String zipcode) {
this.add = add;
this.zipcode = zipcode;
} public String toString() {
return "Address{" + "add='" + add + '\'' + ", zipcode='" + zipcode
+ '\'' + '}';
}
}//======================================================
package test;
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 + '\'' + '}';
}
}//==========================================================
package test;
import java.util.ArrayList;
import java.util.List;import com.thoughtworks.xstream.XStream;
public class XStreamTest {
public static void main(String args[]) {
test();
} public static void test() {
System.out
.println("----------XStream学习:http://lavasoft.blog.51cto.com----------");
// 目标对象
Address address1 = new Address("郑州市经三路", "450001");
Address address2 = new Address("西安市雁塔路", "710002");
List<Address> addList = new ArrayList<Address>();
addList.add(address1);
addList.add(address2);
Profile profile = new Profile("软件工程师", "13512129933", "备注说明");
Person person = new Person("熔岩", "27", profile, addList); // 转换装配
XStream xStream = new XStream();
output(0, xStream, person);
/************** 设置类别名 ****************/
xStream.alias("PERSON", test.Person.class);
xStream.alias("PROFILE", test.Profile.class);
xStream.alias("ADDRESS", test.Address.class);
output(1, xStream, person); /************* 设置类成员的别名 ***************/
// 设置Person类的name成员别名Name
xStream.aliasField("Name", Person.class, "name");
/*
* [注意] 设置Person类的profile成员别名PROFILE,这个别名和Profile类的别名一致,
* 这样可以保持XStream对象可以从profile成员生成的xml片段直接转换为Profile成员,
* 如果成员profile的别名和Profile的别名不一致,则profile成员生成的xml片段不可
* 直接转换为Profile对象,需要重新创建XStream对象,这岂不给自己找麻烦?
*/
xStream.aliasField("PROFILE", test.Person.class, "profile");
xStream.aliasField("ADDLIST", test.Person.class, "addlist");
xStream.aliasField("Add", test.Address.class, "add");
xStream.aliasField("Job", test.Profile.class, "job");
output(2, xStream, person); /******* 设置类成员为xml一个元素上的属性 *******/
xStream.useAttributeFor(Address.class, "zipcode");
output(3, xStream, person);
/************* 设置属性的别名 ***************/
xStream.aliasAttribute(Address.class, "zipcode", "Zipcode");
output(4, xStream, person);
/************* 将xml转为java对象 ******× ****/
String person_xml = "<PERSON>\n" + " <Name>熔岩</Name>\n"
+ " <age>27</age>\n" + " <PROFILE>\n"
+ " <Job>软件工程师</Job>\n" + " <tel>13512129933</tel>\n"
+ " <remark>备注说明</remark>\n" + " </PROFILE>\n"
+ " <ADDLIST>\n" + " <ADDRESS Zipcode=\"450001\">\n"
+ " <Add>郑州市经三路</Add>\n" + " </ADDRESS>\n"
+ " <ADDRESS Zipcode=\"710002\">\n"
+ " <Add>西安市雁塔路</Add>\n" + " </ADDRESS>\n"
+ " </ADDLIST>\n" + "</PERSON>";
String profile_xml = " <PROFILE>\n" + " <Job>软件工程师</Job>\n"
+ " <tel>13512129933</tel>\n"
+ " <remark>备注说明</remark>\n" + " </PROFILE>";
String address_xml = " <ADDRESS Zipcode=\"710002\">\n"
+ " <Add>西安市雁塔路</Add>\n" + " </ADDRESS>";
// 同样实用上面的XStream对象xStream
System.out.println(xStream.fromXML(person_xml).toString());
System.out.println(xStream.fromXML(profile_xml).toString());
System.out.println(xStream.fromXML(address_xml).toString());
} public static void output(int i, XStream xStream, Object obj) {
String xml = xStream.toXML(obj);
System.out.println(">>>第[ " + i + "]次输出\n");
System.out.println(xml + "\n");
}
}//=======================================================
----------XStream学习:http://lavasoft.blog.51cto.com----------
>>>第[ 0]次输出<test.Person>
<name>熔岩</name>
<age>27</age>
<profile>
<job>软件工程师</job>
<tel>13512129933</tel>
<remark>备注说明</remark>
</profile>
<addlist>
<test.Address>
<add>郑州市经三路</add>
<zipcode>450001</zipcode>
</test.Address>
<test.Address>
<add>西安市雁塔路</add>
<zipcode>710002</zipcode>
</test.Address>
</addlist>
</test.Person>>>>第[ 1]次输出
<PERSON>
<name>熔岩</name>
<age>27</age>
<profile>
<job>软件工程师</job>
<tel>13512129933</tel>
<remark>备注说明</remark>
</profile>
<addlist>
<ADDRESS>
<add>郑州市经三路</add>
<zipcode>450001</zipcode>
</ADDRESS>
<ADDRESS>
<add>西安市雁塔路</add>
<zipcode>710002</zipcode>
</ADDRESS>
</addlist>
</PERSON>>>>第[ 2]次输出
<PERSON>
<Name>熔岩</Name>
<age>27</age>
<PROFILE>
<Job>软件工程师</Job>
<tel>13512129933</tel>
<remark>备注说明</remark>
</PROFILE>
<ADDLIST>
<ADDRESS>
<Add>郑州市经三路</Add>
<zipcode>450001</zipcode>
</ADDRESS>
<ADDRESS>
<Add>西安市雁塔路</Add>
<zipcode>710002</zipcode>
</ADDRESS>
</ADDLIST>
</PERSON>>>>第[ 3]次输出
<PERSON>
<Name>熔岩</Name>
<age>27</age>
<PROFILE>
<Job>软件工程师</Job>
<tel>13512129933</tel>
<remark>备注说明</remark>
</PROFILE>
<ADDLIST>
<ADDRESS zipcode="450001">
<Add>郑州市经三路</Add>
</ADDRESS>
<ADDRESS zipcode="710002">
<Add>西安市雁塔路</Add>
</ADDRESS>
</ADDLIST>
</PERSON>>>>第[ 4]次输出
<PERSON>
<Name>熔岩</Name>
<age>27</age>
<PROFILE>
<Job>软件工程师</Job>
<tel>13512129933</tel>
<remark>备注说明</remark>
</PROFILE>
<ADDLIST>
<ADDRESS Zipcode="450001">
<Add>郑州市经三路</Add>
</ADDRESS>
<ADDRESS Zipcode="710002">
<Add>西安市雁塔路</Add>
</ADDRESS>
</ADDLIST>
</PERSON>