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 幾部分內容。在開始例子之前,先定義三個類(都在 com.unmi.model 包中):
01.public class Customer {
02. private int custId;
03. private String custName;
04. private List<Order> orders;
05. //setter/getter 和構造方法略
06.}
07.
08.public class Order {
09. private int orderId;
10. private String orderName;
11. private Product[] products;
12. //setter/getter 和構造方法略
13.}
14.
15.public class Product {
16. private int prodId;
17. private String prodName;
18. private double prodPrice;
19. //setter/getter 和構造方法略
20.}
Customer/Order/Product,它們之間的關系,依次是一對多、一對多的,為演示目的,分別用了 List 和數組作為聚合屬性。
1. JavaBean -> XML
01.public static void main(String[] args) {
02.
03. //構造接近實際的 Customer 對象
04. Product p1 = new Product(1001,"電腦",4000);
05. Product p2 = new Product(1002,"空調",2000);
06. Product[] prods1 = new Product[]{p1,p2};
07.
08. Order order1 = new Order(101,"電器類",prods1);
09.
10. List<Order> orders = new ArrayList<Order>();
11. orders.add(order1);
12. Customer customer = new Customer(1,"Unmi",orders);
13.
14. //XStream xstream = new XStream();
15. XStream xstream = new XStream(new DomDriver());
16.
17. String xml = xstream.toXML(customer);//轉換成 xml 格式
18.
19. System.out.println(xml); //輸出 xml 字符串
20.}
代碼說明:XStream 對象的構造,可無參,或傳入某一 DomDriver 實例,如 XppDomDriver、JDomDriver、Dom4JDriver,它們的用途我想不必多說,注意要引入相應的 jar 包,無參或 DomDriver 則是用 JDK 默認的解析 XML 的實現。
toXML() 還有兩個重載方法,分別是:toXML(Object obj, OutputStream out) 和 toXML(Object obj, Writer out),可用於自定義輸出目的地。
來看看上面程序的輸出:
01.<com.unmi.model.Customer>
02. <custId>1</custId>
03. <custName>Unmi</custName>
04. <orders>
05. <com.unmi.model.Order>
06. <orderId>101</orderId>
07. <orderName>電器類</orderName>
08. <products>
09. <com.unmi.model.Product>
10. <prodId>1001</prodId>
11. <prodName>電腦</prodName>
12. <prodPrice>4000.0</prodPrice>
13. </com.unmi.model.Product>
14. <com.unmi.model.Product>
15. <prodId>1002</prodId>
16. <prodName>空調</prodName>
17. <prodPrice>2000.0</prodPrice>
18. </com.unmi.model.Product>
19. </products>
20. </com.unmi.model.Order>
21. </orders>
22.</com.unmi.model.Customer>
應該發現了,節點名用了類的全限名,有些難看,不過我們可以用別名來解決,只要在 toXML() 之前加上三行代碼:
1.xstream.alias("customer", Customer.class);
2.xstream.alias("order", Order.class);
3.xstream.alias("product", Product.class);
執行,再來看看生成的 XML 內容,漂亮多了吧:
01.<customer>
02. <custId>1</custId>
03. <custName>Unmi</custName>
04. <orders>
05. <order>
06. <orderId>101</orderId>
07. <orderName>電器類</orderName>
08. <products>
09. <product>
10. <prodId>1001</prodId>
11. <prodName>電腦</prodName>
12. <prodPrice>4000.0</prodPrice>
13. </product>
14. <product>
15. <prodId>1002</prodId>
16. <prodName>空調</prodName>
17. <prodPrice>2000.0</prodPrice>
18. </product>
19. </products>
20. </order>
21. </orders>
22.</customer>
2. JavaBean - > JSON
前面 main() 方法中構造好 Customer 對象後的代碼換成如下:
view source
print?
1.XStream xstream = new XStream(new JsonHierarchicalStreamDriver());
2.xstream.alias("customer", Customer.class);
3.xstream.alias("order", Order.class);
4.xstream.alias("product", Product.class);
5.xstream.toXML(customer, new PrintWriter(System.out));
代碼說明:這裡對於 XStream 實例只是構造時換成了 JsonHierarchicalStreamDriver 實例,也可以用 JettisonMappedXmlDriver(需要引入 jettison-1.x.x.jar 包)。別名機制與前面的情況是一樣的。仍然用 toXML() 方法,沒有 toJSON() 方法,統一了接口方法以,用起來卻讓人有些費解。
看輸出:
01.{"customer": {
02. "custId": 1,
03. "custName": "Unmi",
04. "orders": [
05. {
06. "orderId": 101,
07. "orderName": "電器類",
08. "products": [
09. {
10. "prodId": 1001,
11. "prodName": "電腦",
12. "prodPrice": 4000.0
13. },
14. {
15. "prodId": 1002,
16. "prodName": "空調",
17. "prodPrice": 2000.0
18. }
19. ]
20. }
21. ]
22.}}
如果使用的是 JettisonMappedXmlDriver,你會看到輸出的內容全在一行。
前面用於演示 JavaBean 到 XML/JSON 的轉換的例子,還稍顯復雜,涉及到了 List 和數組類型。其實 XStream 是通過反射來獲取屬性的,即使是私有的,而不依賴於 getter 方法,這點上比JSON-lib 要強。XStream 使用了像 JDBC Driver 的模式,通過更換 Driver 的方式來達成不同的內部實現。和 DWR/Struts 一樣,它也是用 Converter 來做到數據類型的轉換。
3. XML -> JavaBean
01.public static void main(String[] args) {
02.
03. XStream xstream = new XStream(new DomDriver());
04.
05. //設置了這個別名才能識別下面 xml 中的 product 節點,否則要用類全限名稱
06. xstream.alias("product", Product.class);
07. String xml = "<product><prodId>1001</prodId><prodName>電腦" +
08. "</prodName><prodPrice>4000.0</prodPrice></product>";
09. Product prod = (Product)xstream.fromXML(xml);
10. System.out.println(prod.getProdName());
11.}
執行上面的程序,能夠輸出產品名稱“電腦”來,說明,由 XML 描述創建對象是成功的。相對於生成 XML 用的是 toXML(),通過 XML 構建對象用的方法是 fromXML(),同樣要留意它的其他重載方法:
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);
它們能從不同的輸入源,可指定根節點來構建對象。
4. JSON -> JavaBean
01.public static void main(String[] args) {
02. // 這裡不能用 JsonHierarchicalStreamDriver 了,它只能用於 JavaBean->JSON
03. XStream xstream = new XStream(new JettisonMappedXmlDriver());
04.
05. // 設置了這個別名才能識別下面 xml 中的 product 節點,否則要用類全限名稱
06. xstream.alias("product", Product.class);
07. String json = "{product:{prodId: 1001,prodName: '電腦', prodPrice: 4000.0}}";
08. Product prod = (Product) xstream.fromXML(json);
09. System.out.println(prod.getProdName());
10.}
可以看到也輸出了“電腦”,說明工作正常。注意這裡只能用 JettisonMappedXmlDriver。
相比於 JavaBean 到 XML/JSON 的轉換,下面兩個例子要簡單多了,JavaBean 未涉及到關聯關系。復雜的 XStream 也做得到,就看前兩個例子,XStream 能夠把復雜的 JavaBean 生成 XML/JSON,它也有這個能耐把生成的東西還原回去的。而且 XStream 在由 XML/JSON 生成 JavaBean 時不依賴於 setter 方法和構造方法的。
我們在實際中使用 XStream 時應該還會對它進行細究,或作進一步的擴展,如把某個 JavaBean 屬性生成 XML 時作為另一屬性生成的 XML 節點的屬性,而不是子節點;或加入自己的 Converter、甚至是自己的 DomDriver、JsonDriver 等等。