java基础开发-xstream解析xml

2024-09-01 02:04

本文主要是介绍java基础开发-xstream解析xml,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

文章目录

    • XStream 的基本使用步骤
      • 高级用法
        • 自定义别名
        • 忽略某些字段
        • 自定义转换器
        • 类型安全
      • 示例
    • XStream常见注解
      • 安装 JAnnotate-XStream
      • 使用 JAnnotate-XStream 注解
        • 1. `@XStreamAlias`
        • 2. `@XStreamAsAttribute`
        • 3. `@XStreamOmitField`
        • 4. `@XStreamConverter`
        • 5. `@XStreamImplicit`
      • 示例代码
      • 使用 XStream 没有注解的情况
      • 自定义转换器
      • 总结

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);// 序列化为 XMLString 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;@XStreamAsAttributeprivate int age;// 构造函数、getter 和 setter
    }
    
3. @XStreamOmitField
  • 用途:忽略某个字段,使其不参与序列化过程。
  • 示例
    @XStreamAlias("person")
    public class Person {@XStreamAlias("name")private String name;@XStreamOmitFieldprivate 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;@XStreamAsAttributeprivate 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 {@Overridepublic boolean canConvert(Class<?> type) {return Date.class.isAssignableFrom(type);}@Overridepublic void marshal(Object source, HierarchicalStreamWriter writer, MarshallingContext context) {Date date = (Date) source;writer.setValue(date.toString());}@Overridepublic 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,或者自定义转换器以满足特定需求。

这篇关于java基础开发-xstream解析xml的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1125629

相关文章

网页解析 lxml 库--实战

lxml库使用流程 lxml 是 Python 的第三方解析库,完全使用 Python 语言编写,它对 XPath表达式提供了良好的支 持,因此能够了高效地解析 HTML/XML 文档。本节讲解如何通过 lxml 库解析 HTML 文档。 pip install lxml lxm| 库提供了一个 etree 模块,该模块专门用来解析 HTML/XML 文档,下面来介绍一下 lxml 库

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时,有没有考虑过 JVM 是如何把静态的字节码(byte code)转化为运行时对象的呢,这个问题看似简单,但清楚的同学相信也不会太多,这篇文章首先介绍 JVM 类初始化的机制,然后给出几个易出错的实例来分析,帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段,分别是:loading 、Linking、initialization

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权,允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true (Spring security默认会带有ROLE_前缀),去

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程,特意画了如下的类图,包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口,接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类,它们之间的依赖,构建起了整个框架。想要理解整个架构,最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文(security context)的信息。当前操作的用户是谁,该用户是否已经被认证,他拥有哪些角色权限…这些都被保

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明(认真看哦) AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证,则会调用 #attemptAuthentica

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门(一):登录与退出》 《Spring-Security-入门(二):基于数据库验证》 《Spring-Security-入门(三):密码加密》 《Spring-Security-入门(四):自定义-Filter》 《Spring-Security-入门(五):在 Sprin

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物

这15个Vue指令,让你的项目开发爽到爆

1. V-Hotkey 仓库地址: github.com/Dafrok/v-ho… Demo: 戳这里 https://dafrok.github.io/v-hotkey 安装: npm install --save v-hotkey 这个指令可以给组件绑定一个或多个快捷键。你想要通过按下 Escape 键后隐藏某个组件,按住 Control 和回车键再显示它吗?小菜一碟: <template

Hadoop企业开发案例调优场景

需求 (1)需求:从1G数据中,统计每个单词出现次数。服务器3台,每台配置4G内存,4核CPU,4线程。 (2)需求分析: 1G / 128m = 8个MapTask;1个ReduceTask;1个mrAppMaster 平均每个节点运行10个 / 3台 ≈ 3个任务(4    3    3) HDFS参数调优 (1)修改:hadoop-env.sh export HDFS_NAMENOD