日期:2014-05-16  浏览次数:20543 次

使用 XStream实现JavaBean 与 XML/JSON 之间相互换

摘要:??XML和JSON是当今常用的两种数据描述与传输的格式,特别是涉及到JS时使用JSON颇为频繁。自然,在Java的世界里少不了完成JavaBean与这两种格式相互转换的组件,那就是XStream和JSON-lib。...


XML 和 JSON 是当今常用的两种数据描述与传输的格式,特别是涉及到 JS 时使用 JSON 颇为频繁。自然,在 Java? 的世界里少不了完成 JavaBean 与这两种格式相互转换的组件,那就是 XStream 和 JSON-lib。这里我简单记下 XStream? 的用法。

其实相类似的工具早已有之。如果用过 DWR 的同志,一定有印像,DWR 进行远程方法调用时也能为你完成 JavaBean 和 JSON 格式的双向转换的,所依赖的是它的各种 Converter。再要是对 Struts1 的细节有所注意的话,Struts1 的 ActionServlet 在初始化 struts-config.xml 时是通过 commons-digester 来完成 XML 到 JavaBean 转换的。相应的 Apache 也有一个 commons-betwixt 实现了 JavaBean 到 XML 的生成。

而我这里要说的 XStream(http://xstream.codehaus.org) 把 JavaBean 与 XML/JSON 间的双向转换统统实现了,而 JSON-lib 则如其名,功能太显简陋了。要使用 XStream,需下载到 xstream包,当前版本是 1.3.1。然后把 xstream-1.x.x.jar 添加到项目的 Classpath 上,可不依赖于其他包。在某些有要求时候才需要用到 lib 目录中的其他包,下面会提到。

简单说明 XStream 的使用吧,分为?JavaBean -> XML、JavaBean -> JSON、?XML -> JavaBean、JSON -> JavaBean 几部分内容。在开始例子之前,先定义三个类(都在 com.unmi.model 包中):

  1. public?class?Customer?{ ??
  2. ????private?int?custId; ??
  3. ????private?String?custName; ??
  4. ????private?List<Order>?orders; ??
  5. ????//setter/getter?和构造方法略 ??
  6. } ??
  7. ??
  8. public?class?Order?{ ??
  9. ????private?int?orderId; ??
  10. ????private?String?orderName; ??
  11. ????private?Product[]?products; ??
  12. ????//setter/getter?和构造方法略 ??
  13. } ??
  14. ??
  15. public?class?Product?{ ??
  16. ????private?int?prodId; ??
  17. ????private?String?prodName; ??
  18. ????private?double?prodPrice; ??
  19. ????//setter/getter?和构造方法略 ??
  20. }??

Customer/Order/Product,它们之间的关系,依次是一对多、一对多的,为演示目的,分别用了 List 和数组作为聚合属性。

1. JavaBean -> XML

  1. public?static?void?main(String[]?args)?{ ??
  2. ???? ??
  3. ????//构造接近实际的?Customer?对象 ??
  4. ????Product?p1?=?new?Product(1001,"电脑",4000); ??
  5. ????Product?p2?=?new?Product(1002,"空调",2000); ??
  6. ????Product[]?prods1?=?new?Product[]{p1,p2}; ??
  7. ???? ??
  8. ????Order?order1?=?new?Order(101,"电器类",prods1); ??
  9. ???? ??
  10. ????List<Order>?orders?=?new?ArrayList<Order>(); ??
  11. ????orders.add(order1);? ??
  12. ????Customer?customer?=?new?Customer(1,"Unmi",orders); ??
  13. ???????????? ??
  14. ????//XStream?xstream?=?new?XStream(); ??
  15. ????XStream?xstream?=?new?XStream(new?DomDriver()); ??
  16. ??
  17. ????String?xml?=?xstream.toXML(customer);//转换成?xml?格式 ??
  18. ??
  19. ????System.out.println(xml);?//输出?xml?字符串 ??
  20. }??

代码说明:XStream 对象的构造,可无参,或传入某一 DomDriver 实例,如 XppDomDriver、JDomDriver、Dom4JDriver,它们的用途我想不必多说,注意要引入相应的 jar 包,无参或 DomDriver 则是用 JDK 默认的解析 XML 的实现。

toXML() 还有两个重载方法,分别是:toXML(Object obj, OutputStream out) 和? toXML(Object obj, Writer out),可用于自定义输出目的地。

来看看上面程序的输出:

  1. <com.unmi.model.Customer>??
  2. ??<custId>1</custId>??
  3. ??<custName>Unmi</custName>??
  4. ??<orders>??
  5. ????<com.unmi.model.Order>??
  6. ??????<orderId>101</orderId>??
  7. ??????<orderName>电器类</orderName>??
  8. ??????<products>??
  9. ????????<com.unmi.model.Product>??
  10. ??????????<prodId>1001</prodId>??
  11. ??????????<prodName>电脑</p