XStream 用法详解 java 类与 XML 互换

最近要用到XML和VO的转换，花半天研究了下XStream记录一下结果。

首先是例子entity类 Person;

Java代码  

1. <span style="white-space: normal; background-color: #ffffff;">package com.xstream.entity</span>  
2.   
3. import com.thoughtworks.xstream.annotations.XStreamAlias;  
4. import com.thoughtworks.xstream.annotations.XStreamAsAttribute;  
5. import com.thoughtworks.xstream.annotations.XStreamImplicit;  
6.   
7. import java.util.ArrayList;  
8. import java.util.List;  
9.   
10. /** 
11.  * User: Rojer 
12.  * Date: 12-3-1 
13.  * Time: 下午4:58 
14.  * To change this template use File | Settings | File Templates. 
15.  */  
16. //设置Person类在xml中的别名  
17. @XStreamAlias("person")  
18. public class Person {  
19.     //将name设置为XML person 元素的 attribute  
20.     @XStreamAsAttribute()  
21.     private String name;  
22.     private int phoneNuber;  
23.     //将此字段名在XML中去掉  
24.     @XStreamImplicit()  
25.     private List<Address> addresses = new ArrayList<Address>();  
26.   
27.     public List<Address> getAddresses() {  
28.         return addresses;  
29.     }  
30.   
31.     public void setAddresses(List<Address> addresses) {  
32.         this.addresses = addresses;  
33.     }  
34.   
35.     public String getName() {  
36.         return name;  
37.     }  
38.   
39.     public void setName(String name) {  
40.         this.name = name;  
41.     }  
42.   
43.     public int getPhoneNuber() {  
44.         return phoneNuber;  
45.     }  
46.   
47.     public void setPhoneNuber(int phoneNuber) {  
48.         this.phoneNuber = phoneNuber;  
49.     }  
50.   
51.   
52. }  

package com.xstream.entityimport com.thoughtworks.xstream.annotations.XStreamAlias;import com.thoughtworks.xstream.annotations.XStreamAsAttribute;import com.thoughtworks.xstream.annotations.XStreamImplicit;import java.util.ArrayList;import java.util.List;/** * User: Rojer * Date: 12-3-1 * Time: 下午4:58 * To change this template use File | Settings | File Templates. *///设置Person类在xml中的别名@XStreamAlias("person")public class Person {    //将name设置为XML person 元素的 attribute    @XStreamAsAttribute()    private String name;    private int phoneNuber;    //将此字段名在XML中去掉    @XStreamImplicit()    private List<Address> addresses = new ArrayList<Address>();    public List<Address> getAddresses() {        return addresses;    }    public void setAddresses(List<Address> addresses) {        this.addresses = addresses;    }    public String getName() {        return name;    }    public void setName(String name) {        this.name = name;    }    public int getPhoneNuber() {        return phoneNuber;    }    public void setPhoneNuber(int phoneNuber) {        this.phoneNuber = phoneNuber;    }}

   Adress

Java代码  

1. package com.xstream.entity;  
2.   
3. import com.thoughtworks.xstream.annotations.XStreamAlias;  
4.   
5. /** 
6.  * User: Rojer 
7.  * Date: 12-3-1 
8.  * Time: 下午5:00 
9.  * To change this template use File | Settings | File Templates. 
10.  */  
11. @XStreamAlias("address")  
12. public class Address {  
13.     private String street;  
14.     private int houseNo;  
15.   
16.     public String getStreet() {  
17.         return street;  
18.     }  
19.   
20.     public void setStreet(String street) {  
21.         this.street = street;  
22.     }  
23.   
24.     public int getHouseNo() {  
25.         return houseNo;  
26.     }  
27.   
28.     public void setHouseNo(int houseNo) {  
29.         this.houseNo = houseNo;  
30.     }  
31. }  

package com.xstream.entity;import com.thoughtworks.xstream.annotations.XStreamAlias;/** * User: Rojer * Date: 12-3-1 * Time: 下午5:00 * To change this template use File | Settings | File Templates. */@XStreamAlias("address")public class Address {    private String street;    private int houseNo;    public String getStreet() {        return street;    }    public void setStreet(String street) {        this.street = street;    }    public int getHouseNo() {        return houseNo;    }    public void setHouseNo(int houseNo) {        this.houseNo = houseNo;    }}

 测试类

Java代码  

1. package com.xstream.test;  
2.   
3. import com.thoughtworks.xstream.XStream;  
4. import com.thoughtworks.xstream.annotations.XStreamAlias;  
5. import com.thoughtworks.xstream.io.xml.Dom4JDriver;  
6. import com.thoughtworks.xstream.io.xml.DomDriver;  
7. import com.thoughtworks.xstream.io.xml.StaxDriver;  
8. import com.xstream.entity.Address;  
9. import com.xstream.entity.Person;  
10. import org.xmlpull.mxp1.MXParser;  
11.   
12. import java.io.ObjectInputStream;  
13. import java.io.StringReader;  
14.   
15. /** 
16.  * User: Rojer 
17.  * Date: 12-3-1 
18.  * Time: 下午4:48 
19.  * To change this template use File | Settings | File Templates. 
20.  */  
21. public class TestStream {  
22.       
23.     public static void main(String[] args) {  
24.         String res=toXML();  
25.         toEntity(res);  
26.     }  
27.       
28.     public static void toEntity(String inputXML){  
29.         XStream xs = new XStream();  
30. //        这句和@XStreamAlias("person")等效  
31. //        xs.alias("person",Person.class);  
32. //        xs.alias("address",Address.class);  
33.         xs.setMode(XStream.NO_REFERENCES);  
34. //      这句和@XStreamImplicit()等效  
35. //        xs.addImplicitCollection(Person.class,"addresses");  
36. //        这句和@XStreamAsAttribute()  
37. //        xs.useAttributeFor(Person.class, "name");  
38.         //注册使用了注解的VO  
39.         xs.processAnnotations(new Class[]{Person.class,Address.class});  
40.         Person person = (Person)xs.fromXML(inputXML);  
41.         System.out.println(person.getAddresses().get(0).getHouseNo()+person.getName());  
42.           
43.   
44.   
45.     }  
46.       
47.     public static String toXML(){  
48.         XStream xStream = new XStream();  
49.         Person person = new Person();  
50.         person.setName("rojer");  
51.         person.setPhoneNuber(999);  
52.         Address address1 = new Address();  
53.         address1.setHouseNo(888);  
54.         address1.setStreet("newyork");  
55.         Address address2 = new Address();  
56.         address2.setHouseNo(76767);  
57.         address2.setStreet("toyo");  
58.         person.getAddresses().add(address1);  
59.         person.getAddresses().add(address2);  
60. //        xStream.alias("person", Person.class);  
61. //        xStream.alias("address",Address.class);  
62.         xStream.setMode(XStream.NO_REFERENCES);  
63. //        xStream.addImplicitCollection(Person.class, "addresses");  
64. //        xStream.useAttributeFor(Person.class,"name");  
65.         //注册使用了注解的VO  
66.         xStream.processAnnotations(new Class[]{Person.class,Address.class});  
67.         String xml = xStream.toXML(person);  
68.   
69.         System.out.println(xml);  
70.         return xml;  
71.     }  
72. }  

package com.xstream.test;import com.thoughtworks.xstream.XStream;import com.thoughtworks.xstream.annotations.XStreamAlias;import com.thoughtworks.xstream.io.xml.Dom4JDriver;import com.thoughtworks.xstream.io.xml.DomDriver;import com.thoughtworks.xstream.io.xml.StaxDriver;import com.xstream.entity.Address;import com.xstream.entity.Person;import org.xmlpull.mxp1.MXParser;import java.io.ObjectInputStream;import java.io.StringReader;/** * User: Rojer * Date: 12-3-1 * Time: 下午4:48 * To change this template use File | Settings | File Templates. */public class TestStream {        public static void main(String[] args) {        String res=toXML();        toEntity(res);    }        public static void toEntity(String inputXML){        XStream xs = new XStream();//        这句和@XStreamAlias("person")等效//        xs.alias("person",Person.class);//        xs.alias("address",Address.class);        xs.setMode(XStream.NO_REFERENCES);//      这句和@XStreamImplicit()等效//        xs.addImplicitCollection(Person.class,"addresses");//        这句和@XStreamAsAttribute()//        xs.useAttributeFor(Person.class, "name");        //注册使用了注解的VO        xs.processAnnotations(new Class[]{Person.class,Address.class});        Person person = (Person)xs.fromXML(inputXML);        System.out.println(person.getAddresses().get(0).getHouseNo()+person.getName());            }        public static String toXML(){        XStream xStream = new XStream();        Person person = new Person();        person.setName("rojer");        person.setPhoneNuber(999);        Address address1 = new Address();        address1.setHouseNo(888);        address1.setStreet("newyork");        Address address2 = new Address();        address2.setHouseNo(76767);        address2.setStreet("toyo");        person.getAddresses().add(address1);        person.getAddresses().add(address2);//        xStream.alias("person", Person.class);//        xStream.alias("address",Address.class);        xStream.setMode(XStream.NO_REFERENCES);//        xStream.addImplicitCollection(Person.class, "addresses");//        xStream.useAttributeFor(Person.class,"name");        //注册使用了注解的VO        xStream.processAnnotations(new Class[]{Person.class,Address.class});        String xml = xStream.toXML(person);        System.out.println(xml);        return xml;    }}

 测试结果如下

Xml代码  

1. <person name="rojer">  
2.   <phoneNuber>999</phoneNuber>  
3.   <address>  
4.     <street>newyork</street>  
5.     <houseNo>888</houseNo>  
6.   </address>  
7.   <address>  
8.     <street>toyo</street>  
9.     <houseNo>76767</houseNo>  
10.   </address>  
11. </person>  
12. 888rojer  

<person name="rojer">  <phoneNuber>999</phoneNuber>  <address>    <street>newyork</street>    <houseNo>888</houseNo>  </address>  <address>    <street>toyo</street>    <houseNo>76767</houseNo>  </address></person>888rojer

 如果去掉Person类的@XStreamImplicit()注解，生成的XML如下

Xml代码  

1. <person name="rojer">  
2.   <phoneNuber>999</phoneNuber>  
3.   <addresses>  
4.     <address>  
5.       <street>newyork</street>  
6.       <houseNo>888</houseNo>  
7.     </address>  
8.     <address>  
9.       <street>toyo</street>  
10.       <houseNo>76767</houseNo>  
11.     </address>  
12.   </addresses>  
13. </person>  
14. 888rojer  

<person name="rojer">  <phoneNuber>999</phoneNuber>  <addresses>    <address>      <street>newyork</street>      <houseNo>888</houseNo>    </address>    <address>      <street>toyo</street>      <houseNo>76767</houseNo>    </address>  </addresses></person>888rojer

 其字段addresses 会被写入到XML中。