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