JavaBean到XML和JSON的轉(zhuǎn)換
XML和JSON是當(dāng)今常用的兩種數(shù)據(jù)描述與傳輸?shù)母袷?,特別是涉及到JS時(shí)使用JSON頗為頻繁。自然,在Java的世界里少不了完成JavaBean與這兩種格式相互轉(zhuǎn)換的組件,那就是XStream和JSON-lib。這里我簡(jiǎn)單記下XStream的用法。
其實(shí)相類似的工具早已有之。如果用過(guò)DWR的同志,一定有印像,DWR進(jìn)行遠(yuǎn)程方法調(diào)用時(shí)也能為你完成JavaBean和JSON格式的雙向轉(zhuǎn)換的,所依賴的是它的各種Converter。再要是對(duì)Struts1的細(xì)節(jié)有所注意的話,Struts1的ActionServlet在初始化struts-config.xml時(shí)是通過(guò)commons-digester來(lái)完成XML到JavaBean轉(zhuǎn)換的。相應(yīng)的Apache也有一個(gè)commons-betwixt實(shí)現(xiàn)了JavaBean到XML的生成。
而我這里要說(shuō)的XStream把JavaBean到XML和JSON的轉(zhuǎn)換實(shí)現(xiàn)了,而JSON-lib則如其名,功能太顯簡(jiǎn)陋了。要使用XStream,需下載到xstream包,當(dāng)前版本是1.3.1。然后把xstream-1.x.x.jar添加到項(xiàng)目的Classpath上,可不依賴于其他包。在某些有要求時(shí)候才需要用到lib目錄中的其他包,下面會(huì)提到。
簡(jiǎn)單說(shuō)明XStream的使用吧,分為JavaBean->XML、JavaBean->JSON兩部分內(nèi)容。在開(kāi)始例子之前,先定義三個(gè)類(都在com.unmi.model包中):
- public class Customer {
- private int custId;
- private String custName;
- private List<Order> orders;
- //setter/getter 和構(gòu)造方法略
- }
- public class Order {
- private int orderId;
- private String orderName;
- private Product[] products;
- //setter/getter 和構(gòu)造方法略
- }
- public class Product {
- private int prodId;
- private String prodName;
- private double prodPrice;
- //setter/getter 和構(gòu)造方法略
- }
Customer/Order/Product,它們之間的關(guān)系,依次是一對(duì)多、一對(duì)多的,為演示目的,分別用了 List 和數(shù)組作為聚合屬性。
1.JavaBean -> XML
- public static void main(String[] args) {
- //構(gòu)造接近實(shí)際的 Customer 對(duì)象
- Product p1 = new Product(1001,"電腦",4000);
- Product p2 = new Product(1002,"空調(diào)",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);//轉(zhuǎn)換成 xml 格式
- System.out.println(xml); //輸出 xml 字符串
- }
代碼說(shuō)明:XStream對(duì)象的構(gòu)造,可無(wú)參,或傳入某一DomDriver實(shí)例,如XppDomDriver、JDomDriver、Dom4JDriver,它們的用途我想不必多說(shuō),注意要引入相應(yīng)的jar包,無(wú)參或DomDriver則是用JDK默認(rèn)的解析XML的實(shí)現(xiàn)。
toXML()還有兩個(gè)重載方法,分別是:toXML(Objectobj,OutputStreamout)和toXML(Objectobj,Writerout),可用于自定義輸出目的地。
來(lái)看看上面程序的輸出:
- <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>空調(diào)</prodName>
- <prodPrice>2000.0</prodPrice>
- </com.unmi.model.Product>
- </products>
- </com.unmi.model.Order>
- </orders>
- </com.unmi.model.Customer>
應(yīng)該發(fā)現(xiàn)了,節(jié)點(diǎn)名用了類的全限名,有些難看,不過(guò)我們可以用別名來(lái)解決,只要在toXML()之前加上三行代碼:
- xstream.alias("customer", Customer.class);
- xstream.alias("order", Order.class);
- xstream.alias("product", Product.class);
執(zhí)行,再來(lái)看看生成的XML內(nèi)容,漂亮多了吧:
- <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>空調(diào)</prodName>
- <prodPrice>2000.0</prodPrice>
- </product>
- </products>
- </order>
- </orders>
- </customer>
2.JavaBean->JSON
前面main()方法中構(gòu)造好Customer對(duì)象后的代碼換成如下:
- 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));
代碼說(shuō)明:這里對(duì)于XStream實(shí)例只是構(gòu)造時(shí)換成了JsonHierarchicalStreamDriver實(shí)例,也可以用JettisonMappedXmlDriver(需要引入jettison-1.x.x.jar包)。別名機(jī)制與前面的情況是一樣的。仍然用toXML()方法,沒(méi)有toJSON()方法,統(tǒng)一了接口方法以,用起來(lái)卻讓人有些費(fèi)解。
看輸出:
- {"customer": {
- "custId": 1,
- "custName": "Unmi",
- "orders": [
- {
- "orderId": 101,
- "orderName": "電器類",
- "products": [
- {
- "prodId": 1001,
- "prodName": "電腦",
- "prodPrice": 4000.0
- },
- {
- "prodId": 1002,
- "prodName": "空調(diào)",
- "prodPrice": 2000.0
- }
- ]
- }
- ]
- }
- }
如果使用的是JettisonMappedXmlDriver,你會(huì)看到輸出的內(nèi)容全在一行。
前面用于演示JavaBean到XML和JSON的轉(zhuǎn)換的例子,還稍顯復(fù)雜,涉及到了List和數(shù)組類型。其實(shí)XStream是通過(guò)反射來(lái)獲取屬性的,即使是私有的,而不依賴于getter方法,這點(diǎn)上比JSON-lib要強(qiáng)。XStream使用了像JDBCDriver的模式,通過(guò)更換Driver的方式來(lái)達(dá)成不同的內(nèi)部實(shí)現(xiàn)。和DWR/Struts一樣,它也是用Converter來(lái)做到數(shù)據(jù)類型的轉(zhuǎn)換。
以上介紹JavaBean到XML和JSON的轉(zhuǎn)換,JavaBean未涉及到關(guān)聯(lián)關(guān)系。復(fù)雜的XStream也做得到,就看前兩個(gè)例子,XStream能夠把復(fù)雜的JavaBean生成XML和JSON,它也有這個(gè)能耐把生成的東西還原回去的。而且XStream在由XML和JSON生成JavaBean時(shí)不依賴于setter方法和構(gòu)造方法的。
我們?cè)趯?shí)際中使用XStream時(shí)應(yīng)該還會(huì)對(duì)它進(jìn)行細(xì)究,或作進(jìn)一步的擴(kuò)展,如把某個(gè)JavaBean屬性生成XML時(shí)作為另一屬性生成的XML節(jié)點(diǎn)的屬性,而不是子節(jié)點(diǎn);或加入自己的Converter、甚至是自己的DomDriver、JsonDriver等等。
原文出處:blogjava 作者:隔葉黃鶯
【編輯推薦】