XML和JavaBean之间的互转---XStream

【我在项目组使用的是xstream-1.4.3.jar】

最近在项目中遇到了JAVA bean 和XML互转的需求， 本来准备循规蹈矩使用dom4j忽然想起来之前曾接触过的XStream,一番研究豁然开朗，利器啊利器， 下来就XStream的一些用法与大家分享。

XStream是大名鼎鼎的thought works下的一个开源项目， 主要功能是提供JAVA bean 和XML文本之间的转换，另外还提供JAVA bean和JSON之间的转换，这个不在本次讨论的范围内。

XStream进行转换是非常简单的，对JAVA bean没有任何要求：

• 不要求对private属性提供access方法（set/get）。
• 不要求提供默认构造函数。

实际的代码操作就更简单了，在JAVA1.5以后XSteam也支持了annotation。 这时就只要在JAVA BEAN中添加若干annotation就可以了。

我准备在例子中体现以下功能：

• 基本转换
• 对象起别名
• 处理属性
• 处理List
• 忽略field

一、JavaBean和XML互转【注解方式】

1. 基本转换

这是一个普通的JAVA bean：

package xstreamTest;
public class Person {
	private String name;
	private int age;

	public int getAge() {
		return age;
	}

	public void setAge(int age) {
		this.age = age;
	}

	public void setName(String name) {
		this.name = name;
	}

	public String getName() {
		return this.name;
	}
}

转换代码是这样的：

XStream xstream = new XStream();
Person person = new Person();
person.setName("pli");
person.setAge(18);
System.out.println(xstream.toXML(person));

我们得到了这样的结果：

<xstreamTest.Person>
  <name>pli</name>
  <age>18</age>
</xstreamTest.Person>

有没有觉得很奇怪为什么会有“xstreamTest.Person”的标签？对照下上面提到的JAVA bean，这个标签是来自于JAVA bean的类全路径。

可是这个并不是我想要的啊，有没办法改变？有，简单吗？ 简单！

2. 起别名
假如我们希望将“xstreamTest.Person” 这个莫名其妙的element标签改为“person”我们应该这么做：

package xstreamTest;
@XStreamAlias("person")
public class Person {
	private String name;
	private int age;

	public int getAge() {
		return age;
	}

	public void setAge(int age) {
		this.age = age;
	}

	public void setName(String name) {
		this.name = name;
	}

	public String getName() {
		return this.name;
	}
}

而执行代码会变成这样：

XStream xstream = new XStream();
xstream.autodetectAnnotations(true);
Person person = new Person();
person.setName("pli");
person.setAge(18);
System.out.println(xstream.toXML(person));

这样我们就得到了想要的：

<person>
  <name>pli</name>
  <age>18</age>
</person>

这里要提到的是“xstream.autodetectAnnotations(true);” 这句代码告诉XStream去解析JAVA bean中的annotation。这句代码有一个隐患，会在后面讨论。

别名可以改变任何你想在序列化时改变的对象名字，包括：类，属性甚至包名，所用到的其实就是“XsstreamAlias”这个annotation。

3. 处理属性

如果想要将JAVA bean中的“age”属性作为XML中person标签的一个attribute该怎么办呢。

这里介绍另外一个annotation：@XStreamAsAttribute,我们的JAVA bean变成了这样：

@XStreamAlias("person")
public class Person {
	private String name;
	@XStreamAsAttribute
	private int age;
    
	public int getAge() {
		return age;
	}

	public void setAge(int age) {
		this.age = age;
	}

	public void setName(String name) {
		this.name = name;
	}

	public String getName() {
		return this.name;
	}
}

结果是这样的：

<person age="18">
  <name>pli</name>
</person>

好玩吧。

4. 处理List

如果JAVA bean中有List又是什么情形呢。

@XStreamAlias("person")
public class Person {
	private String name;
	@XStreamAsAttribute
	private int age;
	
	List<String> girlFriends;
    
	public List<String> getGirlFriends() {
		return girlFriends;
	}

	public void setGirlFriends(List<String> girlFriends) {
		this.girlFriends = girlFriends;
	}

	public int getAge() {
		return age;
	}

	public void setAge(int age) {
		this.age = age;
	}

	public void setName(String name) {
		this.name = name;
	}

	public String getName() {
		return this.name;
	}
}

直接转换我们会得到这样的结果：

<person age="18">
  <name>pli</name>
  <girlFriends>
    <string>YuanYuanGao</string>
    <string>QiShu</string>
    <string>BoZhiZhang</string>
  </girlFriends>
</person>

结果其实也不赖，XStream在这里提供了一个@XStreamImplicit(itemFieldName=***)的annotation来满足用户想将List的根节点去掉和改变列表名字的需求，对应到我们的例子上就是去掉<girlFriends>标签和改变"<string>".我们来看看效果。

@XStreamAlias("person")
public class Person {
	private String name;
	@XStreamAsAttribute
	private int age;
	@XStreamImplicit(itemFieldName="girl")
	List<String> girlFriends;
    
	public List<String> getGirlFriends() {
		return girlFriends;
	}

	public void setGirlFriends(List<String> girlFriends) {
		this.girlFriends = girlFriends;
	}

	public int getAge() {
		return age;
	}

	public void setAge(int age) {
		this.age = age;
	}

	public void setName(String name) {
		this.name = name;
	}

	public String getName() {
		return this.name;
	}
}

结果是这样：

<person age="18">
  <name>pli</name>
  <girl>YuanYuanGao</girl>
  <girl>QiShu</girl>
  <girl>BoZhiZhang</girl>
</person>

5. 忽略属性

如果在JAVA bean中有些属性不想被序列化，XStream提供了解决这个需求的annotation: @XStreamOmitField