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)进行转换,也能顺利转换。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 196,165评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,503评论 2 373
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 143,295评论 0 325
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,589评论 1 267
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,439评论 5 358
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,342评论 1 273
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,749评论 3 387
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,397评论 0 255
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,700评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,740评论 2 313
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,523评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,364评论 3 314
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,755评论 3 300
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,024评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,297评论 1 251
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,721评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,918评论 2 336

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,517评论 18 139
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,514评论 18 399
  • 新媒体时代爆文的核心要素: 1、必须在思维层面吃透系列技巧,融会贯通,做到本能的应用技巧; 2、高效率,快速度的为...
    狐狸也糊涂plus阅读 436评论 0 0
  • 时间是十月底至十一月初,今天我刚从美不胜收的敦煌回到黄河穿城而过的城市—兰州。敦煌于我的总体印象就是风景美,人心美...
    ExtendNo1阅读 287评论 0 2