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把JavaBean到XML和JSON的转换实现了,而JSON-lib则如其名,功能太显简陋了。要使用XStream,需下载到xstream包,当前版本是1.3.1。然后把xstream-1.x.x.jar添加到项目的Classpath上,可不依赖于其他包。在某些有要求时候才需要用到lib目录中的其他包,下面会提到。
简单说明XStream的使用吧,分为JavaBean -> XML、JavaBean -> JSON两部分内容。在开始例子之前,先定义三个类(都在com.unmi.model包中):
public class Customer {
private int custId;
private String custName;
private List<Order> orders;
//setter/getter 和构造方法略
}
public class Order {
private int orderId;
private String orderName;
private Product[] products;
//setter/getter 和构造方法略
}
public class Product {
private int prodId;
private String prodName;
private double prodPrice;
//setter/getter 和构造方法略
}
Customer/Order/Product,它们之间的关系,依次是一对多、一对多的,为演示目的,分别用了 List 和数组作为聚合属性。
1.JavaBean -> XML
public static void main(String[] args) {
//构造接近实际的 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();
XStream xstream = new XStream(new DomDriver());
String xml = xstream.toXML(customer);//转换成 xml 格式 System.out.println(xml); //输出 xml 字符串
}
代码说明:XStream对象的构造,可无参,或传入某一DomDriver实例,如XppDomDriver、JDomDriver、Dom4JDriver,它们的用途我想不必多说,注意要引入相应的jar包,无参或DomDriver则是用JDK默认的解析XML的实现。
toXML()还有两个重载方法,分别是:toXML(Objectobj,OutputStreamout)和toXML(Objectobj,Writerout),可用于自定义输出目的地。
来看看上面程序的输出:
<com.unmi.model.Customer> <custId>1</custId> <custName>Unmi</custName> <orders> <com.unmi.model.Order> <orderId>101</orderId> <orderName>电器类</orderName> <products> <com.unmi.model.Product> <prodId>1001</prodId> <prodName>电脑</prodName> <prodPrice>4000.0</prodPrice> </com.unmi.model.Product> <com.unmi.model.Product> <prodId>1002</prodId> <prodName>空调</prodName> <prodPrice>2000.0</prodPrice> </com.unmi.model.Product> </products> </com.unmi.model.Order> </orders> </com.unmi.model.Customer>
应该发现了,节点名用了类的全限名,有些难看,不过我们可以用别名来解决,只要在toXML()之前加上三行代码:
xstream.alias("customer", Customer.class);
xstream.alias("order", Order.class);
xstream.alias("product", Product.class);
执行,再来看看生成的XML内容,漂亮多了吧:<customer>
<custId>1</custId> <custName>Unmi</custName> <orders> <order> <orderId>101</orderId> <orderName>电器类</orderName> <products> <product> <prodId>1001</prodId> <prodName>电脑</prodName> <prodPrice>4000.0</prodPrice> </product> <product> <prodId>1002</prodId> <prodName>空调</prodName> <prodPrice>2000.0</prodPrice> </product> </products> </order> </orders> </customer>
2.JavaBean->JSON
前面main()方法中构造好Customer对象后的代码换成如下:
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()方法,统一了接口方法以,用起来却让人有些费解。
看输出:
{"customer": { "custId": 1, "custName": "Unmi", "orders": [ { "orderId": 101, "orderName": "电器类", "products": [ { "prodId": 1001, "prodName": "电脑", "prodPrice": 4000.0 }, { "prodId": 1002, "prodName": "空调", "prodPrice": 2000.0 } ] } ] }
如果使用的是JettisonMappedXmlDriver,你会看到输出的内容全在一行。
前面用于演示JavaBean到XML和JSON的转换的例子,还稍显复杂,涉及到了List和数组类型。其实XStream是通过反射来获取属性的,即使是私有的,而不依赖于getter方法,这点上比JSON-lib要强。XStream使用了像JDBCDriver的模式,通过更换Driver的方式来达成不同的内部实现。和DWR/Struts一样,它也是用Converter来做到数据类型的转换。
以上介绍JavaBean到XML和JSON的转换,JavaBean未涉及到关联关系。复杂的XStream也做得到,就看前两个例子,XStream能够把复杂的JavaBean生成XML和JSON,它也有这个能耐把生成的东西还原回去的。而且XStream在由XML和JSON生成JavaBean时不依赖于setter方法和构造方法的。
我们在实际中使用XStream时应该还会对它进行细究,或作进一步的扩展,如把某个JavaBean属性生成XML时作为另一属性生成的XML节点的属性,而不是子节点;或加入自己的Converter、甚至是自己的DomDriver、JsonDriver等等。