JavaBean到XML和JSON的轉換

作者：隔葉黃鶯 2009-08-13 09:33:07

本文介紹JavaBean到XML和JSON的轉換，使用XStream時應該還會對它進行細究，或作進一步的擴展，如把某個JavaBean屬性生成XML時作為另一屬性生成的XML節點的屬性，而不是子節點。

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等等。

原文出處：blogjava 作者：隔葉黃鶯

【編輯推薦】

JSP實例詳解JavaBean應用步驟
詳解JSP中調用JavaBean
JSP Servlet JavaBean在jdk6.0 Tomcat6.0下的構建
構造JSP JavaBean開發和發布環境簡介
JSP+JavaBean+Servlet結構工作原理淺析

責任編輯：佚名來源： blogjava

JavaBean到XML和JSON的轉換