JavaBean到XML和JSON的轉換

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