XStream使用教程

最新推荐文章于 2021-02-19 16:52:56 发布

GavinYCF

最新推荐文章于 2021-02-19 16:52:56 发布

阅读量2.9k

点赞数 1

分类专栏： XStream

本文链接：https://blog.csdn.net/yucaifu1989/article/details/21545023

版权

XStream 专栏收录该内容

2 篇文章 0 订阅

订阅专栏

XStream教程

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 几部分内容。

相关jar包：xstream-x.x.x.jar , jettison-xxx.jar

创建相关对象类：

public class Product {
   private int prodId;
   private String prodName;
   private double prodPrice;

//getset 和构造方法

}

public class Order {
   private int orderId;
    private String orderName;
    private Product[] products;

//getset 和构造方法

}

public class Customer {
   private int custId;
   private String custName;
   private List<Order> orders;

//getset 和构造方法

}

//测试

package XStreamtest.test;

import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.OutputStream;
import java.io.PrintWriter;
import java.util.ArrayList;
import java.util.List;

import org.junit.Test;

import XStreamtest.vo.Customer;
import XStreamtest.vo.Order;
import XStreamtest.vo.Product;

import com.thoughtworks.xstream.XStream;
import com.thoughtworks.xstream.io.json.JettisonMappedXmlDriver;
import com.thoughtworks.xstream.io.json.JsonHierarchicalStreamDriver;
import com.thoughtworks.xstream.io.xml.DomDriver;

public class TestXStream {

   //javabean转换为xml
   //@Test
   public void beantoxml() throws FileNotFoundException{
       //构造接近实际的 Customer 对象
        Product p1 = new Product(1001,"电脑",4000);
        Product p2 = new Product(1002,"空调",2000);
        Product[] prods1 = new Product[]{p1,p2};

        Order order1 = new Order(101,"电器类",prods1);

        List<Order> orders = new ArrayList<Order>();
        orders.add(order1);
        Customer customer = new Customer(1,"Unmi",orders);

        /*XStream 对象的构造，可无参，或传入某一 DomDriver 实例，如 XppDomDriver、JDomDriver、Dom4JDriver，
         * 它们的用途我想不必多说，注意要引入相应的 jar 包，无参或 DomDriver 则是用 JDK 默认的解析 XML 的实现。
         * */
        //XStream xstream = new XStream();
        XStream xstream = new XStream(new DomDriver());

        //对指定的类对象设置别名   不然类对赢的节点名称会把类的包名全写上
        xstream.alias("customer", Customer.class);
        xstream.alias("order", Order.class);
        xstream.alias("product", Product.class);

        /*
         * javabean转换为xml字符串
         * */
        String xml = xstream.toXML(customer);//转换成 xml 格式
        System.out.println(xml); //输出 xml 字符串

        /*
         * javabean转换为xml以流的方式写到磁盘文件上去
         * */
        OutputStream out=new FileOutputStream("d:/test.xml");
        xstream.toXML(customer,out);

        /*
         * Javabean转换为xml向浏览器写出
         * 这里应该是用response.getPrintWriter()向浏览器写出的
         * */
        PrintWriter wout=new PrintWriter("d:/test2.xml");
        xstream.toXML(customer,wout);

   }

   //javabean转换为JSON
   //@Test
   public void tobeantoJson(){
   //构造接近实际的 Customer 对象
        Product p1 = new Product(1001,"电脑",4000);
        Product p2 = new Product(1002,"空调",2000);
        Product[] prods1 = new Product[]{p1,p2};

        Order order1 = new Order(101,"电器类",prods1);

        List<Order> orders = new ArrayList<Order>();
        orders.add(order1);
        Customer customer = new Customer(1,"Unmi",orders);

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



   /*代码说明：这里对于 XStream 实例只是构造时换成了 JsonHierarchicalStreamDriver 实例，也可以用 JettisonMappedXmlDriver(需要引入 jettison-1.x.x.jar 包)。
   * 别名机制与前面的情况是一样的。仍然用 toXML() 方法，没有 toJSON() 方法，统一了接口方法以，用起来却让人有些费解。
   *如果使用的是 JettisonMappedXmlDriver，你会看到输出的内容全在一行。
       前面用于演示 JavaBean 到 XML/JSON 的转换的例子，还稍显复杂，涉及到了 List 和数组类型。其实 XStream 是通过反射来获取属性的，即使是私有的，而不依赖于 getter 方法，这点上比JSON-lib 要强。
       XStream 使用了像 JDBC Driver 的模式，通过更换 Driver 的方式来达成不同的内部实现。和 DWR/Struts 一样，它也是用 Converter 来做到数据类型的转换。
   */
   }

   //xml转换为javabean
   //@Test
   public void xmltobean(){
       XStream xstream = new XStream(new DomDriver());

        //设置了这个别名才能识别下面 xml 中的 product 节点，否则要用类全限名称
        xstream.alias("product", Product.class);
        String xml = "<product><prodId>1001</prodId><prodName>电脑" +
                "</prodName><prodPrice>4000.0</prodPrice></product>";
        Product prod = (Product)xstream.fromXML(xml);
        /*其他重载方法它们能从不同的输入源，可指定根节点来构建对象
        Object fromXML(InputStream input);
        Object fromXML(InputStream xml, Object root);
        Object fromXML(Reader xml);
        Object fromXML(Reader xml, Object root);
        Object fromXML(String xml);
        Object fromXML(String xml, Object root);
         * */
        System.out.println(prod.getProdName());
   }

   //JSON转换为javaBean
   @Test
   public void jsontobean(){
    try {
           // 这里不能用 JsonHierarchicalStreamDriver 了，它只能用于 JavaBean->JSON
            XStream xstream = new XStream(new JettisonMappedXmlDriver());

            // 设置了这个别名才能识别下面 xml 中的 product 节点，否则要用类全限名称
            xstream.alias("product", Product.class);
            String json = "{product:{prodId: 1001,prodName: '电脑', prodPrice: 4000.0}}";
            Product prod = (Product) xstream.fromXML(json);
            System.out.println(prod.getProdName());
            //可以看到也输出了“电脑”，说明工作正常。注意这里只能用 JettisonMappedXmlDriver 要引入 jettison-1.x.x.jar 包
   } catch (Exception e) {
       e.printStackTrace();
   }

   }
}

方法：