使用XStream将Java实体序列化为XML数据，将XML数据反序列化为Java实体

最新推荐文章于 2023-12-04 16:52:34 发布
最新推荐文章于 2023-12-04 16:52:34 发布
阅读量547 收藏 1
点赞数
分类专栏： Java 文章标签： xstream
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Yu_Mariam/article/details/108814238
版权

序列化与反序列化

  1. 序列化：把Java对象转换为字节序列的过程。
    作用：1. 进行持久化操作，写入硬盘中

    1. 用于网络传输

  2. 反序列化：把字节序列恢复为Java对象的过程。
    而在Java中，如果一个对象想要实现序列化，就必须实现两个接口之一：Serializable 、Externalizable

一、使用XSteam将Java对象序列化为XML

首先需要导入XSteam依赖

<!--XML反序列化xstream-->
        <dependency>
            <groupId>com.thoughtworks.xstream</groupId>
            <artifactId>xstream</artifactId>
            <version>1.4.4</version>
        </dependency>
  1. 最基本使用
    Person实体类——实现Serializable接口，否则无法序列化：
package com.pantech.cloud.message.handler.osccaac.controller;

import lombok.Data;

import java.io.Serializable;

/**
 * @author lkh
 * @date 2020/9/24 18:29
 * @description
 */

@Data
public class Person implements Serializable {
    private String name;
    private int age;
}

序列化方法：

 public void test() {
        try {
            Person person = new Person();
            person.setName("张三");
            person.setAge(18);

            // 将employee对象序列化为XML
            XStream xStream = new XStream(new DomDriver());
            String xmlData = xStream.toXML(person);

            log.info(xmlData);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

输出结果：

<com.pantech.cloud.message.handler.osccaac.controller.Person>
  <name>张三</name>
  <age>18</age>
</com.pantech.cloud.message.handler.osccaac.controller.Person>
  1. 序列化结果中实体默认都带有包名，如果不想让其显示类全名，只要给该类起个别名即可
    修改后的序列化方法：
public void test() {
        try {
            Person person = new Person();
            person.setName("张三");
            person.setAge(18);

            // 将employee对象序列化为XML
            XStream xStream = new XStream(new DomDriver());

            // 设置Person类的别名,第一个参数要重命名的名称，第二个参数为实体类
            xStream.alias("person", Person.class);//这里的名称就是XML根节点的名称，可任意命名
            
            String xmlData = xStream.toXML(person);

            log.info(xmlData);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

输出结果：

<person>
  <name>张三</name>
  <age>18</age>
</person>
  1. 可修改序列化生成的标签名——两种方法
 //对属性取别名
 xStream.aliasField("姓名", Person.class,"name");

@XStreamAlias("姓名") // 自定义标签
private String name;

输出结果：

<person>
  <姓名>张三</姓名>
  <age>18</age>
</person>
  1. 如果此时实体中有些属性不想要序列化为 XML 节点，就可设置忽略属性
    第一种方法是在实体属性上使用 transient 关键字
@Data
public class Person implements Serializable {
    private String name;

    /**
     * 使用transient关键字，表示该字段不序列化
     */
    private transient int age;
}

第二种方法是使用 xStream.omitField(Person .class,“age”); 第一个参数是 传递的类，第二个参数是想要忽略的属性名

 // 设置Person类的别名,第一个参数要重命名的名称，第二个参数为实体类
            xStream.alias("person", Person.class);
            // 忽略实体属性
            xStream.omitField(Person .class,"age");
            String xmlData = xStream.toXML(person);

第三种方法是在属性字段上加上注解

@XStreamOmitField // 忽略该字段
private int age;
  1. 实体中的属性可以是另一实体
    Friend实体：
@Data
public class Friend {
    private String name;
    private int age;
}

Person实体：

@Data
public class Person implements Serializable {
    private String name;
    
    private int age;

    private Friend friend;
}

序列化方法：

public void test() {
        try {
            Friend friend = new Friend();
            friend.setName("李四");
            friend.setAge(18);

            Person person = new Person();
            person.setName("张三");
            person.setAge(18);
            person.setFriend(friend);

            // 将employee对象序列化为XML
            XStream xStream = new XStream(new DomDriver());

            // 设置Person类的别名,第一个参数要重命名的名称，第二个参数为实体类
            xStream.alias("person", Person.class);

            String xmlData = xStream.toXML(person);

            log.info(xmlData);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

输出结果：

<person>
  <name>张三</name>
  <age>18</age>
  <friend>
    <name>李四</name>
    <age>18</age>
  </friend>
</person>
  1. 属性中可以是实体的list
    Person实体：
 private List<Friend> friends;

序列化方法：

 public void test() {
       
           Friend friendA = new Friend();
           friendA.setName("李四");
           friendA.setAge(18);

           Friend friendB = new Friend();
           friendB.setName("王五");
           friendB.setAge(23);

           List<Friend> friendList = new ArrayList<>();
           friendList.add(friendA);
           friendList.add(friendB);

           Person person = new Person();
           person.setName("张三");
           person.setAge(18);
           person.setFriends(friendList);

           // 将employee对象序列化为XML
           XStream xStream = new XStream(new DomDriver());

           // 设置Person类的别名,第一个参数要重命名的名称，第二个参数为实体类
           xStream.alias("person", Person.class);
           xStream.alias("friend", Friend.class);

           String xmlData = xStream.toXML(person);

           log.info(xmlData);
   }

输出结果：

  <person>
  <name>张三</name>
  <age>18</age>
  <friends>
    <friend>
      <name>李四</name>
      <age>18</age>
    </friend>
    <friend>
      <name>王五</name>
      <age>23</age>
    </friend>
  </friends>
</person>
  1. 若想去掉集合标签
xStream.addImplicitCollection(Person.class, "friends"); // 去掉集合标签

或者使用注解：

@XStreamImplicit(itemFieldName="friend") // 去掉集合标签
private List<Friend> friends;

输出结果：

<person>
  <name>张三</name>
  <age>18</age>
  <friend>
    <name>李四</name>
    <age>18</age>
  </friend>
  <friend>
    <name>王五</name>
    <age>23</age>
  </friend>
</person>

二、XML反序列化为Java对象

将XML反序列化为Java对象时，需要注意节点与实体属性的对应
xStream的属性设置与序列化是一样的。
原XML数据：

<person>
  <姓名>张三</姓名>
  <age>18</age>
  <address>解放路</address>
  <friend>
    <name>李四</name>
    <age>18</age>
  </friend>
  <friend>
    <name>李四</name>
    <age>18</age>
  </friend>
  <friend>
    <name>王五</name>
    <age>23</age>
  </friend>
</person>

转换为上面的Person类
转换方法：

// 忽略某些节点,作用是 某些不需要的节点时不会报错,如：<address>标签
        XStream xStream = new XStream() {
            @Override
            protected MapperWrapper wrapMapper(MapperWrapper next){
                return new MapperWrapper(next) {
                    @Override
                    public boolean shouldSerializeMember(Class definedIn, String fieldName){
                        if (definedIn == Object.class){
                            try {
                                return this.realClass(fieldName) != null;
                            } catch (Exception e){
                                return false;
                            }
                        } else {
                            return super.shouldSerializeMember(definedIn, fieldName);
                        }
                    }
                };
            }
        };
        xStream.alias("person", Person.class);// 这里对类的重命名一定是根节点名称
        xStream.alias("friend", Friend.class);// 不重命名会报错

        // 属性重命名
        xStream.aliasField("姓名", Person.class,"name");

        // 去掉集合标签
        xStream.addImplicitCollection(Person.class, "friends");
        Person person = (Person) xStream.fromXML(xmlMessage);

        log.info(person.toString());

输出结果：
Person(name=张三, age=18, friends=[Friend(name=李四, age=18), Friend(name=李四, age=18), Friend(name=王五, age=23)])

总结：

  1. 对类重命名，去除完整包名
    - xStream.alias(“person”, Person.class);
    - @XStreamAlias(“person”) // 直接加在类 上
  2. 修改序列化生成的标签名
    • xStream.aliasField(“姓名”, Person.class,“name”);
    • 在类属性上使用注解：@XStreamAlias(“姓名”) // 自定义标签
  3. 忽略类的某些属性
    • 在类属性上使用 transient 关键字
    • xStream.omitField(Person .class,“age”);
    • 注解@XStreamOmitField // 忽略该字段
  4. 去除集合标签
    • xStream.addImplicitCollection(Person.class, “friends”); // 去掉集合标签
    • @XStreamImplicit(itemFieldName=“friend”) // 去掉集合标签
  5. 反序列化时，若忽略某些节点，则可以使用：
XStream xStream = new XStream() {
            @Override
            protected MapperWrapper wrapMapper(MapperWrapper next){
                return new MapperWrapper(next) {
                    @Override
                    public boolean shouldSerializeMember(Class definedIn, String fieldName){
                        if (definedIn == Object.class){
                            try {
                                return this.realClass(fieldName) != null;
                            } catch (Exception e){
                                return false;
                            }
                        } else {
                            return super.shouldSerializeMember(definedIn, fieldName);
                        }
                    }
                };
            }
        };
一只欢脱的知更鸟呀
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
使用XStream处理Xml文档和实体类之间的转换的几种方式
crazyzhr32的博客
12-10 2173
首先说一下背景（觉得没用可以直接跳过看代码），最近在和其他系统做对接的时候用到了xml作为传输格式的内容，涉及到了xml和实体类的互相转换，然后也上网查了一下，一开始尝试了dom4j不过发现有些繁琐，后来继续查资料，找到了XStream，发现这个还是很好用的，作为总结也把使用方法写一下，供大家参考吧，不足之处望指出！ 1.项目结构（PersonList.java没卵用的，忽略之）
java的model，xml序列化（简单的，复杂的）方法都有
01-18
根据网上的资料自己研究的方法，不喜勿喷谢谢！！
Java XStream XML序列化反序列化
czjnoe的博客
08-05 678
环境： jdk13 xstream-1.4.9.jar 下载地址：http://x-stream.github.io/download.html xmlpull-1.1.3.1.jar 下载地址：https://repo1.maven.org/maven2/xmlpull/xmlpull/1.1.3.1/xmlpull-1.1.3.1.jar 实体： @XStreamAlias("user") // 定义根节点别名，等同于xStream.alias("user", User.class...
java 实体类转xml格式（jaxb 和 xstrem）（二）
foralllove的博客
02-28 401
1.Xtream方式转化 优点：使用便捷 缺点：效率不高 2.Xstream streamTag标记 /** * 描述：StreamXmlTag * * @author 归墟 * @date 2021/2/25 20:32 */ public interface StreamXmlTag extends XmlTag { /** * 转换操作 * * @return xml String */ default String ha.
java用xstream实现xml与实体的互相转化
luoke626的专栏
11-30 633
在项目中需要用到xml与bean之间的相互转化,这个用xstream很方便,于是写了一个例子: 1.需要的jar包 xpp3_min-1.1.4c.jar xstream-1.4.3.jar 2.源码: ①将xml和obj互相转化的方法 private String obj2xmlTest2(){ Factory factory = new Factory("大兴化工厂
java 上传读取xml 转实体进行保存
z_victoria123的博客
04-01 850
xml文件转实体 上传xml文件
基于 Java 的亿赛通电子文档安全管理系统XStream反序列化漏洞任意文件上传利用
最新发布
07-01
【作品名称】：基于 Java 的亿赛通电子文档安全管理系统XStream反序列化漏洞任意文件上传利用 【适用人群】：适用于希望学习不同技术领域的小白或进阶学习者。可作为毕设项目、课程设计、大作业、工程实训或初期...
基于java的转换xml.zip
05-28
但根据提供的文件名"XStream-1.3"，这个压缩包可能使用了XStream库，这是一个强大的Java库，用于将Java对象序列化为XML，反之亦然。 XStream库由Joe Walnes创建，它的核心特性包括： 1. **简单易用**：XStream提供...
应用源码之Xstream(解决xml和对象转换问题).zip
04-22
Xstream是一个轻量级的Java库，它使得XML与Java对象之间的序列化和反序列化变得简单易行。本教程将深入探讨如何使用Xstream在Android项目中处理XML和对象的转换问题。 1. **Xstream简介** Xstream库由Joe Walnes...
基于混合分析的Java反序列化利用链挖掘方法.docx
05-27
例如，客户端会将参数对象序列化为字节码并通过网络发送给服务器端，服务器端再将接收到的数据反序列化为原始对象，并进一步处理。 根据反序列化机制的不同，Java反序列化器可以大致分为两类：基于bean的反序列化器...
将Java对象序列化成JSON和XML格式的实例
10-18
下面小编就为大家分享一篇将Java对象序列化成JSON和XML格式的实例，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
xstream序列化与反序列化
06-07
xstream中xml与javaBean的互转
【常用功能】使用xstream完成xml、对象互转
绊脚石
01-06 3861
xml格式转为object对象，分三种情况： 1、常规标签格式转化 2、标签属性格式转化 3、两种方式相结合的xml格式转化 备注：需要用到的jar包 xstream，xpp3 一、常规标签格式转化 主要使用xstream中 @XStreamAlias 标签，将xml标签和实体类属性进行一一对应后，使用util类转化方法进行转化即可。 xml格式如下： <User> <use...
xstream java_XStream将java转化成xml的简单使用
weixin_36221113的博客
02-12 189
XStream可以用来将java实体转化成xml形式的字符串, 也可以将xml文档的字符串读取成java实体.jar包依赖地址com.thoughtworks.xstreamxstream${xstream-version}使用方法实例这是我在网上看的一个教程文档,使用的测试类package com.hero.test;import java.io.File;import java.io.File...
XStream使用详解
weixin_34077371的博客
03-04 307
1.Xstream介绍(1)Xstream介绍 Xstream是一种OXMapping 技术，是用来处理XML文件序列化的框架,在将JavaBean序列化，或将XML文件反序列化的时候，不需要其它辅助类和映射文件，使得XML序列化不再繁索。Xstream也可以将JavaBean序列化成Json或反序列化，使用非常方便。(2)Xstream的简单例子class Person//JavaBean...
java使用xstream框架生成xml文件
LMC技术人生专栏
12-04 733
java 生成xml
序列化时包名处理
mada26
04-30 1393
前提：同一个实体，在两个项目中使用 使用fastjson进行序列化反序列化，两个实体的包名无需保持一致：fastjson序列化反序列化是根据**@JSONField注解**中的name等字段进行处理的。 使用io流进行序列化反序列化，两个实体的包名必须保持一致：否则反序列化时根据实体类的全路径找不到对应的实体类会反序列化失败。 ...
Java自定义实体xml序列化
qq506930427的博客
11-28 294
Java自定义实体xml序列化
java xml序列化_java类序列化成xml 方法[转]
weixin_32467423的博客
02-12 1093
今天看了下JAVA序列化。还是一知半解。怎么也没有弄明白，怎么序列化成XML文件。处入半解状态。在网上找了很多，大部分是理论上的。没有实际的例子。功夫不负有心人，终于找到了。做了下测试终于成功。忍不住记录的下来。JXmlSerializable 是一个利用java反射，通过调用对象中所有以get(不区分大小写)开头的方法除去getClass方法,生成xml格式,希望与大家分享一下下面是一个pa...
xstream实现xml序列化
04-01
XStream是一种Java库，它可以将Java对象序列化为XML格式，并且还可以将XML格式反序列化为Java对象。XStream可以非常方便地将Java对象转换为XML格式的字符串，也可以将XML格式的字符串转换为Java对象。XStream的使用非常简单，只需要创建一个XStream对象，然后调用toXML()方法将Java对象序列化为XML格式的字符串，或者调用fromXML()方法将XML格式的字符串反序列化为Java对象。 下面是一个简单的示例，演示如何使用XStream将Java对象序列化为XML格式的字符串： ``` import com.thoughtworks.xstream.XStream; public class Person { private String name; private int age; // 省略getter和setter方法 public static void main(String[] args) { Person person = new Person(); person.setName("张三"); person.setAge(25); XStream xstream = new XStream(); String xml = xstream.toXML(person); System.out.println(xml); } } ``` 在上面的代码中，我们创建了一个Person对象，并设置了name和age属性的值。然后，我们创建了一个XStream对象，并调用toXML()方法将Person对象序列化为XML格式的字符串。最后，我们将序列化后的字符串打印出来。 输出结果如下： ``` <person> <name>张三</name> <age>25</age> </person> ``` 可以看到，XStream将Java对象序列化为了XML格式的字符串，并且为每个属性添加了相应的XML标签。在这个例子中，我们只有两个属性，因此只有两个XML标签。如果有更多的属性，XStream会为每个属性添加相应的XML标签。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值