XStream使用方法总结附实例代码
Posted onXStream使用方法总结附实例代码
发布:dxy
XStream是一个Java对象和XML相互转换的工具,很好很强大。提供了所有的基础类型、数组、集合等类型直接转换的支持。因此XML常用于数据交换、对象序列化(这种序列化和Java对象的序列化技术有着本质的区别)。
XStream中的核心类就是XStream类,一般来说,熟悉这个类基本就够用了,如果你用的更多,估计是你设计有问题,否则不需要。
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节点,这显然不是想要的结果,对于常量字段,就不做转换了。
下面给出一个非常典型的而且实用的例子,作为对总结的补充:
package test;
import java.util.List;
///
/ Created by IntelliJ IDEA.
/ User: leizhimin
/ Date: 2008-5-22 21:10:13
/ Note: Please add comment here!
//
public class Person {
private String name;
private String age;
private Profile profile;
private List addlist;
public Person(String name, String age, Profile profile, List 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 +
'}';
}
}
package test;
import java.sql.Date;
///
/ Created by IntelliJ IDEA.
/ User: leizhimin
/ Date: 2008-5-22 21:10:32
/ Note: Please add comment here!
//
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;
///
/ Created by IntelliJ IDEA.
/ User: leizhimin
/ Date: 2008-5-22 21:10:22
/ Note: Please add comment here!
//
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;
import com.thoughtworks.xstream.XStream;
import java.util.List;
import java.util.ArrayList;
///
/ Created by IntelliJ IDEA.
/ User: leizhimin
/ Date: 2008-5-22 21:10:47
/ Note: XStream学习[http://lavasoft.blog.51cto.com]
//
public class TestXStream {
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
第[ 1]次输出
熔岩
27
软件工程师
13512129933
备注说明
郑州市经三路
450001
西安市雁塔路 第[ 2]次输出
710002
熔岩
27
软件工程师
13512129933
备注说明
郑州市经三路
450001
西安市雁塔路 第[ 3]次输出
710002
熔岩
27
软件工程师
13512129933
备注说明
郑州市经三路 Person{name='熔岩', age='27', profile=Profile{job='软件工程师', tel='13512129933', remark='备注说明'}, addlist=[Address{add='郑州市经三路', zipcode='450001'}, Address{add='西安市雁塔路', zipcode='710002'}]} Profile{job='软件工程师', tel='13512129933', remark='备注说明'} Address{add='西安市雁塔路', zipcode='710002'} Process finished with exit code 0 在实际中,类的属性很多,嵌套层次也很复杂,如果仅仅使用XStream原生API来硬编码设置别名等属性,显得太生硬也难以维护。完全可以考虑通过一个xml配置文件来定义所有用到的类的别名定义(包括其成员),然后,通过读取配置构建一个XStream的工厂,在用到时候直接去取,而不是让实用者组装。我目前的一个项目中,就是这么实现的,效果非常的好。 下面我给出针对上面提出的问题一个解决方案: 思想:考虑做一个过滤器,在xml转java之前,在Java转xml之后,应用这个过滤器。这个过滤器提供将xml中的“”替换为“-”,并且将xml中的不需要的节点剔除。 在过滤之前,我实现了个转换器装配,这一步通过xml来配置,并在java中获取。 代码就省略了,这一步很灵活,关键看你的应用了。 为了能过滤xml,我们需要用Dom4j递归遍历xml文档。下面一些算法代码: //递归算法:遍历配置文件,找出所有有效的xpath private static void recursiveElement(Element element) { List
西安市雁塔路 elements = element.elements(); validXPathList.add(element.getPath()); if (elements.size() == 0) { //没有子元素 } else { //有子元素 for (Iterator ", "_")); //递归的调用:标记要剔除的xml元素 recursiveFixElement(document.getRootElement()); Listit = elements.iterator(); it.hasNext();) { //递归遍历 recursiveElement(it.next()); } } } //递归算法:遍历xml,标识无效的元素节点 private static void recursiveFixElement(Element element) { List elements = element.elements(); if (!validXPathList.contains(element.getPath())) { element.addAttribute("delete", "true"); } if (elements.size() == 0) { //没有子元素 } else { //有子元素 for (Iterator it = elements.iterator(); it.hasNext();) { Element e = it.next(); if (!validXPathList.contains(e.getPath())) { e.addAttribute("delete", "true"); } //递归遍历 recursiveFixElement(e); } } } /// / 过滤器接口方法,转换不规范字符,剔除无效节点 / / @param xmlStr 要过滤的xml / @return 符合转换器要求的xml /*/ public static String filter(String xmlStr) { Document document = null; try { document = DocumentHelper.parseText(xmlStr.replaceAll(" nodeList = document.selectNodes("//@delete"); for (Node node : nodeList) { node.getParent().detach(); //剔除xml元素 } } catch (DocumentException e) { System.out.println(e.getMessage()); e.printStackTrace(); } return document.asXML(); }
-