XStream 用法匯總

        XStream是一家Java對象和XML轉換工具，很好很強大。它提供了所有的基本型、排列、收集和其他類型的支持，直接轉換。因此XML在數據交換經常使用、對象序列化（和Java對象的序列化技術有着本質的差別）。

        XStream對象相當Java對象和XML之間的轉換器，轉換過程是雙向的。

創建XSteam對象的方式非常easy。僅僅須要new XStream()就可以。
              Java到xml。用toXML()方法。  
              Xml到Java，用fromXML()方法。

 

      在沒有不論什么設置默認情況下。java到xml的映射，是java成員名相應xml的元素名。java類的全名相應xml根元素的名字。而實際中，往往是xml和java類都有了，要完畢相互轉換，必須進行別名映射。

別名配置包括三種情況：
1、類別名，用alias(String name, Class type)。
2、類成員別名，用aliasField(String alias, Class definedIn, String fieldName)
3、類成員作為屬性別名。用 aliasAttribute(Class definedIn, String attributeName, String alias)，單獨命名沒有意義。還要通過useAttributeFor(Class definedIn, String fieldName) 應用到某個類上。

別名的配置是非常重要的。可是當中有些細節問題非常重要，在樣例中會專門做具體說明。 

另外還有不太經常使用的方法：
addImplicitCollection(Class ownerType, String fieldName)，去掉集合類型生成xml的父節點。
registerConverter(Converter converter) 。注冊一個轉換器。

假設你的xml非常大。或者為了安全性。以流的方式傳輸，那么XStream也提供豐富的API， 

假設這些主要的操作還不能滿足你應用的需求，XStream提供豐富的擴展點。你能夠實現自己的轉換器。還能夠利用XStream完畢更負責的功能，比方輸出其它非xml格式的數據，還能夠輸出html，還支持XML Dom類型數據，這些應用起來略微復雜些。

當然這些不是XStream應用的重點，也不用理會，真正須要的時候再查看API和源代碼研究研究。

XStream的長處非常多。可是也有一些小bug。比方在定義別名中的下划線“_”轉換為xml后會變成“__”這個符號，非常變態。因此，盡量避免在別名中有用不論什么符號。卻是須要下划線的時候，能夠考慮有用連接符“-”，這個沒有問題。  

另外，我們的Java Bean中，經常有一些常量。在轉換過程，XStream也會將這些常量轉換過去，形成常量的xml節點，這顯然不是想要的結果，對於常量字段，就不做轉換了。

以下給出一個很典型的並且有用的樣例，作為對總結的補充： 

import java.util.List;

public class Person {
	private String name;
	private String age;
	private Profile profile;
	private List<Address> addlist;

	public Person(String name, String age, Profile profile, List<Address> addlist) {
		this.name = name;
		this.age = age;
		this.profile = profile;
		this.addlist = addlist;
	}

	public String toString() {
		return "Person{" + "name='" + name + '\'' + ", age='" + age + '\'' + ", profile=" + profile + ", addlist=" + addlist + '}';
	}

}

public class Profile {
	private String job;
	private String tel;
	private String remark;

	public Profile(String job, String tel, String remark) {
		this.job = job;
		this.tel = tel;
		this.remark = remark;
	}

	public String toString() {
		return "Profile{" + "job='" + job + '\'' + ", tel='" + tel + '\'' + ", remark='" + remark + '\'' + '}';
	}

}

import java.util.List;

public class Person {
	private String name;
	private String age;
	private Profile profile;
	private List<Address> addlist;

	public Person(String name, String age, Profile profile, List<Address> addlist) {
		this.name = name;
		this.age = age;
		this.profile = profile;
		this.addlist = addlist;
	}

	public String toString() {
		return "Person{" + "name='" + name + '\'' + ", age='" + age + '\'' + ", profile=" + profile + ", addlist=" + addlist + '}';
	}

}

import java.util.ArrayList;
import java.util.List;

import com.thoughtworks.xstream.XStream;
import com.thoughtworks.xstream.io.xml.DomDriver;

public class TestXStream {

	public static void main(String args[]) {
		Address address1 = new Address("鄭州市經三路", "450001");
		Address address2 = new Address("北京市海淀區", "100000");
		List<Address> addList = new ArrayList<Address>();
		addList.add(address1);
		addList.add(address2);
		Profile profile = new Profile("軟件project師", "13051594850", "備注說明");
		Person person = new Person("X-rapido", "22", profile, addList);

		// 轉換裝配
		XStream xStream = new XStream(new DomDriver());

		/************** 設置類別名。不設默認類全路徑 ****************/
		xStream.alias("PERSON", Person.class);
		xStream.alias("PROFILE", Profile.class);
		xStream.alias("ADDRESS", Address.class);
		
		String xml = xStream.toXML(person);
		System.out.println("----------------第1次輸出, 設置類別名---------------- \n"+ xml + "\n");

		/************* 設置類成員的別名 ***************/
		// 設置Person類的name成員別名Name
		xStream.aliasField("Name", Person.class, "name");
		/*
		 * [注意] 設置Person類的profile成員別名PROFILE,這個別名和Profile類的別名一致,
		 * 這樣能夠保持XStream對象能夠從profile成員生成的xml片段直接轉換為Profile成員,
		 * 假設成員profile的別名和Profile的別名不一致,則profile成員生成的xml片段不可
		 * 直接轉換為Profile對象,須要又一次創建XStream對象,這豈不給自己找麻煩?
		 */
		xStream.aliasField("PROFILE", Person.class, "profile");
		xStream.aliasField("ADDLIST", Person.class, "addlist");
		xStream.aliasField("Add", Address.class, "add");
		xStream.aliasField("Job", Profile.class, "job");
		
		String xml2 = xStream.toXML(person);
		System.out.println("----------------第2次輸出, 設置類、字段別名---------------- \n"+ xml2 + "\n");

		
		/******* 設置類成員為xml一個元素上的屬性 *******/
		xStream.useAttributeFor(Address.class, "zipcode");
		/************* 設置屬性的別名 ***************/
		xStream.aliasAttribute(Address.class, "zipcode", "Zipcode");
		
		String xml3 = xStream.toXML(person);
		System.out.println("----------------第3次輸出, 設置類、字段別名，並在xml字段節點上添加屬性---------------- \n"+ xml3 + "\n");

		
		/************* 將xml轉為java對象 ******× ****/
		 String person_xml = "<PERSON>\n" +  
			                "  <Name>熔岩</Name>\n" +  
			                "  <age>27</age>\n" +  
			                "  <PROFILE>\n" +  
			                "    <Job>軟件project師</Job>\n" +  
			                "    <tel>13512129933</tel>\n" +  
			                "    <remark>備注說明</remark>\n" +  
			                "  </PROFILE>\n" +  
			                "  <ADDLIST>\n" +  
			                "    <ADDRESS Zipcode=\"450001\">\n" +  
			                "      <Add>鄭州市經三路</Add>\n" +  
			                "    </ADDRESS>\n" +  
			                "    <ADDRESS Zipcode=\"710002\">\n" +  
			                "      <Add>西安市雁塔路</Add>\n" +  
			                "    </ADDRESS>\n" +  
			                "  </ADDLIST>\n" +  
			                "</PERSON>";  
		String profile_xml = "<PROFILE>\n" +  
			                "    <Job>軟件project師</Job>\n" +  
			                "    <tel>13512129933</tel>\n" +  
			                "    <remark>備注說明</remark>\n" +  
			                " </PROFILE>";  
	    String address_xml = "<ADDRESS Zipcode=\"710002\">\n" +  
			                "      <Add>西安市雁塔路</Add>\n" +  
			                " </ADDRESS>";  

		// 相同使用上面的XStream對象將xml轉換為Java對象
		System.out.println(xStream.fromXML(person_xml).toString());
		System.out.println(xStream.fromXML(profile_xml).toString());
		System.out.println(xStream.fromXML(address_xml).toString());
	}
	
}

xStream.toXML()和xStream.fromXML()的經常用法

比方寫入文件方法

FileOutputStream fs = new FileOutputStream("d:/employeedata.txt");
xs.toXML(e, fs);

讀取

public static void main(String[] args) {
	XStream xs = new XStream(new DomDriver());
	Employee e = new Employee();
	try {
		FileInputStream fis = new FileInputStream("d:/employeedata.txt");
		xs.fromXML(fis, e);
		
		// 打印從對象已被讀取的數據
		System.out.println(e.toString());
	} catch (FileNotFoundException ex) {
		ex.printStackTrace();
	}
}

public static void main(String[] args) {
	Employee e = new Employee();
	e.setName("X-rapido");
	e.setDesignation("Manager");
	e.setDepartment("法國");

	XStream xs = new XStream();
	try {
		FileOutputStream fs = new FileOutputStream("d:/employeedata.txt");
		xs.toXML(e, fs);
		
		System.out.println("XML寫入成功");
	} catch (FileNotFoundException e1) {
		e1.printStackTrace();
	}
}

在實際中。類的屬性非常多，嵌套層次也非常復雜。假設只使用XStream原生API來硬編碼設置別名等屬性。顯得太生硬也難以維護。全然能夠考慮通過一個xml配置文件來定義全部用到的類的別名定義（包含其成員），然后，通過讀取配置構建一個XStream的工廠，在用到時候直接去取。而不是讓有用者組裝。

我眼下的一個項目中，就是這么實現的，效果非常的好。

以下我給出針對上面提出的問題一個解決方式：

思想：考慮做一個過濾器，在xml轉java之前。在Java轉xml之后。應用這個過濾器。

這個過濾器提供將xml中的“__”替換為“-”，而且將xml中的不須要的節點剔除。
在過濾之前。我實現了個轉換器裝配，這一步通過xml來配置，並在java中獲取。

代碼就省略了。這一步非常靈活，關鍵看你的應用了。

// 解決XStream對出現雙下划線的bug
XStream xStreamForRequestPostData = new XStream(new DomDriver("UTF-8", new XmlFriendlyNameCoder("-_", "_")));

為了能過濾xml。我們須要用Dom4j遞歸遍歷xml文檔。以下一些算法代碼： 

//遞歸算法：遍歷配置文件，找出全部有效的xpath  
private static void recursiveElement(Element element) {  
    List<Element> elements = element.elements();  
    validXPathList.add(element.getPath());  
    if (elements.size() == 0) {  
        //沒有子元素  
    } else {  
        //有子元素  
        for (Iterator<Element> it = elements.iterator(); it.hasNext();) {  
            //遞歸遍歷  
            recursiveElement(it.next());  
        }  
    }  
}  

//遞歸算法：遍歷xml，標識無效的元素節點  
private static void recursiveFixElement(Element element) {  
    List<Element> elements = element.elements();  
    if (!validXPathList.contains(element.getPath())) {  
        element.addAttribute("delete", "true");  
    }  
    if (elements.size() == 0) {  
        //沒有子元素  
    } else {  
        //有子元素  
        for (Iterator<Element> it = elements.iterator(); it.hasNext();) {  
            Element e = it.next();  
            if (!validXPathList.contains(e.getPath())) {  
                e.addAttribute("delete", "true");  
            }  
            //遞歸遍歷  
            recursiveFixElement(e);  
        }  
    }  
}  

/**  
 * 過濾器接口方法，轉換不規范字符，剔除無效節點  
 *  
 * @param xmlStr 要過濾的xml  
 * @return 符合轉換器要求的xml  
 */  
public static String filter(String xmlStr) {  
    Document document = null;  
    try {  
        document = DocumentHelper.parseText(xmlStr.replaceAll("__", "_"));  
        //遞歸的調用：標記要剔除的xml元素  
        recursiveFixElement(document.getRootElement());       
        List<Node> nodeList = document.selectNodes("//@delete");  
        for (Node node : nodeList) {  
            node.getParent().detach();  //剔除xml元素  
        }  
    } catch (DocumentException e) {  
        System.out.println(e.getMessage());  
        e.printStackTrace();  
    }  
    return document.asXML();  
} 

輸出內容例如以下

----------------第1次輸出, 設置類別名---------------- 
<PERSON>
  <name>X-rapido</name>
  <age>22</age>
  <profile>
    <job>軟件project師</job>
    <tel>13051594850</tel>
    <remark>備注說明</remark>
  </profile>
  <addlist>
    <ADDRESS>
      <add>鄭州市經三路</add>
      <zipcode>450001</zipcode>
    </ADDRESS>
    <ADDRESS>
      <add>北京市海淀區</add>
      <zipcode>100000</zipcode>
    </ADDRESS>
  </addlist>
</PERSON>

----------------第2次輸出, 設置類、字段別名---------------- 
<PERSON>
  <Name>X-rapido</Name>
  <age>22</age>
  <PROFILE>
    <Job>軟件project師</Job>
    <tel>13051594850</tel>
    <remark>備注說明</remark>
  </PROFILE>
  <ADDLIST>
    <ADDRESS>
      <Add>鄭州市經三路</Add>
      <zipcode>450001</zipcode>
    </ADDRESS>
    <ADDRESS>
      <Add>北京市海淀區</Add>
      <zipcode>100000</zipcode>
    </ADDRESS>
  </ADDLIST>
</PERSON>

----------------第3次輸出, 設置類、字段別名，並在xml字段節點上添加屬性---------------- 
<PERSON>
  <Name>X-rapido</Name>
  <age>22</age>
  <PROFILE>
    <Job>軟件project師</Job>
    <tel>13051594850</tel>
    <remark>備注說明</remark>
  </PROFILE>
  <ADDLIST>
    <ADDRESS Zipcode="450001">
      <Add>鄭州市經三路</Add>
    </ADDRESS>
    <ADDRESS Zipcode="100000">
      <Add>北京市海淀區</Add>
    </ADDRESS>
  </ADDLIST>
</PERSON>

Person{name='熔岩', age='27', profile=Profile{job='軟件project師', tel='13512129933', remark='備注說明'}, addlist=[Address{add='鄭州市經三路', zipcode='450001'}, Address{add='西安市雁塔路', zipcode='710002'}]}
Profile{job='軟件project師', tel='13512129933', remark='備注說明'}
Address{add='西安市雁塔路', zipcode='710002'}

轉換裝配方式有幾種，比方上面代碼中使用是DomDriver方式，也有StaxDriver方式，等默認XppDriver方式。可是xpp方式常常解析xml會出錯，比方將上面的代碼改動

// 轉換裝配
// XStream xStream = new XStream(new DomDriver());
   XStream xStream = new XStream(new StaxDriver());

解析的輸出就變成下面結果

----------------第1次輸出, 設置類別名---------------- 
<?xml version="1.0" ?><PERSON><name>X-rapido</name><age>22</age><profile><job>軟件project師</job><tel>13051594850</tel><remark>備注說明</remark></profile><addlist><ADDRESS><add>鄭州市經三路</add><zipcode>450001</zipcode></ADDRESS><ADDRESS><add>北京市海淀區</add><zipcode>100000</zipcode></ADDRESS></addlist></PERSON>

----------------第2次輸出, 設置類、字段別名---------------- 
<?xml version="1.0" ?><PERSON><Name>X-rapido</Name><age>22</age><PROFILE><Job>軟件project師</Job><tel>13051594850</tel><remark>備注說明</remark></PROFILE><ADDLIST><ADDRESS><Add>鄭州市經三路</Add><zipcode>450001</zipcode></ADDRESS><ADDRESS><Add>北京市海淀區</Add><zipcode>100000</zipcode></ADDRESS></ADDLIST></PERSON>

----------------第3次輸出, 設置類、字段別名，並在xml字段節點上添加屬性---------------- 
<?xml version="1.0" ?><PERSON><Name>X-rapido</Name><age>22</age><PROFILE><Job>軟件project師</Job><tel>13051594850</tel><remark>備注說明</remark></PROFILE><ADDLIST><ADDRESS Zipcode="450001"><Add>鄭州市經三路</Add></ADDRESS><ADDRESS Zipcode="100000"><Add>北京市海淀區</Add></ADDRESS></ADDLIST></PERSON>

Person{name='熔岩', age='27', profile=Profile{job='軟件project師', tel='13512129933', remark='備注說明'}, addlist=[Address{add='鄭州市經三路', zipcode='450001'}, Address{add='西安市雁塔路', zipcode='710002'}]}
Profile{job='軟件project師', tel='13512129933', remark='備注說明'}
Address{add='西安市雁塔路', zipcode='710002'}

Java轉換JSON

xStream對JSON也有很好的支持。它提供了2個模型驅動。

用這2個驅動能夠完畢Java對象到JSON的相互轉換。使用JettisonMappedXmlDriver驅動，將Java對象轉換成json，須要加入jettison.jar。JSON的轉換和XML的轉換使用方法一樣。僅僅是創建XStream須要傳遞一個參數，這個參數就是xml到JSON映射轉換的驅動。

這里會講到兩個驅動，各自是JettisonMappedXmlDriver、JsonHierarchicalStreamDriver。

1、 用JettisonMappedXmlDriver轉換

public static void main(String args[]) {
	Address address1 = new Address("鄭州市經三路", "450001");
	Address address2 = new Address("北京市海淀區", "100000");
	List<Address> addList = new ArrayList<Address>();
	addList.add(address1);
	addList.add(address2);
	Profile profile = new Profile("軟件project師", "13051594850", "備注說明");
	Person person = new Person("X-rapido", "22", profile, addList);

	XStream xStreamJ = new XStream(new JettisonMappedXmlDriver());
	xStreamJ.setMode(XStream.NO_REFERENCES);
	
	xStreamJ.alias("person", Person.class);
	xStreamJ.alias("profile", Profile.class);
	xStreamJ.alias("address", Address.class);
	
	String xml = xStreamJ.toXML(person);
	System.out.println("JSON："+ xml);
}

{"person":{"name":"X-rapido","age":22,"profile":{"job":"軟件project師","tel":13051594850,"remark":"備注說明"},"addlist":[{"address":[{"add":"鄭州市經三路","zipcode":450001},{"add":"北京市海淀區","zipcode":100000}]}]}}

2、 用JsonHierarchicalStreamDriver轉換

public static void main(String args[]) {
	Address address1 = new Address("鄭州市經三路", "450001");
	Address address2 = new Address("北京市海淀區", "100000");
	List<Address> addList = new ArrayList<Address>();
	addList.add(address1);
	addList.add(address2);
	Profile profile = new Profile("軟件project師", "13051594850", "備注說明");
	Person person = new Person("X-rapido", "22", profile, addList);
	
	XStream xStreamJ = new XStream(new JsonHierarchicalStreamDriver());
	
	xStreamJ.alias("person", Person.class);
	xStreamJ.alias("profile", Profile.class);
	xStreamJ.alias("address", Address.class);
	
	String xml = xStreamJ.toXML(person);
	System.out.println("JSON："+ xml);
}

JSON：{"person": {
  "name": "X-rapido",
  "age": "22",
  "profile": {
    "job": "軟件project師",
    "tel": "13051594850",
    "remark": "備注說明"
  },
  "addlist": [
    {
      "add": "鄭州市經三路",
      "zipcode": "450001"
    },
    {
      "add": "北京市海淀區",
      "zipcode": "100000"
    }
  ]
}}

使用JsonHierarchicalStreamDriver轉換默認會給轉換后的對象加入一個根節點，可是在構建JsonHierarchicalStreamDriver驅動的時候。你能夠重寫createWriter方法，刪掉根節點。

看上面的結果，一個是默認帶根節點的JSON對象，它僅僅是將類名作為一個屬性。將對象作為該屬性的一個值。而還有一個沒有帶根屬性的JSON就是通過重寫createWriter方法完畢的。

添加上面代碼。返回沒有根節點JSON

 //刪除根節點
xStreamJ = new XStream(new JsonHierarchicalStreamDriver() {
    public HierarchicalStreamWriter createWriter(Writer out) {
        return new JsonWriter(out, JsonWriter.DROP_ROOT_MODE);
    }
});

JSON：{
  "name": "X-rapido",
  "age": "22",
  "profile": {
    "job": "軟件project師",
    "tel": "13051594850",
    "remark": "備注說明"
  },
  "addlist": [
    {
      "add": "鄭州市經三路",
      "zipcode": "450001"
    },
    {
      "add": "北京市海淀區",
      "zipcode": "100000"
    }
  ]
}

將JSON轉換java對象

	public static void main(String args[]) {
		Address address1 = new Address("鄭州市經三路", "450001");
		Address address2 = new Address("北京市海淀區", "100000");
		List<Address> addList = new ArrayList<Address>();
		addList.add(address1);
		addList.add(address2);
		Profile profile = new Profile("軟件project師", "13051594850", "備注說明");
		Person person = new Person("X-rapido", "22", profile, addList);
		
		String json = "{\"person\":{\"name\":\"X-rapido\",\"age\":22,\"profile\":{\"job\":\"軟件project師\",\"tel\":13051594850,\"remark\":\"備注說明\"},\"addlist\":[{\"address\":[{\"add\":\"鄭州市經三路\",\"zipcode\":450001},{\"add\":\"北京市海淀區\",\"zipcode\":100000}]}]}}";
		XStream xStreamJ = new XStream(new JettisonMappedXmlDriver());
		
		xStreamJ.alias("person", Person.class);
		xStreamJ.alias("profile", Profile.class);
		xStreamJ.alias("address", Address.class);
		
		person = (Person) xStreamJ.fromXML(json);
		System.out.println(person.toString());
	}
	

Person{name='X-rapido', age='22', profile=Profile{job='軟件project師', tel='13051594850', remark='備注說明'}, addlist=[Address{add='鄭州市經三路', zipcode='450001'}, Address{add='北京市海淀區', zipcode='100000'}]}

以上舉例使用的JavaBean對象，對於Map，List對象也是通用的，具有相同功能的還有JsonLib包
XStream還提供了注解放方式。比方在字段上添加@XStreamOmitField表示忽略該字段。等等，這里就不做解說了

演示樣例代碼下載地址：http://download.csdn.net/detail/xiaokui_wingfly/8800295

參考：http://www.jb51.net/article/14542.htm 、http://www.cnblogs.com/hoojo/archive/2011/04/22/2025197.html