`

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

    博客分类:
  • XML
阅读更多

摘要:  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>电脑</prodName>  
  12.           <prodPrice>4000.0</prodPrice>  
  13.         </com.unmi.model.Product>  
  14.         <com.unmi.model.Product>  
  15.           <prodId>1002</prodId>  
  16.           <prodName>空调</prodName>  
  17.           <prodPrice>2000.0</prodPrice>  
  18.         </com.unmi.model.Product>  
  19.       </products>  
  20.     </com.unmi.model.Order>  
  21.   </orders>  
  22. </com.unmi.model.Customer>  

 应该发现了,节点名用了类的全限名,有些难看,不过我们可以用别名来解决,只要在 toXML() 之前加上三行代码:

  1. xstream.alias("customer", Customer.class);   
  2. xstream.alias("order", Order.class);   
  3. xstream.alias("product", Product.class);  

执行,再来看看生成的 XML 内容,漂亮多了吧:

  1. <customer>  
  2.   <custId>1</custId>  
  3.   <custName>Unmi</custName>  
  4.   <orders>  
  5.     <order>  
  6.       <orderId>101</orderId>  
  7.       <orderName>电器类</orderName>  
  8.       <products>  
  9.         <product>  
  10.           <prodId>1001</prodId>  
  11.           <prodName>电脑</prodName>  
  12.           <prodPrice>4000.0</prodPrice>  
  13.         </product>  
  14.         <product>  
  15.           <prodId>1002</prodId>  
  16.           <prodName>空调</prodName>  
  17.           <prodPrice>2000.0</prodPrice>  
  18.         </product>  
  19.       </products>  
  20.     </order>  
  21.   </orders>  
  22. </customer>  

2. JavaBean - > JSON

前面 main() 方法中构造好 Customer 对象后的代码换成如下:

  1. XStream xstream = new XStream(new JsonHierarchicalStreamDriver());   
  2. xstream.alias("customer", Customer.class);   
  3. xstream.alias("order", Order.class);   
  4. xstream.alias("product", Product.class);   
  5. xstream.toXML(customer, new PrintWriter(System.out));  

代码说明:这里对于 XStream 实例只是构造时换成了 JsonHierarchicalStreamDriver 实例,也可以用 JettisonMappedXmlDriver(需要引入 jettison-1.x.x.jar 包)。别名机制与前面的情况是一样的。仍然用 toXML() 方法,没有 toJSON() 方法,统一了接口方法以,用起来却让人有些费解。

看输出:

  1. {"customer": {   
  2.   "custId": 1,   
  3.   "custName": "Unmi",   
  4.   "orders": [   
  5.     {   
  6.       "orderId": 101,   
  7.       "orderName": "电器类",   
  8.       "products": [   
  9.         {   
  10.           "prodId": 1001,   
  11.           "prodName": "电脑",   
  12.           "prodPrice": 4000.0   
  13.         },   
  14.         {   
  15.           "prodId": 1002,   
  16.           "prodName": "空调",   
  17.           "prodPrice": 2000.0   
  18.         }   
  19.       ]   
  20.     }   
  21.   ]   
  22. }}  

如果使用的是 JettisonMappedXmlDriver,你会看到输出的内容全在一行。

前面用于演示 JavaBean 到 XML/JSON 的转换的例子,还稍显复杂,涉及到了 List 和数组类型。其实 XStream 是通过反射来获取属性的,即使是私有的,而不依赖于 getter 方法,这点上比JSON-lib 要强。XStream 使用了像 JDBC Driver 的模式,通过更换 Driver 的方式来达成不同的内部实现。和 DWR/Struts 一样,它也是用 Converter 来做到数据类型的转换。



3. XML -> JavaBean

  1. public static void main(String[] args) {   
  2.            
  3.     XStream xstream = new XStream(new DomDriver());   
  4.        
  5.     //设置了这个别名才能识别下面 xml 中的 product 节点,否则要用类全限名称   
  6.     xstream.alias("product", Product.class);   
  7.     String xml = "<product><prodId>1001</prodId><prodName>电脑" +   
  8.             "</prodName><prodPrice>4000.0</prodPrice></product>";   
  9.     Product prod = (Product)xstream.fromXML(xml);   
  10.     System.out.println(prod.getProdName());   
  11. }  


执行上面的程序,能够输出产品名称“电脑”来,说明,由 XML 描述创建对象是成功的。相对于生成 XML 用的是 toXML(),通过 XML 构建对象用的方法是 fromXML(),同样要留意它的其他重载方法:

  1. Object fromXML(InputStream input);   
  2. Object fromXML(InputStream xml, Object root);   
  3. Object fromXML(Reader xml);   
  4. Object fromXML(Reader xml, Object root);   
  5. Object fromXML(String xml);   
  6. Object fromXML(String xml, Object root);  

它们能从不同的输入源,可指定根节点来构建对象。



4. JSON -> JavaBean

  1. public static void main(String[] args) {   
  2.     // 这里不能用 JsonHierarchicalStreamDriver 了,它只能用于 JavaBean->JSON   
  3.     XStream xstream = new XStream(new JettisonMappedXmlDriver());   
  4.   
  5.     // 设置了这个别名才能识别下面 xml 中的 product 节点,否则要用类全限名称   
  6.     xstream.alias("product", Product.class);   
  7.     String json = "{product:{prodId: 1001,prodName: '电脑', prodPrice: 4000.0}}";   
  8.     Product prod = (Product) xstream.fromXML(json);   
  9.     System.out.println(prod.getProdName());   
  10. }  


可以看到也输出了“电脑”,说明工作正常。注意这里只能用 JettisonMappedXmlDriver。

相比于 JavaBean 到 XML/JSON 的转换,下面两个例子要简单多了,JavaBean 未涉及到关联关系。复杂的 XStream 也做得到,就看前两个例子,XStream 能够把复杂的 JavaBean 生成 XML/JSON,它也有这个能耐把生成的东西还原回去的。而且 XStream 在由 XML/JSON 生成 JavaBean 时不依赖于 setter 方法和构造方法的。

我们在实际中使用 XStream 时应该还会对它进行细究,或作进一步的扩展,如加入自己的 Converter、甚至是自己的 DomDriver、JsonDriver。

 

转自:http://wangzl2222.iteye.com/blog/645361

分享到:
评论

相关推荐

    XStream在JavaBean与XML/JSON 之间相互转换

    NULL 博文链接:https://kingxss.iteye.com/blog/1037741

    xml解析及使用XStream实现javaBean与xml之间的转换

    一个小demo展示xml的两种解析方式和四种解析方法,以及使用XStream进行javaBean与xml、json之间的转换

    JavaBean-xml-Json转换

    XStream示例代码,JavaBean与XML,JSON之间互相转换(包含完整jar包)jettison-1.3.3.jar、xmlpull-1.1.3.1.jar、xstream-1.4.7.jar

    xstream实现实体类序列化转xml

    xstream-1.4.2.jar,xpp3_min-1.1.4.jar,xmlpull-1.1.3.1.jar 包括 //XML --&gt; JavaBean, //XML --&gt; JavaBean //JavaBean --&gt; JSON,//JSON--&gt; JavaBean

    Xstream操作Xml与Json.doc

    本文档主要讲述的是Xstream操作Xml与Json;Xstream是一种OXMapping 技术,是用来处理XML文件序列化的框架,在将JavaBean序列化,或将XML文件反序列化的时候,不需要其它辅助类和映射文件,使得XML序列化不再繁索。...

    XStream示例(包含完整jar包)

    XStream示例代码,JavaBean与XML,JSON之间互相转换(包含完整jar包)jettison-1.3.3.jar、xmlpull-1.1.3.1.jar、xstream-1.4.7.jar

    XStream示例(含jar包)

    XStream示例,JavaBean与XML,JSON之间互相转换(含jar包) jettison-1.3.3.jar、xmlpull-1.1.3.1.jar、xstream-1.4.7.jar

    XStream所需jar包

    Xstream是一种OXMapping 技术,是用来处理XML文件序列化的框架,在将JavaBean序列化,或将XML文件反序列化的时候,不需要其它辅助类和映射文件,使得...Xstream也可以将JavaBean序列化成Json或反序列化,使用非常方便。

    基于Java的XML解析与反射设计模式.doc

    所以在读取大型xml时可以把 xstream与saxparser结合起来使用,用saxparser读取整个xml把核心数据部分让xstrea m来解析成javabean,这样既解决了大数据的问题又利用了xstream快速转化javabean的 优点。 为了利于多...

    xStream解析工具包

    Xstream是一种OXMapping 技术,是用来处理XML文件序列化的框架,在将JavaBean序列化,或将XML文件反序列化的时候,不需要其它辅助类和映射文件,使得...Xstream也可以将JavaBean序列化成Json或反序列化,使用非常方便。

    xstream-1.4.4.jar

    javaBean转json,javaBean装XML 附带我的测试Dome一并奉上

    Spring.3.x企业应用开发实战(完整版).part2

    第14章 使用OXM进行对象XML映射 14.1 认识XML解析技术 14.1.1 什么是XML 14.1.2 XML的处理技术 14.2 XML处理利器:XStream 14.2.1 XStream概述 14.2.2 快速入门 14.2.3 使用XStream别名 14.2.4 XStream转换器 14.2.5...

    Spring3.x企业应用开发实战(完整版) part1

    第14章 使用OXM进行对象XML映射 14.1 认识XML解析技术 14.1.1 什么是XML 14.1.2 XML的处理技术 14.2 XML处理利器:XStream 14.2.1 XStream概述 14.2.2 快速入门 14.2.3 使用XStream别名 14.2.4 XStream转换器 14.2.5...

Global site tag (gtag.js) - Google Analytics