Spring Boot集成xstream快速入门demo

1.什么是xstream？

XStream 是一个简单的基于 Java 库，Java 对象序列化到 XML，反之亦然 (即：可以轻易的将 Java 对象和 xml 文档相互转换)。

XStream 特点

• 使用方便 - XStream 的 API 提供了一个高层次外观，以简化常用的用例。
• 无需创建映射 - XStream 的 API 提供了默认的映射大部分对象序列化。
• 性能 - XStream 快速和低内存占用，适合于大对象图或系统。
• 干净的 XML - XStream 创建一个干净和紧凑 XML 结果，这很容易阅读。
• 不需要修改对象 - XStream 可序列化的内部字段，如私有和最终字段，支持非公有制和内部类。默认构造函数不是强制性的要求。
• 完整对象图支持 - XStream 允许保持在对象模型中遇到的重复引用，并支持循环引用。
• 可自定义的转换策略 - 定制策略可以允许特定类型的定制被表示为 XML 的注册。
• 安全框架 - XStream 提供了一个公平控制有关解组的类型，以防止操纵输入安全问题。
• 错误消息 - 出现异常是由于格式不正确的 XML 时，XStream 抛出一个统一的例外，提供了详细的诊断，以解决这个问题。
• 另一种输出格式 - XStream 支持其它的输出格式，如 JSON。

2.XStream 基本使用

创建 XStream 对象

通过它传递一个 StaxDriver 创建 XStream 对象。 StaxDriver 使用 SAX 解析器 (可从 Java6)，一个快速的 XML 解析器。

XStream xstream = new XStream(new StaxDriver());

序列化对象到 XML

使用 toXML () 方法来获取对象的 XML 字符串表示。

String xml = xstream.toXML(student);

反序列化 XML 获得对象

使用 fromXML () 方法来从 XML 对象。

Student student1 = (Student)xstream.fromXML(xml);

3.代码工程

实验目标

实现java对象转xml

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>springboot-demo</artifactId>
        <groupId>com.et</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
 
    <artifactId>xstream</artifactId>
 
    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>
    <dependencies>
 
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
 
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>com.thoughtworks.xstream</groupId>
            <artifactId>xstream</artifactId>
            <version>1.4.19</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
 
    </dependencies>
</project>

controller

package com.et.xstream;
 
import com.thoughtworks.xstream.XStream;
import com.thoughtworks.xstream.io.xml.DomDriver;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
import java.util.HashMap;
import java.util.Map;
 
@RestController
public class HelloWorldController {
    @RequestMapping(value = "/hello" ,produces = {"application/xml;"})
    public String showHelloWorld(){
        Employee e1 = new Employee("Sanyog", "Gautam", 1000,
                19, "Male");
 
        // Serializing a Java object into XML
        XStream xStream = new XStream(new DomDriver());
        String xml = xStream.toXML(e1); // Converting it to XML
 
        return xml;
    }
}

entity

package com.et.xstream;
 
import lombok.Getter;
 
@Getter
public class Employee { 
   private String firstName; 
   private String lastName; 
   private int salary; 
   private int age; 
   private String gender; 
 
   public Employee(String firstName, String lastName, 
               int salary, int age, String gender) 
   { 
      this.firstName = firstName; 
      this.lastName = lastName; 
      this.salary = salary; 
      this.age = age; 
      this.gender = gender; 
   } 
}

DemoApplication.java

package com.et.xstream;
 
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
 
@SpringBootApplication
public class DemoApplication {
 
   public static void main(String[] args) {
      SpringApplication.run(DemoApplication.class, args);
   }
}

以上只是一些关键代码，所有代码请参见下面代码仓库

代码仓库

• GitHub - Harries/springboot-demo: a simple springboot demo with some components for example: redis,solr,rockmq and so on.

4.测试

• 启动Spring Boot应用
• 访问http://127.0.0.1:8088/hello

5.引用

• 官网说明：XStream - About XStream
• GitHub：GitHub - x-stream/xstream: Serialize Java objects to XML and back again.
• JavaDoc：XStream Core 1.4.20 API
• Spring Boot集成xstream快速入门demo | Harries Blog™