使用Xstream实现java对象和XML文件映射小结

Xstream使用小结
XStream 对象相当Java对象和XML之间的转换器，转换过程是双向的。创建XSteam对象的方式很简单，只需要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节点，这显然不是想要的结果，对于常量字段，就不做转 换了。

一.持久化对象
1. package com.ysen;
2. //这是一组简单的类。XStream能把这些类的实例转换到XML或是转换回来。
3. //注意到这些都是私有变量。XStream不关心变量的作用域。不需要getter或是setter方法。并且，XStream不限定需要默认的构造函数
4. public class Employee {
5. private String name;
6. private String designation;
7. private String department;
8.
9. public String getName() {
10. return name;
11. }
12. public void setName(String name) {
13. this.name = name;
14. }
15. public String getDesignation() {
16. return designation;
17. }
18. public void setDesignation(String designation) {
19. this.designation = designation;
20. }
21. public String getDepartment() {
22. return department;
23. }
24. public void setDepartment(String department) {
25. this.department = department;
26. }
27. @Override
28. public String toString() {
29. return "Name : "+this.name+
30. "\nDesignation : "+this.designation+
31. "\nDepartment : "+this.department;
32. }
33. }

操作的对象
1. public class Writer {
2.
3. public static void main(String[] args) {
4. Employee e = new Employee();
5. e.setName("Jack");
6. e.setDesignation("Manager");
7. e.setDepartment("Finance");
8.
9. //Serialize the object
10. //实例化XStream
11. //使用XStream，简单实例化XStream类：
12.
13. XStream xs = new XStream();
1. // xs.omitField(Employee .class, "name"); //定义某一个属性的值不进行xml序列化。
2. // xs.useAttributeFor(String.class); // 对所有String类型的字段定义为属性tag显示
3. // xs.useAttributeFor("name",String.class);// 对所有String类型的字段名成为name 定义为属性tag显示,读取的时候获取不了该值
4.
5.
6. try {
7. FileOutputStream fs = new FileOutputStream("d:/employeedata.xml");
8.
9. xs.toXML(e, fs);
10. } catch (FileNotFoundException e1) {
11. e1.printStackTrace();
12. }
13. }
14.
15.
16. }


1. public class ConfigReader {
2.
3. String datasourcename = null;
4. String ipaddress = null;
5. String logfilename = null;
6. String appender = null;
7.
8. @Override
9. public String toString() {
10. // This method prints out the values stored in the member variables
11. return "Datasource Name : "+datasourcename+
12. " \nIP Address : "+ipaddress+
13. " \nLogfilename : "+logfilename+
14. " \nAppender : "+appender;
15. }
16.
17.
18. public static void main(String[] args) throws FileNotFoundException {
19. XStream xs = new XStream(new DomDriver());
20.
21. FileInputStream fis = new FileInputStream("d:/Config.xml");
22. //映射将对象属性datasourcename映射到xml别名datasource-name中
23. xs.aliasField("datasource-name", ConfigReader.class, "datasourcename");
24. //这是可选的一步。没有这步XStream也可以很好的起作用，但是XML元素的名字就会包含每个类的全称(包括包名)，这将会使生成XML稍大。
25. xs.alias("config", ConfigReader.class);
26. ConfigReader r = (ConfigReader)xs.fromXML(fis);
27.
28. System.out.println(r.toString());
29. }
30. }

Config.xml

Xml代码
1. <?xml version="1.0" encoding="UTF-8"?>
2. <config>
3. <datasource-name>IRIS</datasource-name>
4. <ipaddress>9.124.74.85</ipaddress>
5. <logfilename>DailyLogApplication.log</logfilename>
6. <appender>console</appender>
7. </config>



二

Java代码
1. public class Author {
2. private String name;
3. public Author(String name) {
4. this.name = name;
5. }
6. public String getName() {
7. return name;
8. }
9. }

Java代码
1. public class Entry {
2. private String title, description;
3. public Entry(String title, String description) {
4. this.title = title;
5. this.description = description;
6. }
7. }




Java代码
1. public class Blog {
2. private Author writer;
3. private List entries = new ArrayList();
4.
5. public Blog(Author writer) {
6. this.writer = writer;
7. }
8.
9. public void add(Entry entry) {
10. entries.add(entry);
11. }
12.
13. public List getContent() {
14. return entries;
15. }
16.
17.
18. public static void main(String[] args) throws FileNotFoundException {
19.
20. Blog teamBlog = new Blog(new Author("Guilherme Silveira"));
21. teamBlog.add(new Entry("first","My first blog entry."));
22. teamBlog.add(new Entry("tutorial","Today we have developed a nice alias tutorial. Tell your friends! NOW!"));
23.
24. XStream xstream = new XStream(new DomDriver());//不需要XPP3库
25.
26. //System.out.println(xstream.toXML(teamBlog));
27. //序列化一个对象到XML
28. FileOutputStream fs = new FileOutputStream("d:/Blog.xml");
29. xstream.toXML(teamBlog, fs);
30.
31. //从XML反序列化一个对象
32. FileInputStream fis = new FileInputStream("d:/Blog.xml");
33. //从xml文件中加载对象是需要new XStream(new DomDriver());
34. Blog blog = (Blog)xstream.fromXML(fis);
35. System.out.println(blog);
36. }
37. }

下面是所需要的依赖包：
• xstream-1.2.2.jar (364.4 KB)
• 下载次数: 151
• xpp3_min-1.1.4c.jar (24.4 KB)
• 下载次数: 109
官方网站：http://xstream.codehaus.org/