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节点,这显然不是想要的结果,对于常量字段,就不做转换了。
下面给出一个非常典型的而且实用的例子,作为对总结的补充:
- importjava.util.List;
-
- publicclassPerson{
- privateStringname;
- privateStringage;
- privateProfileprofile;
- privateList<Address>addlist;
- publicPerson(Stringname,Stringage,Profileprofile,List<Address>addlist){
- this.name=name;
- this.age=age;
- this.profile=profile;
- this.addlist=addlist;
- }
-
- publicStringtoString(){
- return"Person{"+"name='"+name+'\''+",age='"+age+'\''+",profile="+profile+",addlist="+addlist+'}';
- }
copy
publicclassProfile{
privateStringjob;
privateStringtel;
privateStringremark;
publicProfile(Stringjob,Stringtel,Stringremark){
this.job=job;
this.tel=tel;
this.remark=remark;
return"Profile{"+"job='"+job+'\''+",tel='"+tel+'\''+",remark='"+remark+'\''+'}';
copy
copy
importjava.util.ArrayList;
importjava.util.List;
importcom.thoughtworks.xstream.XStream;
importcom.thoughtworks.xstream.io.xml.DomDriver;
publicclassTestXStream{
publicstaticvoidmain(Stringargs[]){
Addressaddress1=newAddress("郑州市经三路","450001");
Addressaddress2=newAddress("北京市海淀区","100000");
List<Address>addList=newArrayList<Address>();
addList.add(address1);
addList.add(address2);
Profileprofile=newProfile("软件工程师","13051594850","备注说明");
Personperson=newPerson("X-rapido","22",profile,addList);
XStreamxStream=newXStream(newDomDriver());
/**************设置类别名,不设默认类全路径****************/
xStream.alias("PERSON",Person.class);
xStream.alias("PROFILE",Profile.class);
xStream.alias("ADDRESS",Address.class);
Stringxml=xStream.toXML(person);
System.out.println("----------------第1次输出,设置类别名----------------\n"+xml+"\n");
/*************设置类成员的别名***************/
//设置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","profile");
xStream.aliasField("ADDLIST","addlist");
xStream.aliasField("Add",Address.class,"add");
xStream.aliasField("Job",Profile.class,"job");
Stringxml2=xStream.toXML(person);
System.out.println("----------------第2次输出,设置类、字段别名----------------\n"+xml2+"\n");
/*******设置类成员为xml一个元素上的属性*******/
xStream.useAttributeFor(Address.class,"zipcode");
/*************设置属性的别名***************/
xStream.aliasAttribute(Address.class,"zipcode","Zipcode");
Stringxml3=xStream.toXML(person);
System.out.println("----------------第3次输出,设置类、字段别名,并在xml字段节点上增加属性----------------\n"+xml3+"\n");
/*************将xml转为java对象******×****/
Stringperson_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"+
"<ADDRESSZipcode=\"450001\">\n"+
"<Add>郑州市经三路</Add>\n"+
"</ADDRESS>\n"+
"<ADDRESSZipcode=\"710002\">\n"+
"<Add>西安市雁塔路</Add>\n"+
"</ADDRESS>\n"+
"</ADDLIST>\n"+
"</PERSON>";
Stringprofile_xml="<PROFILE>\n"+
"</PROFILE>";
Stringaddress_xml="<ADDRESSZipcode=\"710002\">\n"+
"</ADDRESS>";
//同样使用上面的XStream对象将xml转换为Java对象
System.out.println(xStream.fromXML(person_xml).toString());
System.out.println(xStream.fromXML(profile_xml).toString());
System.out.println(xStream.fromXML(address_xml).toString());
}
}
xStream.toXML()和xStream.fromXML()的常用方法
比如写入文件方法
读取
在实际中,类的属性很多,嵌套层次也很复杂,如果仅仅使用XStream原生API来硬编码设置别名等属性,显得太生硬也难以维护。完全可以考虑通过一个xml配置文件来定义所有用到的类的别名定义(包括其成员),然后,通过读取配置构建一个XStream的工厂,在用到时候直接去取,而不是让实用者组装。我目前的一个项目中,就是这么实现的,效果非常的好。
下面我给出针对上面提出的问题一个解决方案:
思想:考虑做一个过滤器,在xml转java之前,在Java转xml之后,应用这个过滤器。这个过滤器提供将xml中的“__”替换为“-”,并且将xml中的不需要的节点剔除。
在过滤之前,我实现了个转换器装配,这一步通过xml来配置,并在java中获取。
代码就省略了,这一步很灵活,关键看你的应用了。