xStream框架
xStream可以轻易的将java对象和xml文档相互转换,而且可以修改某个特定的属性和节点名称,而且也支持json的转换;
前面有介绍过json-lib这个框架,在线博文:http://www.cnblogs.com/hoojo/archive/2011/04/21/2023805.html
以及Jackson这个框架,在线博文:http://www.cnblogs.com/hoojo/archive/2011/04/22/2024628.html
它们都完美支持JSON,但是对xml的支持还不是很好。一定程度上限制了对Java对象的描述,不能让xml完全体现到对Java对象的描述。这里将会介绍xStream对JSON、XML的完美支持。xStream不仅对XML的转换非常友好,而且提供annotation注解,可以在JavaBean中完成对xml节点、属性的描述。以及对JSON也支持,只需要提供相关的JSONDriver就可以完成转换。
一、准备工作
1、 下载jar包、及官方资源
xStream的jar下载地址:
https://nexus.codehaus.org/content/repositories/releases/com/thoughtworks/xstream/xstream-distribution/1.3.1/xstream-distribution-1.3.1-bin.zip
官方的示例很全,官方参考示例:http://xstream.codehaus.org/tutorial.html
添加xstream-1.3.1.jar文件到工程中,就可以开始下面的工作;需要的jar如下:
2、 测试用例代码
package com.hoo.test;import java.io.IOException;import java.io.ObjectInputStream;import java.io.ObjectOutputStream;import java.io.StringReader;import java.io.Writer;import java.util.ArrayList;import java.util.HashMap;import java.util.Iterator;import java.util.List;import java.util.Map;import java.util.Set;import org.codehaus.jettison.json.JSONException;import org.junit.After;import org.junit.Before;import org.junit.Test;import com.hoo.entity.Birthday;import com.hoo.entity.Classes;import com.hoo.entity.ListBean;import com.hoo.entity.Student;import com.thoughtworks.xstream.XStream;import com.thoughtworks.xstream.io.HierarchicalStreamWriter;import com.thoughtworks.xstream.io.json.JettisonMappedXmlDriver;import com.thoughtworks.xstream.io.json.JsonHierarchicalStreamDriver;import com.thoughtworks.xstream.io.json.JsonWriter;/*** <b>function:</b>Java对象和XML字符串的相互转换* jar-lib-version: xstream-1.3.1* @author hoojo* @createDate Nov 27, 2010 12:15:15 PM* @file XStreamTest.java* @package com.hoo.test* @PRoject WebHttpUtils* @blog http://blog.csdn.net/IBM_hoojo* @email hoojo_@126.com* @version 1.0*/@SuppressWarnings("unchecked")public class XStreamTest {private XStream xstream = null;private ObjectOutputStream out = null;private ObjectInputStream in = null;private Student bean = null;/*** <b>function:</b>初始化资源准备* @author hoojo* @createDate Nov 27, 2010 12:16:28 PM*/@Beforepublic void init() {try {xstream = new XStream();//xstream = new XStream(new DomDriver()); // 需要xpp3 jar} catch (Exception e) {e.printStackTrace();}bean = new Student();bean.setAddress("china");bean.setEmail("jack@email.com");bean.setId(1);bean.setName("jack");Birthday day = new Birthday();day.setBirthday("2010-11-22");bean.setBirthday(day);}/*** <b>function:</b>释放对象资源* @author hoojo* @createDate Nov 27, 2010 12:16:38 PM*/@Afterpublic void destory() {xstream = null;bean = null;try {if (out != null) {out.flush();out.close();}if (in != null) {in.close();}} catch (IOException e) {e.printStackTrace();}System.gc();}public final void fail(String string) {System.out.println(string);}public final void failRed(String string) {System.err.println(string);}}通过XStream对象的toXML方法就可以完成Java对象到XML的转换,toXML方法还有2个相同签名的方法,需要传递一个流。然后通过流来完成xml信息的输出。
3、 需要的JavaBean
package com.hoo.entity;public class Student {private int id;private String name;private String email;private String address;private Birthday birthday;//getter、setterpublic String toString() {return this.name + "#" + this.id + "#" + this.address + "#" + this.birthday + "#" + this.email;}}二、Java转换成XML
1、 JavaBean转换XM
/*** <b>function:</b>Java对象转换成XML字符串* @author hoojo* @createDate Nov 27, 2010 12:19:01 PM*/@Testpublic void writeBean2XML() {try {fail("------------Bean->XML------------");fail(xstream.toXML(bean));fail("重命名后的XML");//类重命名//xstream.alias("account", Student.class);//xstream.alias("生日", Birthday.class);//xstream.aliasField("生日", Student.class, "birthday");//xstream.aliasField("生日", Birthday.class, "birthday");//fail(xstream.toXML(bean));//属性重命名xstream.aliasField("邮件", Student.class, "email");//包重命名xstream.aliaspackage("hoo", "com.hoo.entity");fail(xstream.toXML(bean));} catch (Exception e) {e.printStackTrace();}}看结果中的第一份xml内容,是没有经过然后修改或重命名的文档,按照原样输出。文档中的第二份文档的package经过重命名,email属性也经过重命名以及类名也可以进行重命名的。
运行后结果如下:
------------Bean->XML------------<com.hoo.entity.Student><id>1</id><name>jack</name><email>jack@email.com</email><address>china</address><birthday><birthday>2010-11-22</birthday></birthday></com.hoo.entity.Student>重命名后的XML<hoo.Student><id>1</id><name>jack</name><邮件>jack@email.com</邮件><address>china</address><birthday><birthday>2010-11-22</birthday></birthday></hoo.Student>2、 将List集合转换成xml文档
/*** <b>function:</b>将Java的List集合转换成XML对象* @author hoojo* @createDate Nov 27, 2010 12:20:07 PM*/@Testpublic void writeList2XML() {try {//修改元素名称xstream.alias("beans", ListBean.class);xstream.alias("student", Student.class);fail("----------List-->XML----------");ListBean listBean = new ListBean();listBean.setName("this is a List Collection");List<Object> list = new ArrayList<Object>();list.add(bean);list.add(bean);//引用bean//list.add(listBean);//引用listBean,父元素bean = new Student();bean.setAddress("china");bean.setEmail("tom@125.com");bean.setId(2);bean.setName("tom");Birthday day = new Birthday("2010-11-22");bean.setBirthday(day);list.add(bean);listBean.setList(list);//将ListBean中的集合设置空元素,即不显示集合元素标签//xstream.addImplicitCollection(ListBean.class, "list");//设置reference模型//xstream.setMode(XStream.NO_REFERENCES);//不引用xstream.setMode(XStream.ID_REFERENCES);//id引用//xstream.setMode(XStream.XPATH_ABSOLUTE_REFERENCES);//绝对路径引用//将name设置为父类(Student)的元素的属性xstream.useAttributeFor(Student.class, "name");xstream.useAttributeFor(Birthday.class, "birthday");//修改属性的namexstream.aliasAttribute("姓名", "name");xstream.aliasField("生日", Birthday.class, "birthday");fail(xstream.toXML(listBean));} catch (Exception e) {e.printStackTrace();}}上面的代码运行后,结果如下:
----------List-->XML----------<beans id="1"><name>this is a List Collection</name><list id="2"><student id="3" 姓名="jack"><id>1</id><email>jack@email.com</email><address>china</address><birthday id="4" 生日="2010-11-22"/></student><student reference="3"/><student id="5" 姓名="tom"><id>2</id><email>tom@125.com</email><address>china</address><birthday id="6" 生日="2010-11-22"/></student></list></beans>如果不加xstream.addImplicitCollection(ListBean.class, "list");
这个设置的话,会出现一个List节点包裹着Student节点元素。添加addImplicitCollection可以忽略这个list节点元素。那么上面的list节点就不存在,只会在beans元素中出现name、student这2个xml元素标签;
setMode是设置相同的对象的引用方式,如果设置XStream.NO_REFERENCES就是不引用,会输出2分相同的Student元素。如果是XStream.ID_REFERENCES会引用相同的那个对象的id属性,如果是XStream.XPATH_ABSOLUTE_REFERENCES引用,那么它将显示xpath路径。上面采用的id引用,<student reference="3"/>这个引用了id=3的那个student标签元素;
useAttributeFor是设置某个节点显示到父节点的属性中,也就是将指定class中的指定属性,在这个class元素节点的属性中显示。
如:<student><name>hoojo</name></student>
设置好后就是这样的结果:<student name=”hoojo”></student>
aliasAttribute是修改属性名称。
3、 在JavaBean中添加Annotation注解进行重命名设置
先看看JavaBean的代码
package com.hoo.entity;import java.util.Arrays;import java.util.Calendar;import java.util.GregorianCalendar;import java.util.List;import com.thoughtworks.xstream.annotations.XStreamAlias;import com.thoughtworks.xstream.annotations.XStreamAsAttribute;import com.thoughtworks.xstream.annotations.XStreamConverter;import com.thoughtworks.xstream.annotations.XStreamImplicit;import com.thoughtworks.xstream.annotations.XStreamOmitField;@XStreamAlias("class")public class Classes {/** 设置属性显示*/@XStreamAsAttribute