java基础开发-xstream解析xml

最新推荐文章于 2024-09-01 15:30:33 发布
最新推荐文章于 2024-09-01 15:30:33 发布
阅读量939 收藏 13
点赞数 6
分类专栏： Java开发 文章标签： java xml python
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/wendao76/article/details/141748396
版权

文章目录


XStream 是一个用于 Java 的轻量级 XML 序列化库，它允许你将 Java 对象序列化为 XML 文档，或将 XML 文档反序列化为 Java 对象。XStream 的使用非常直观且简单，但它也提供了足够的灵活性来自定义序列化行为。

XStream 的基本使用步骤

  1. 导入依赖：
    如果你在使用 Maven，可以在 pom.xml 文件中添加以下依赖：

    <dependency>
    <groupId>com.thoughtworks.xstream</groupId>
    <artifactId>xstream</artifactId>
    <version>1.4.18</version> <!-- 使用最新版本 -->
</dependency>

  2. 创建 XStream 实例：
    创建一个 XStream 实例对象，通常情况下你可以直接创建一个实例，但在生产环境中，为了性能考虑，建议复用实例而不是每次都新建。

    import com.thoughtworks.xstream.XStream;

public class XStreamExample {
    private static final XStream xstream = createXStream();

    private static XStream createXStream() {
        return new XStream();
    }
}

  3. 序列化对象为 XML：
    使用 toXML 方法将 Java 对象转换为 XML 字符串。

    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);

    String xml = xstream.toXML(person);
    System.out.println(xml);
}

  4. 从 XML 反序列化为对象：
    使用 fromXML 方法将 XML 字符串转换为 Java 对象。

    public static void main(String[] args) {
    String xml = "<person><name>张三</name><age>25</age></person>";
    Person person = (Person) xstream.fromXML(xml);
    System.out.println(person.getName() + ", " + person.getAge());
}

高级用法

自定义别名

XStream 允许你为类指定别名，这样生成的 XML 将更加简洁。

xstream.alias("person", Person.class);
忽略某些字段

如果不想序列化某个字段，可以使用 omitField 方法。

xstream.omitField(Person.class, "age");
自定义转换器

XStream 允许你为特定类型提供自定义的转换器。

xstream.registerConverter(new MyCustomConverter());
类型安全

默认情况下，XStream 允许任何类型的对象被反序列化，这可能会带来安全隐患。可以通过设置信任的类列表来限制反序列化的对象类型。

xstream.addPermission(AnyTypePermission.NONE);
xstream.addPermission(ClassPermission.SAFE);
xstream.addPermission(new WildcardTypePermission(new String[]{"com.example.*"}));

示例

下面是一个完整的示例，展示如何使用 XStream 序列化和反序列化一个简单的 Person 类。

import com.thoughtworks.xstream.XStream;
import com.thoughtworks.xstream.io.xml.DomDriver;

public class XStreamExample {
    public static void main(String[] args) {
        XStream xstream = new XStream(new DomDriver());
        xstream.alias("person", Person.class); // 设置别名

        // 创建一个 Person 对象
        Person person = new Person();
        person.setName("张三");
        person.setAge(25);

        // 序列化为 XML
        String xml = xstream.toXML(person);
        System.out.println(xml);

        // 从 XML 反序列化为 Person 对象
        Person deserializedPerson = (Person) xstream.fromXML(xml);
        System.out.println(deserializedPerson.getName() + ", " + deserializedPerson.getAge());
    }
}

class Person {
    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;
    }
}

XStream常见注解

虽然 XStream 本身并不直接支持标准的 Java 注解，但有一些库和方法可以帮助你使用注解来控制序列化过程。其中最流行的库之一是 JAnnotate-XStream，它扩展了 XStream 并提供了对注解的支持。以下是一些常用的注解及其用途：

XStream 是一个用于 Java 的轻量级 XML 序列化库，它可以将 Java 对象序列化为 XML 文档，或将 XML 文档反序列化为 Java 对象。虽然 XStream 本身不直接支持 Java 注解，但你可以使用第三方库 JAnnotate-XStream 来支持注解。

安装 JAnnotate-XStream

首先，你需要在项目中添加 JAnnotate-XStream 的依赖。如果你使用 Maven，可以在 pom.xml 文件中添加如下依赖：

<dependency>
    <groupId>de.janert.oggv.xstream</groupId>
    <artifactId>jannotate-xstream</artifactId>
    <version>1.4.10</version>
</dependency>

使用 JAnnotate-XStream 注解

JAnnotate-XStream 提供了一系列注解来控制序列化和反序列化的行为。以下是一些常用的注解及其用途：

1. @XStreamAlias
  • 用途：为类或字段定义一个 XML 元素的别名。
  • 示例：
    @XStreamAlias("person")
public class Person {
    @XStreamAlias("name")
    private String name;

    private int age;

    // 构造函数、getter 和 setter
}
2. @XStreamAsAttribute
  • 用途：将字段作为 XML 属性输出，而不是作为一个单独的 XML 元素。
  • 示例：
    @XStreamAlias("person")
public class Person {
    @XStreamAlias("name")
    private String name;

    @XStreamAsAttribute
    private int age;

    // 构造函数、getter 和 setter
}
3. @XStreamOmitField
  • 用途：忽略某个字段，使其不参与序列化过程。
  • 示例：
    @XStreamAlias("person")
public class Person {
    @XStreamAlias("name")
    private String name;

    @XStreamOmitField
    private int age;

    // 构造函数、getter 和 setter
}
4. @XStreamConverter
  • 用途：指定自定义的转换器，用于特定类型的序列化和反序列化。
  • 示例：
    @XStreamAlias("person")
public class Person {
    @XStreamAlias("name")
    private String name;

    @XStreamConverter(MyCustomConverter.class)
    private int age;

    // 构造函数、getter 和 setter
}
5. @XStreamImplicit
  • 用途：隐式地将集合类型转换为 XML 元素列表。
  • 示例：
    @XStreamAlias("person")
public class Person {
    @XStreamAlias("name")
    private String name;

    @XStreamImplicit(itemFieldName = "item")
    private List<String> items;

    // 构造函数、getter 和 setter
}

示例代码

下面是一个完整的示例，展示如何使用 JAnnotate-XStream 的注解来控制序列化和反序列化过程：

import com.thoughtworks.xstream.XStream;
import de.janert.oggv.xstream.annotations.XStreamAlias;
import de.janert.oggv.xstream.annotations.XStreamAsAttribute;
import de.janert.oggv.xstream.annotations.XStreamOmitField;
import de.janert.oggv.xstream.annotations.XStreamSetupProcessor;
import de.janert.oggv.xstream.annotations.processors.JAnnotateXStreamSetupProcessor;

public class Main {

    public static void main(String[] args) {
        XStream xstream = new XStream();
        xstream.setupProcessor(new JAnnotateXStreamSetupProcessor()); // 启用注解支持

        Person person = new Person();
        person.setName("张三");
        person.setAge(25);
        person.addItem("item1");
        person.addItem("item2");

        String xml = xstream.toXML(person);
        System.out.println(xml);

        Person deserializedPerson = (Person) xstream.fromXML(xml);
        System.out.println(deserializedPerson.getName() + ", " + deserializedPerson.getAge());
    }
}

@XStreamAlias("person")
class Person {
    @XStreamAlias("name")
    private String name;

    @XStreamAsAttribute
    private int age;

    @XStreamImplicit(itemFieldName = "item")
    private List<String> items;

    public Person() {
        items = new ArrayList<>();
    }

    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 void addItem(String item) {
        items.add(item);
    }
}

在这个示例中，我们定义了一个 Person 类，并使用了 @XStreamAlias、@XStreamAsAttribute 和 @XStreamImplicit 注解来控制序列化过程。通过 JAnnotateXStreamSetupProcessor 处理器，XStream 能够识别这些注解并按照注解配置进行序列化和反序列化。

使用 XStream 没有注解的情况

如果你不想使用注解，或者希望手动配置 XStream，可以通过编程方式来设置别名、忽略字段等：

XStream xstream = new XStream();
xstream.alias("person", Person.class);
xstream.aliasField("name", Person.class, "name");
xstream.useAttributeFor(Person.class, "age");
xstream.ignoreField(Person.class, "items");

自定义转换器

如果你需要更细粒度的控制，可以自定义转换器。例如，创建一个自定义转换器来处理日期类型：

import com.thoughtworks.xstream.converters.Converter;
import com.thoughtworks.xstream.converters.MarshallingContext;
import com.thoughtworks.xstream.converters.UnmarshallingContext;
import com.thoughtworks.xstream.io.HierarchicalStreamReader;
import com.thoughtworks.xstream.io.HierarchicalStreamWriter;

import java.util.Date;

public class CustomDateConverter implements Converter {
    @Override
    public boolean canConvert(Class<?> type) {
        return Date.class.isAssignableFrom(type);
    }

    @Override
    public void marshal(Object source, HierarchicalStreamWriter writer, MarshallingContext context) {
        Date date = (Date) source;
        writer.setValue(date.toString());
    }

    @Override
    public Object unmarshal(HierarchicalStreamReader reader, UnmarshallingContext context) {
        String dateString = reader.getValue();
        try {
            return new SimpleDateFormat("yyyy-MM-dd").parse(dateString);
        } catch (ParseException e) {
            throw new RuntimeException(e);
        }
    }
}

然后在 XStream 实例中注册这个转换器：

XStream xstream = new XStream();
xstream.registerConverter(new CustomDateConverter());

总结

通过使用 JAnnotate-XStream，你可以方便地利用注解来控制 XStream 的序列化和反序列化行为。这些注解提供了丰富的配置选项，使得 XML 与 Java 对象之间的映射更加灵活和强大。同时，你还可以通过编程方式来配置 XStream，或者自定义转换器以满足特定需求。

问道飞鱼
关注
  • 6
    点赞
  • 踩
  • 13
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
XStream解析XML实例
04-14
**XStream解析XML实例** 在Java开发中，处理XML数据是一项常见的任务，XStream库提供了一个简单而强大的方式来将Java对象序列化为XML，以及从XML反序列化回Java对象。这个实例将深入探讨如何使用XStream进行XML操作...
android 使用XStream解析xml的实例
08-28
本文将介绍如何使用XStream解析xml文件，并将其转换成Java对象。 一、XStream简介 XStream是一个高性能的XML解析库，它可以将xml文件转换成Java对象，使得开发者可以方便地进行数据处理。XStream支持多种数据类型...
java xstream 解析xml_XML解析---利用XStream解析xml数据及反构造Java对象
weixin_36102930的博客
02-16 390
XStream 是一个轻量级的、简单易用的开放源代码 Java库，用于将 Java 对象序列化为 XML 或者再转换回来。而且XStream还能将java对象转成其它格式，比如JSon。需要用到的包：xstream-1.3.1测试：新建Person类----public class Person {private String firstname;private String lastname;p...
java xstream解析xml_java xstream解析xml
weixin_35748716的博客
02-13 234
package com.xstream;import java.io.File;import java.io.FileNotFoundException;import java.io.FileOutputStream;import java.io.OutputStreamWriter;import java.io.UnsupportedEncodingException;import com.th...
通用xml解析-XStream
athjyh的博客
12-09 1356
场景介绍   下面的xml模板是在项目中实际使用的。项目中所有的接口都具有相同的结构。 <?xml version="1.0" encoding="UTF-8"?> <Document xmlns="urn:cbcc:std:caps:2020:tech:xsd:caps.202.001.01" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Message> <Head> <C
java xstream解析xml_java利用XStream解析xml文件,获取xml文件里面的值
weixin_39535557的博客
02-16 498
新手刚刚接触xml,不太懂,今天摸索离开下发现可以正常解析xml了,记录下来方便后来人10以上2种xml值都可以正常解析import com.thoughtworks.xstream.XStream;import com.weixinpay.model.OrderReturnInfoPayResult;导入2个文件,第一个是个jar包(解析xml好像还需要依赖其他的包,具体是那个我忘记了,一会我...
Xstream解析xml
08-19
总的来说，使用Xstream解析XML文件并存入MySQL数据库是一个常见的数据处理任务，它涉及XML解析、Java对象映射以及数据库操作等多个技术点。通过合理地组织代码，可以高效地完成这项工作，实现数据的无缝迁移和存储。
java 利用Xstream注解生成和解析xml
08-10
解析XML回Java对象同样简单，只需使用`fromXML()`方法： ```java String xmlInput = "<person id='1'><firstName>John</firstName><lastName>Doe</lastName></person>"; Person parsedPerson = (Person) xstream....
XStream XML解析
01-04
**XStream XML解析** XStream 是一个开源的 Java 库，它提供了一种简单而有效的方式来将 Java 对象序列化为 XML 和从 XML 反序列化回 Java 对象。这个库的强大之处在于其简洁的API和对复杂Java对象模型的处理能力。...
Java基础（6）- Java代码笔记3
weixin_47062560的博客
08-30 1334
数据类型[][] 数组名 = new 数据类型[m][n]数据类型 数组名[][] = new 数据类型[m][n]数据类型[] 数组名[] = new 数据类型[m][n]m：代表二维数组长度n：代表二维数组中每个一维数组的长度。
浅析synchronized锁升级的原理与实现 1
最新发布
水w的博客
09-01 860
浅析synchronized锁升级的原理与实现
《深入理解 Java 中的适配器模式》
面团到油条的成长日记
08-29 7026
在软件开发的广阔领域中，不同接口之间不匹配的问题时常像个棘手的难题困扰着开发者。而适配器模式就像是一位得力的助手，专门用来解决这类问题。它的关键作用在于把一个类的接口有效地转化为客户端所期望的另一种接口，让原本因接口不相符而不能一起工作的两个类可以共同协作，学习本文希望你能有所收获
Java设计模式之建造者模式详细讲解和案例示范
weixin_39996520的博客
08-28 5468
建造者模式是一种创建型设计模式，允许用户通过一步步地构造复杂对象的方式来避免直接使用大量的构造函数或复杂的初始化过程。它通过将对象的创建过程分解为多个步骤，并允许这些步骤以链式调用的方式来执行，最终生成一个完全构建的对象。首先，我们定义一个Order类，该类包括了多个字段，如订单ID、客户信息、商品列表、配送地址等。// Getter方法省略...在这个例子中，类提供了构建Order对象所需的各个方法，每个方法返回实例，以便进行链式调用。
深度解读并发安全集合的原理及源码
DougLiang的博客
09-01 1022
本节主要介绍J.U.C包中的几种并发安全集合：ConcurrentHashMap,ConcurrentLinkedQueue,和ConcurrentLinkedDeque。所谓并发安全集合，相对于普通集合来说，能够保证在多线程环境下向集合中添加数据时的线程安全性。主要讲ConcurrentHashMap在实现线程安全性方面对性能和安全性的合理平衡。
C++的内存模型
qhu1600417010的博客
08-28 1122
C++ 的内存模型包含了程序运行时如何分配、访问、管理内存的规则，涵盖了多线程环境下的数据一致性、内存对齐、以及虚拟内存管理等内容。掌握这些概念对于编写高效、安全的 C++ 程序至关重要。
优秀的开源项目
猪猪
08-28 572
目录热key多线程并行秒级百G级日志工具ES操作工具消息推送平台HTTP 客户端业务层的分布式限流组件企业级微服务解决方案hotkey: 京东App后台中间件，毫秒级探测热点数据，毫秒级推送至服务器集群内存，大幅降低热key对数据层查询压力asyncTool: 解决任意的多线程并行、串行、阻塞、依赖、回调的并行框架，可以任意组合各线程的执行顺序，带全链路执行结果回调。多线程编排一站式解决方案。来自于京东主App后台。asyncTool: 解决任意的多线程并行、串行、阻塞、依赖、回调的并行框架，可以任意组合各
输入三个正整数，找出不大不小的值
laocooon的博客
08-30 876
/ 找出最大值，找出最小值，然后不是最大值也不是最小值的。// 2、输入三个正整数，找出不大不小的值。
spring-data-redis中RedisRepository仓储
OceanSky的专栏
08-27 496
Id@RedisHash注解的value属性和@Id注解指定键值的命名空间，组合成user:id；@RedisHash的属性timeToLive属性指定键值的超时时间。CrudRepository接口中默认定义实现了save、saveAll、findById、existsById、findAll、findAllById、count、deleteById、delete、deleteAllById、deleteAll等方法，基本满足了对redis操作的需求；如果有特殊需求可以自定义实现。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

问道飞鱼

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值