XStream xml 与实体类的相互转换

XStream 简介

XStream是一款能够非常简单实现 XML与实体类之间转换的类库，下文就简单地记录下其主要使用方法。
直接上代码

一实体转XML

1.1 简单使用

public class Student {
    public Student(String name,int age){
        this.name=name;
        this.age=age;
    }
    private String name;
    private int age;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }

Student student=new Student("matt",18);
XStream xStream=new XStream();
String xmlStudent = xStream.toXML(student);

以下为输入结果：

<com.laxton.rms.upload.bean.Student>
  <age>18</age>
  <name>matt</name>
</com.laxton.rms.upload.bean.Student>

1.2 alias

有没有觉得com.laxton.rms.upload.bean.Student很碍眼，我们可以通过关键字alias更改给它换一个别名。

Student student=new Student("matt",18);
XStream xStream=new XStream();
xStream.alias("Student",Student.class);//为类名节点重命名
String xmlStudent = xStream.toXML(student);

以下为输入结果：

<Student>
  <age>18</age>
  <name>matt</name>
</Student>

这样就舒服多了。

1.3 useAttributeFor

<Student atrr="Attribute">
  <age>18</age>
 <name>matt</name>
</Student>

这个XML的格式跟上一个是有区别的，在Student这个节点里多了一个atrr="Attribute"，那么我们要怎么添加这样的格式呢？
首先，在Student实体类里添加一个字段：atrr

public class Student {
    public Student(String name,int age){
        this.name=name;
        this.age=age;
    }
    public Student(String name,int age,String atrr){
        this.name=name;
        this.age=age;
        this.atrr=atrr;
    }
    private String name;
    private int age;
    private String atrr;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
    public String getAtrr() {
        return atrr;
    }
    public void setAtrr(String atrr) {
        this.atrr = atrr;
    }

然后，使用useAttributeFor关键字

Student student=new Student("matt",18,"Attribute");
XStream xStream=new XStream();
xStream.alias("Student",Student.class);//为类名节点重命名
xStream.useAttributeFor(Student.class,"atrr");
String xmlStudent = xStream.toXML(student);

输出结果如下：

<Student atrr="Attribute">
  <age>18</age>
 <name>matt</name>
</Student>

1.4 问题：当实体类的某个值为null时，转换的xml会收起这个节点不显示

Student student=new Student(null,18);
XStream xStream=new XStream();
xStream.alias("Student",Student.class);//为类名节点重命名
String xmlStudent = xStream.toXML(student);

结果输出：

<Student>
       <age>18</age>
</Student>

在这个例子中，当我们给name赋予null值时，输出的xml文本没有 <name> 这个节点。网络上有相关文章描述了如何通过Converter将赋为null值的字段依然显示节点。
但本人觉得完全没有必要这么做。因为当你将没有 <name>节点的xml文本转换为实体时，name字段会被赋予null值，这种相互之间的转换是完全匹配的。如果你将<name>节点强制显示出来，当它转换成实体类时，name字段会被赋予空值，反而与实际情况不符。

二 XML转实体类

2.1 简单使用

当我企图用以下的xml文本转换成实体类Student时报错。

<Student>
  <age>18</age>
 <name>matt</name>
</Student>

  String xmlStr = "<Student>\n" +
                "  <age>18</age>\n" +
                "  <name>matt</name>\n" +
                "</Student>";

        XStream xStream=new XStream();
        Student student = (Student)xStream.fromXML(xmlStr);
        Log.i("vlog","name:"+student.getName());
        Log.i("vlog","age:"+student.getAge());

恍然大悟后改成：

  String xmlStr = "<com.laxton.rms.upload.beanStudent>\n" +
                "  <age>18</age>\n" +
                "  <name>matt</name>\n" +
                "</com.laxton.rms.upload.beanStudent>";
   ....

就能成功地转换，可现实中的xml文件是不会带类名的。

2.2 alias

所以跟实体类转XML一个道理，我们需要用到alias关键字。

  String xmlStr = "<Student>\n" +
                "  <age>18</age>\n" +
                "  <name>matt</name>\n" +
                "</Student>";

        XStream xStream=new XStream();
       xStream.alias("Student",Student.class);
        Student student = (Student)xStream.fromXML(xmlStr);
        Log.i("vlog","name:"+student.getName());
        Log.i("vlog","age:"+student.getAge());

完美解决问题。

2.3 useAttributeFor

如果遇到如下xml文本，应当怎样将它转换为实体类呢？

      String xmlStr = "<Student atrr=\"Attribute\">\n" +
                "  <age>18</age>\n" +
                "  <name>matt</name>\n" +
                "</Student>";

跟上面的xml文本相比，这一个多了一个Student节点下的属性：<Student atrr="Attribute">。
使用useAttributeFor关键字，完美解决问题，直接上代码：

  String xmlStr = "<Student atrr=\"Attribute\">\n" +
                "  <age>18</age>\n" +
                "  <name>matt</name>\n" +
                "</Student>";

        XStream xStream=new XStream();
        xStream.alias("Student",Student.class);
        xStream.useAttributeFor(Student.class,"atrr");
        Student student = (Student)xStream.fromXML(xmlStr);
        Log.i("vlog","name:"+student.getName());
        Log.i("vlog","age:"+student.getAge());
        Log.i("vlog","atrr:"+student.getAtrr());

2.4 问题：xStream.fromXML(File)与xStream.fromXML(String)

问题描述：由.net服务器端生成的一份xml文件，我将它拷贝放到安卓设备的SD卡，再将它的xml文本读出来。尝试用xStream.fromXML(String)的方法将其转成对象，但报错了，具体错误如下：

 Caused by: org.xmlpull.v1.XmlPullParserException: Unexpected token (position:TEXT @1:2 in java.io.StringReader@888018) 
          at org.kxml2.io.KXmlParser.next(KXmlParser.java:432)
          at org.kxml2.io.KXmlParser.next(KXmlParser.java:313)

找不着具体原因，也找不到解决办法。
突然看到还有xStream.fromXML(File)这个接口，于是直接用xml文件的存放路径new一个File再调用该接口，能够顺利转换不会报错。
问题得以解决但并不清楚其它内在原因。
尝试过手动将这个文件的文本拷贝出来，新建另一个文件，将文本粘贴进去。然后使用xStream.fromXML(String)进行转换，也能顺利转换。

XStream xml 与 实体类 的相互转换

推荐阅读更多精彩内容

XStream xml 与实体类的相互转换