android 中XML和对象转换利器Xstream的使用

川长思鸟来 2022-03-25 11:23 652阅读 0赞

XStream框架:

虽说pull dom dom4j等优秀的xml解析工具使用非常广泛,但对于复杂庞大的数据交互来说,使用它们无疑让你倍加痛苦,你可能大部分精力都放在无聊繁琐的解析和拼装上,如果接口稍微改动,更令你有股辞职不相干的冲动,或许你更倾向选择JSON,但有时候你还是不得不面对JSON,XML,对象之间的转化的烦恼,如何用最简单的办法一统混乱的局面,让你全心全意做设计写业务?现在有了XStream,一切将变得美好,永远告别原始手工作坊,让你轻松的享受coding带来的快乐

xStream可以轻易的将Java对象和xml文档相互转换，而且可以修改某个特定的属性和节点名称，而且也支持json的转换；

json-lib这个框架 ,Jackson这个框架， 它们都完美支持JSON，但是对xml的支持还不是很好。一定程度上限制了对Java对象的描述，不能让xml完全体现到对Java对象的描述。这里将会介绍xStream对JSON、XML的完美支持。xStream不仅对XML的转换非常友好，而且提供annotation注解，可以在JavaBean中完成对xml节点、属性的描述。以及对JSON也支持，只需要提供相关的JSONDriver就可以完成转换。

一.准备环境

首先去 Xstream官方网址 下载最新的jar包,此jar包可以再java和android环境下都适用

二.测试用例代码

  1. package com.hoo.test;
  3. import java.io.IOException;
  5. import java.io.ObjectInputStream;
  7. import java.io.ObjectOutputStream;
  9. import java.io.StringReader;
  11. import java.io.Writer;
  13. import java.util.ArrayList;
  15. import java.util.HashMap;
  17. import java.util.Iterator;
  19. import java.util.List;
  21. import java.util.Map;
  23. import java.util.Set;
  25. import org.codehaus.jettison.json.JSONException;
  27. import org.junit.After;
  29. import org.junit.Before;
  31. import org.junit.Test;
  33. import com.hoo.entity.Birthday;
  35. import com.hoo.entity.Classes;
  37. import com.hoo.entity.ListBean;
  39. import com.hoo.entity.Student;
  41. import com.thoughtworks.xstream.XStream;
  43. import com.thoughtworks.xstream.io.HierarchicalStreamWriter;
  45. import com.thoughtworks.xstream.io.json.JettisonMappedXmlDriver;
  47. import com.thoughtworks.xstream.io.json.JsonHierarchicalStreamDriver;
  49. import com.thoughtworks.xstream.io.json.JsonWriter;
  51. /**
  53. * <b>function:</b>Java对象和XML字符串的相互转换
  55. * jar-lib-version: xstream-1.3.1
  57. * @author hoojo
  59. * @createDate Nov 27, 2010 12:15:15 PM
  61. * @file XStreamTest.java
  63. * @package com.hoo.test
  65. * @project WebHttpUtils
  67. * @blog http://blog.csdn.net/IBM_hoojo
  69. * @email hoojo_@126.com
  71. * @version 1.0
  73. */
  75. @SuppressWarnings("unchecked")
  77. public class XStreamTest {
  81.     private XStream xstream = null;
  83.     private ObjectOutputStream  out = null;
  85.     private ObjectInputStream in = null;
  89.     private Student bean = null;
  93.     /**
  95.      * <b>function:</b>初始化资源准备
  97.      * @author hoojo
  99.      * @createDate Nov 27, 2010 12:16:28 PM
  101.      */
  103.     @Before
  105.     public void init() {
  107.         try {
  109.             xstream = new XStream();
  111.             //xstream = new XStream(new DomDriver()); // 需要xpp3 jar
  113.         } catch (Exception e) {
  115.             e.printStackTrace();
  117.         }
  119.         bean = new Student();
  121.         bean.setAddress("china");
  123.         bean.setEmail("jack@email.com");
  125.         bean.setId(1);
  127.         bean.setName("jack");
  129.         Birthday day = new Birthday();
  131.         day.setBirthday("2010-11-22");
  133.         bean.setBirthday(day);
  135.     }
  139.     /**
  141.      * <b>function:</b>释放对象资源
  143.      * @author hoojo
  145.      * @createDate Nov 27, 2010 12:16:38 PM
  147.      */
  149.     @After
  151.     public void destory() {
  153.         xstream = null;
  155.         bean = null;
  157.         try {
  159.             if (out != null) {
  161.                 out.flush();
  163.                 out.close();
  165.             }
  167.             if (in != null) {
  169.                 in.close();
  171.             }
  173.         } catch (IOException e) {
  175.             e.printStackTrace();
  177.         }
  179.         System.gc();
  181.     }
  185.     public final void fail(String string) {
  187.         System.out.println(string);
  189.     }
  193.     public final void failRed(String string) {
  195.         System.err.println(string);
  197.     }
  199. }

通过XStream对象的toXML方法就可以完成Java对象到XML的转换，toXML方法还有2个相同签名的方法，需要传递一个流。然后通过流来完成xml信息的输出。

3、 需要的JavaBean

  1. package com.hoo.entity;
  3. public class Student {
  5.     private int id;
  7.     private String name;
  9.     private String email;
  11.     private String address;
  13.     private Birthday birthday;
  15.     //getter、setter
  17.     public String toString() {
  19.         return this.name + "#" + this.id + "#" + this.address + "#" + this.birthday + "#" + this.email;
  21.     }
  23. }

二、Java转换成XML

1、 JavaBean转换XM

  1. /**
  3. * <b>function:</b>Java对象转换成XML字符串
  5. * @author hoojo
  7. * @createDate Nov 27, 2010 12:19:01 PM
  9. */
  11. @Test
  13. public void writeBean2XML() {
  15.     try {
  17.         fail("------------Bean->XML------------");
  19.         fail(xstream.toXML(bean));
  21.         fail("重命名后的XML");
  23.         //类重命名
  25.         //xstream.alias("account", Student.class);
  27.         //xstream.alias("生日", Birthday.class);
  29.         //xstream.aliasField("生日", Student.class, "birthday");
  31.         //xstream.aliasField("生日", Birthday.class, "birthday");
  33.         //fail(xstream.toXML(bean));
  35.         //属性重命名
  37.         xstream.aliasField("邮件", Student.class, "email");
  39.         //包重命名
  41.         xstream.aliasPackage("hoo", "com.hoo.entity");
  43.         fail(xstream.toXML(bean));
  45.     } catch (Exception e) {
  47.         e.printStackTrace();
  49.     }
  51. }

看结果中的第一份xml内容，是没有经过然后修改或重命名的文档，按照原样输出。文档中的第二份文档的package经过重命名，email属性也经过重命名以及类名也可以进行重命名的。

运行后结果如下：

  1. ------------Bean->XML------------
  3. <com.hoo.entity.Student>
  5.   <id>1</id>
  7.   <name>jack</name>
  9.   <email>jack@email.com</email>
  11.   <address>china</address>
  13.   <birthday>
  15.     <birthday>2010-11-22</birthday>
  17.   </birthday>
  19. </com.hoo.entity.Student>
  21. 重命名后的XML
  23. <hoo.Student>
  25.   <id>1</id>
  27.   <name>jack</name>
  29.   <邮件>jack@email.com</邮件>
  31.   <address>china</address>
  33.   <birthday>
  35.     <birthday>2010-11-22</birthday>
  37.   </birthday>
  39. </hoo.Student>

2、 将List集合转换成xml文档

  1. /**
  3. * <b>function:</b>将Java的List集合转换成XML对象
  5. * @author hoojo
  7. * @createDate Nov 27, 2010 12:20:07 PM
  9. */
  11. @Test
  13. public void writeList2XML() {
  15.     try {
  17.         //修改元素名称
  19.         xstream.alias("beans", ListBean.class);
  21.         xstream.alias("student", Student.class);
  23.         fail("----------List-->XML----------");
  25.         ListBean listBean = new ListBean();
  27.         listBean.setName("this is a List Collection");
  31.         List<Object> list = new ArrayList<Object>();
  33.         list.add(bean);
  35.         list.add(bean);//引用bean
  37.         //list.add(listBean);//引用listBean，父元素
  41.         bean = new Student();
  43.         bean.setAddress("china");
  45.         bean.setEmail("tom@125.com");
  47.         bean.setId(2);
  49.         bean.setName("tom");
  51.         Birthday day = new Birthday("2010-11-22");
  53.         bean.setBirthday(day);
  57.         list.add(bean);
  59.         listBean.setList(list);
  63.         //将ListBean中的集合设置空元素，即不显示集合元素标签
  65.         //xstream.addImplicitCollection(ListBean.class, "list");
  69.         //设置reference模型
  71.         //xstream.setMode(XStream.NO_REFERENCES);//不引用
  73.         xstream.setMode(XStream.ID_REFERENCES);//id引用
  75.         //xstream.setMode(XStream.XPATH_ABSOLUTE_REFERENCES);//绝对路径引用
  79.         //将name设置为父类（Student）的元素的属性
  81.         xstream.useAttributeFor(Student.class, "name");
  83.         xstream.useAttributeFor(Birthday.class, "birthday");
  85.         //修改属性的name
  87.         xstream.aliasAttribute("姓名", "name");
  89.         xstream.aliasField("生日", Birthday.class, "birthday");
  93.         fail(xstream.toXML(listBean));
  95.     } catch (Exception e) {
  97.         e.printStackTrace();
  99.     }
  101. }

上面的代码运行后，结果如下：

  1. ----------List-->XML----------
  3. <beans id="1">
  5.   <name>this is a List Collection</name>
  7.   <list id="2">
  9.     <student id="3" 姓名="jack">
  11.       <id>1</id>
  13.       <email>jack@email.com</email>
  15.       <address>china</address>
  17.       <birthday id="4" 生日="2010-11-22"/>
  19.     </student>
  21.     <student reference="3"/>
  23.     <student id="5" 姓名="tom">
  25.       <id>2</id>
  27.       <email>tom@125.com</email>
  29.       <address>china</address>
  31.       <birthday id="6" 生日="2010-11-22"/>
  33.     </student>
  35.   </list>
  37. </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引用，这个引用了id=3的那个student标签元素；

useAttributeFor是设置某个节点显示到父节点的属性中，也就是将指定class中的指定属性，在这个class元素节点的属性中显示。

如：hoojo

设置好后就是这样的结果：

aliasAttribute是修改属性名称。

3、 在JavaBean中添加Annotation注解进行重命名设置

先看看JavaBean的代码

  1. package com.hoo.entity;
  3. import java.util.Arrays;
  5. import java.util.Calendar;
  7. import java.util.GregorianCalendar;
  9. import java.util.List;
  11. import com.thoughtworks.xstream.annotations.XStreamAlias;
  13. import com.thoughtworks.xstream.annotations.XStreamAsAttribute;
  15. import com.thoughtworks.xstream.annotations.XStreamConverter;
  17. import com.thoughtworks.xstream.annotations.XStreamImplicit;
  19. import com.thoughtworks.xstream.annotations.XStreamOmitField;
  21. @XStreamAlias("class")
  23. public class Classes {
  27.     /*
  29.      * 设置属性显示
  31.      */
  33.     @XStreamAsAttribute
  35. 再分享一下我老师大神的人工智能教程吧。零基础！通俗易懂！风趣幽默！还带黄段子！希望你也加入到我们人工智能的队伍中来！https://blog.csdn.net/jiangjunshow

发表评论

表情：
评论列表 （有 0 条评论，652人围观）

还没有评论，来说两句吧...

相关阅读