浅析如何使用xstream实现javaBean与xml互转

2025-05-04 08:47:57 作者：xuTao667

XStream 是一个用于将 Java 对象与 XML 之间进行转换的库,它非常简单易用,下面将详细介绍如何使用 XStream 实现 JavaBean 与 XML 之间的互转,需要的可以了解下

XStream 是一个用于将 Java 对象与 XML 之间进行转换的库。它非常简单易用，适用于快速开发和原型设计。下面将详细介绍如何使用 XStream 实现 JavaBean 与 XML 之间的互转，并提供具体的代码示例。

1. 引入依赖

首先，确保在项目中引入了 XStream 的依赖。如果使用的是 Maven 构建工具，可以在项目的 pom.xml 文件中添加如下依赖：

<dependency>
    <groupId>com.thoughtworks.xstream</groupId>
    <artifactId>xstream</artifactId>
    <version>1.4.19</version> <!-- 检查是否有更新版本 -->
</dependency>

2. 定义 JavaBean

假设有一个简单的 Person 类，包含姓名、年龄和地址信息：

public class Person {
    private String name;
    private int age;
    private Address address;
 
    // Getters and Setters
 
    @Override
    public String toString() {
        return "Person{" +
                "name='" + name + '\'' +
                ", age=" + age +
                ", address=" + address +
                '}';
    }
 
    public static class Address {
        private String street;
        private String city;
        private String state;
 
        // Getters and Setters
 
        @Override
        public String toString() {
            return "Address{" +
                    "street='" + street + '\'' +
                    ", city='" + city + '\'' +
                    ", state='" + state + '\'' +
                    '}';
        }
    }
}

3. JavaBean 转 XML

使用 XStream 将 Person 对象转换为 XML 字符串：

import com.thoughtworks.xstream.XStream;
 
public class JavaBeanToXmlExample {
    public static void main(String[] args) {
        // 创建 Person 对象
        Person.Address address = new Person.Address();
        address.setStreet("123 Main St");
        address.setCity("Anytown");
        address.setState("Anystate");
 
        Person person = new Person();
        person.setName("John Doe");
        person.setAge(30);
        person.setAddress(address);
 
        // 创建 XStream 实例
        XStream xstream = new XStream();
 
        // 将 JavaBean 转换为 XML
        String xml = xstream.toXML(person);
 
        // 输出 XML
        System.out.println(xml);
    }
}

4. XML 转 JavaBean

使用 XStream 将 XML 字符串转换为 Person 对象：

import com.thoughtworks.xstream.XStream;
 
public class XmlToJavaBeanExample {
    public static void main(String[] args) {
        // XML 字符串
        String xml = "<person>\n" +
                     "  <name>John Doe</name>\n" +
                     "  <age>30</age>\n" +
                     "  <address>\n" +
                     "    <street>123 Main St</street>\n" +
                     "    <city>Anytown</city>\n" +
                     "    <state>Anystate</state>\n" +
                     "  </address>\n" +
                     "</person>";
 
        // 创建 XStream 实例
        XStream xstream = new XStream();
 
        // 将 XML 转换为 JavaBean
        Person person = (Person) xstream.fromXML(xml);
 
        // 输出 JavaBean
        System.out.println(person);
    }
}

5. 自定义标签名称

默认情况下，XStream 会使用类名和字段名作为 XML 标签名称。如果想自定义标签名称，可以使用注解或配置方法。

使用注解

import com.thoughtworks.xstream.annotations.XStreamAlias;
 
@XStreamAlias("person")
public class Person {
    @XStreamAlias("full-name")
    private String name;
    @XStreamAlias("age-in-years")
    private int age;
    @XStreamAlias("address-info")
    private Address address;
 
    // Getters and Setters
 
    @Override
    public String toString() {
        return "Person{" +
                "name='" + name + '\'' +
                ", age=" + age +
                ", address=" + address +
                '}';
    }
 
    @XStreamAlias("address")
    public static class Address {
        @XStreamAlias("street-address")
        private String street;
        @XStreamAlias("city-name")
        private String city;
        @XStreamAlias("state-code")
        private String state;
 
        // Getters and Setters
 
        @Override
        public String toString() {
            return "Address{" +
                    "street='" + street + '\'' +
                    ", city='" + city + '\'' +
                    ", state='" + state + '\'' +
                    '}';
        }
    }
}

使用配置方法

import com.thoughtworks.xstream.XStream;
 
public class CustomTagExample {
    public static void main(String[] args) {
        // 创建 Person 对象
        Person.Address address = new Person.Address();
        address.setStreet("123 Main St");
        address.setCity("Anytown");
        address.setState("Anystate");
 
        Person person = new Person();
        person.setName("John Doe");
        person.setAge(30);
        person.setAddress(address);
 
        // 创建 XStream 实例
        XStream xstream = new XStream();
 
        // 配置自定义标签名称
        xstream.alias("person", Person.class);
        xstream.alias("address", Person.Address.class);
        xstream.aliasField("full-name", Person.class, "name");
        xstream.aliasField("age-in-years", Person.class, "age");
        xstream.aliasField("address-info", Person.class, "address");
        xstream.aliasField("street-address", Person.Address.class, "street");
        xstream.aliasField("city-name", Person.Address.class, "city");
        xstream.aliasField("state-code", Person.Address.class, "state");
 
        // 将 JavaBean 转换为 XML
        String xml = xstream.toXML(person);
 
        // 输出 XML
        System.out.println(xml);
    }
}

知识延展

使用xstream实现对象与XML互相转换

依赖

       <dependency>
            <groupId>com.thoughtworks.xstream</groupId>
            <artifactId>xstream</artifactId>
            <version>1.4.18</version>
        </dependency>

实体类

package com.itheima.util;
 
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
 
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Person {
    private String name;
    private int age;
}

工具类

package com.aircas.util;
 
import com.thoughtworks.xstream.XStream;
import java.io.BufferedWriter;
import java.io.IOException;
import java.io.StringWriter;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
 
public class XmlUtils {
 
    private static final XStream xStream = new XStream();
 
    static {
        // 允许反序列化
        xStream.allowTypesByWildcard(new String[] { "**" });
    }
 
    /**
     * 将 Java 对象转换为 XML，并写入指定文件。
     *
     * @param <T>     要转换的 Java 对象类型
     * @param object  要转换的 Java 对象
     * @param filePath 输出的 XML 文件路径
     */
    public static <T> void objectToXml(T object, String filePath) {
        // 为对象定义 XML 别名
        xStream.alias(object.getClass().getSimpleName(), object.getClass());
 
        StringWriter stringWriter = new StringWriter();
        stringWriter.append("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n");
 
        // 将对象转为 XML 字符串
        xStream.toXML(object, stringWriter);
 
        // 获取文件路径
        Path path = Paths.get(filePath);
 
        // 使用 NIO 的 BufferedWriter 将 XML 字符串写入文件
        try (BufferedWriter writer = Files.newBufferedWriter(path, StandardCharsets.UTF_8)) {
            writer.write(stringWriter.toString());
            System.out.println("XML 内容已成功写入到文件：" + path.toString());
        } catch (IOException e) {
            System.err.println("写入 XML 文件时发生错误: " + e.getMessage());
            e.printStackTrace();
        }
    }
 
    /**
     * 从 XML 文件中读取数据并转换为 Java 对象。
     *
     * @param filePath XML 文件路径
     * @param clazz    要转换为的 Java 类
     * @param <T>      转换后的对象类型
     * @return 转换后的 Java 对象，如果读取或转换失败则返回 null
     */
    public static <T> T xmlToObject(String filePath, Class<T> clazz) {
        Path path = Paths.get(filePath);
 
        // 验证文件是否存在
        if (!Files.exists(path)) {
            System.err.println("指定的文件不存在: " + filePath);
            return null;
        }
 
        try {
            String xml = new String(Files.readAllBytes(path), StandardCharsets.UTF_8);
            xStream.alias(clazz.getSimpleName(), clazz); // 为目标类定义别名
            return (T) xStream.fromXML(xml); // 直接从 XML 字符串转换
        } catch (IOException e) {
            System.err.println("读取 XML 文件时发生错误: " + e.getMessage());
            e.printStackTrace();
        } catch (ClassCastException e) {
            System.err.println("转换 XML 数据时发生错误: " + e.getMessage());
            e.printStackTrace();
        }
 
        return null;
    }
}

测试

package com.itheima.one;
 
import com.itheima.one.XmlUtils;
import com.itheima.util.Person;
 
public class Main {
    public static void main(String[] args) {
        // 假设有一个对象 person，你需要将其转换为 XML
        Person person = new Person("John", 30);
        String filePath = "D:/Desktop/person.xml";
 
        // 调用静态方法将对象转换为 XML 并写入文件
        XmlUtils.objectToXml(person, filePath);
 
        // 从 XML 文件中读取并转换为对象
        Person readPerson = XmlUtils.xmlToObject(filePath, Person.class);
        System.out.println(readPerson);
    }
}

输出结果：

XML 内容已成功写入到文件：D:\Desktop\person.xml
Person(name=John, age=30)
D:/Desktop/person.xml文件内容：
<?xml version="1.0" encoding="UTF-8"?>
<Person>
<name>John</name>
<age>30</age>
</Person>

总结

JavaBean 转 XML：使用 XStream 的 toXML 方法将 Java 对象转换为 XML 字符串。

XML 转 JavaBean：使用 XStream 的 fromXML 方法将 XML 字符串转换为 Java 对象。

自定义标签名称：可以使用注解或配置方法来自定义 XML 标签名称。

以上就是浅析如何使用xstream实现javaBean与xml互转的详细内容，更多关于javaBean与xml互转的资料请关注脚本之家其它相关文章！