XStream常用功能应用

最新推荐文章于 2024-03-13 10:48:33 发布

eleganthua

最新推荐文章于 2024-03-13 10:48:33 发布

阅读量831

点赞数

分类专栏： XStream 文章标签： xml

本文链接：https://blog.csdn.net/eleganthua/article/details/120862904

版权

XStream 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

XStream常用功能应用

一. XStream官网

 http://x-stream.github.io

二. XStream介绍

XStream在运行时使用Java反射机制对要进行序列化的对象树的结构进行探索，并不需要对对象作出修改。XStream可以序列化内部字段，包括私private和final字段，并且支持非公开类以及内部类。

在缺省情况下，XStream不需要配置映射关系，对象和字段将映射为同名XML元素。但是当对象和字段名与XML中的元素名不同时，XStream支持指定别名。XStream支持以方法调用的方式，或是Java 标注的方式指定别名。

XStream在进行数据类型转换时，使用系统缺省的类型转换器。同时，也支持用户自定义的类型转换器。

三. XStream的简单使用

添加XStream依赖

<dependency>
    <groupId>com.thoughtworks.xstream</groupId>
    <artifactId>xstream</artifactId>
    <version>1.4.12</version>
</dependency>
 <dependency>
    <groupId>org.codehaus.jettison</groupId>
    <artifactId>jettison</artifactId>
    <version>1.4.1</version>
</dependency>

XStream的简单例子
```
XML序列化
```

@Data
class Department {
   private String name;
   private Integer account;
   private String manager;
}
@Slf4j
public class XStreamService {
    @Test
    public void beanToXmlTest(){
        Department department = new Department();
        department.setName("技术部");
        department.setAccount(new Integer("18"));
        department.setManager("艾达");
        XStream xStream = new XStream();
        xStream.processAnnotations(Department.class);
        String xml = xStream.toXML(department);
        log.info("序列化：\n{}", xml);

        Department department1 = (Department)xStream.fromXML(xml);
        log.info("反序列化：\n{}", department1);
    }
}
//执行结果
XML序列化：
<Department>
  <name>技术部</name>
  <account>18</account>
  <manager>艾达</manager>
</Department>

XML反序列化：
Department(name=技术部, account=18, manager=艾达)

Json序列化

@Data
class Department {
     private String name;
     private Integer account;
     private String manager;
 }
@Slf4j
public class XStreamService {
    @Test
    public void beanToJsonString(){
        Department department = new Department();
        department.setName("技术部");
        department.setAccount(new Integer("18"));
        department.setManager("艾达");
        XStream xStream = new XStream(new JettisonMappedXmlDriver());
        xStream.setMode(XStream.NO_REFERENCES);
        String json = xStream.toXML(department);
        log.info("Json序列化：\n{}", json);

        Department department1 = (Department)xStream.fromXML(json);
        log.info("Json反序列化：\n{}", department1);
    }
}
//执行结果
Json序列化：
{"com.dayday.up.store.service.biz.bo.Department":{"name":"技术部","account":18,"manager":"艾达"}}

Json反序列化：
Department(name=技术部, account=18, manager=艾达)

三. XStream的基础使用

（一）节点重命名

XStram 的 alias()、aliasField() 方法的简单使用
说明：
（1）alias(String name, Class type)是用来给父节点重命名
（2）aliasField(String alias, Class definedIn, String fieldName)是用来给子节点重命名

@Data
public class Department {
    private String name;
    private Integer account;
    private String manager;
}
@Slf4j
public class XStreamService {
   @Test
    public void beanToXml(){
        Department department = new Department2();
        department.setName("技术部");
        department.setAccount(new Integer("19"));
        department.setManager("艾迪");
        XStream xStream = new XStream();
        xStream.processAnnotations(Department.class);
        xStream.alias("DEPARTMENT", Department.class);
        xStream.aliasField("NAME", Department.class,"name");
        xStream.aliasField("ACCOUNT", Department.class,"account");
        xStream.aliasField("MANAGE", Department.class,"manager");
        String xml = xStream.toXML(department);
        log.info("XML序列化：\n{}", xml);
    }
}
//运行结果
XML序列化：
<DEPARTMENT>
  <NAME>技术部</NAME>
  <ACCOUNT>19</ACCOUNT>
  <MANAGE>艾迪</MANAGE>
</DEPARTMENT>

@XStreamAlias的简单使用
说明： @XStreamAlias注解的使用，该注解主要是用来重命名每个节点名称，功能等于XStream中的方法alias()、aliasField()

@Data
@XStreamAlias(value = "department")
public class Department {
    @XStreamAlias(value = "name")
    private String name;
    @XStreamAlias(value = "account")
    private Integer account;
    @XStreamAlias(value = "manager")
    private String manager;
}
@Slf4j
public class XStreamService {
    @Test
    public void beanToXmlTest(){
        Department department = new Department();
        department.setName("技术部");
        department.setAccount(new Integer("19"));
        department.setManager("艾迪");
        XStream xStream = new XStream();
        xStream.processAnnotations(Department.class);
        String xml = xStream.toXML(department);
        log.info("XML序列化：\n{}", xml);
    }
}
//运行结果
XML序列化：
<department>
  <name>技术部</name>
  <account>18</account>
  <manager>艾达</manager>
</department>

（二）为节点设置属性

使用useAttributeFor()方法

 @Data
@XStreamAlias(value = "department")
public class Department {
    @XStreamAlias(value = "company")
    private String company;
    @XStreamAlias(value = "name")
    private String name;
    @XStreamAlias(value = "account")
    private Integer account;
    @XStreamAlias(value = "manager")
    private String manager;
}
@Slf4j
public class XStreamService {
    @Test
    public void beanAndXml(){
        Department department = new Department();
        department.setName("技术部");
        department.setAccount(new Integer("21"));
        department.setManager("艾迪");
        department.setCompany("广州唯品会");

        XStream xStream = new XStream();
        xStream.processAnnotations(Department.class);
        xStream.useAttributeFor(Department.class,"company");
        String xml = xStream.toXML(department);
        log.info("XML序列化：\n{}", xml);
    }
}
XML序列化：
<department company="广州唯品会">
  <name>技术部</name>
  <account>22</account>
  <manager>艾迪</manager>
</department>

使用@XStreamAsAttribute注解

@Data
@XStreamAlias(value = "department")
public class Department {
    @XStreamAsAttribute
    @XStreamAlias(value = "company")
    private String company;
    @XStreamAlias(value = "name")
    private String name;
    @XStreamAlias(value = "account")
    private Integer account;
    @XStreamAlias(value = "manager")
    private String manager;
}

@Slf4j
public class XStreamService{
    @Test
    public void beanAndXml(){
        Department department = new Department();
        department.setName("技术部");
        department.setAccount(new Integer("22"));
        department.setManager("艾迪");
        department.setCompany("广州唯品会");

        XStream xStream = new XStream();
        xStream.processAnnotations(Department.class);
        String xml = xStream.toXML(department);
        log.info("XML序列化：\n{}", xml);
    }
}
XML序列化：
<department company="广州唯品会">
  <name>技术部</name>
  <account>22</account>
  <manager>艾迪</manager>
</department>

（三）忽略集合根节点

使用addImplicitCollection() 方法忽略集合根节点

@Data
@XStreamAlias(value = "department")
public class Department {
    @XStreamAsAttribute
    @XStreamAlias(value = "company")
    private String company;
    @XStreamAlias(value = "name")
    private String name;
    @XStreamAlias(value = "account")
    private Integer account;
    @XStreamAlias(value = "manager")
    private String manager;
    @XStreamAlias(value = "employeeList")
    private List<Employee> employeeList;
}
@Data
@XStreamAlias("employee")
public class Employee {
    @XStreamAlias("name")
    private String name;
    @XStreamAlias("position")
    private String position;
    public Employee(String name, String position) {
        this.name = name;
        this.position = position;
    }
}
@Slf4j
public class XStreamService {
    @Test
    public void beanAndXml(){
        Department department = new Department();
        department.setName("技术部");
        department.setAccount(new Integer("22"));
        department.setManager("艾迪");
        department.setCompany("广州唯品会");

        Employee employee = new Employee("张三","开发");
        Employee employee1 = new Employee("李四","测试");
        List<Employee> employeeList = new ArrayList<>();
        employeeList.add(employee);
        employeeList.add(employee1);
        department.setEmployeeList(employeeList);
        XStream xStream = new XStream();
        xStream.processAnnotations(Department.class);
        xStream.addImplicitCollection(Department.class,"employeeList");
        String xml = xStream.toXML(department);
        log.info("XML序列化：\n{}", xml);
    }
}
//执行结果，没有生成节点employeeList
XML序列化：
<department company="广州唯品会">
  <name>技术部</name>
  <account>22</account>
  <manager>艾迪</manager>
  <employee>
    <name>张三</name>
    <position>开发</position>
  </employee>
  <employee>
    <name>李四</name>
    <position>测试</position>
  </employee>
</department>

用@XStreamImplicit注解忽略集合根节点

@Data
@XStreamAlias(value = "department")
public class Department {
    @XStreamAsAttribute
    @XStreamAlias(value = "company")
    private String company;
    @XStreamAlias(value = "name")
    private String name;
    @XStreamAlias(value = "account")
    private Integer account;
    @XStreamAlias(value = "manager")
    private String manager;
    @XStreamAlias(value = "employeeList")
    @XStreamImplicit
    private List<Employee> employeeList;
}
@Data
@XStreamAlias("employee")
public class Employee {
    @XStreamAlias("name")
    private String name;
    @XStreamAlias("position")
    private String position;
    public Employee(String name, String position) {
        this.name = name;
        this.position = position;
    }
}
@Slf4j
public class XStreamService {
    @Test
    public void beanAndXml(){
        Department department = new Department();
        department.setName("技术部");
        department.setAccount(new Integer("22"));
        department.setManager("艾迪");
        department.setCompany("广州唯品会");

        Employee employee = new Employee("张三","开发");
        Employee employee1 = new Employee("李四","测试");
        List<Employee> employeeList = new ArrayList<>();
        employeeList.add(employee);
        employeeList.add(employee1);
        department.setEmployeeList(employeeList);
        XStream xStream = new XStream();
        xStream.processAnnotations(Department.class);
        String xml = xStream.toXML(department);
        log.info("XML序列化：\n{}", xml);
    }
}
//执行结果，没有生成节点employeeList
XML序列化：
<department company="广州唯品会">
  <name>技术部</name>
  <account>22</account>
  <manager>艾迪</manager>
  <employee>
    <name>张三</name>
    <position>开发</position>
  </employee>
  <employee>
    <name>李四</name>
    <position>测试</position>
  </employee>
</department>

（四）隐藏某个节点

使用omitField() 方法隐藏

@Data
@XStreamAlias(value = "department")
public class Department {
    @XStreamAsAttribute
    @XStreamAlias(value = "company")
    private String company;
    @XStreamAlias(value = "name")
    private String name;
    @XStreamAlias(value = "account")
    private Integer account;
    @XStreamAlias(value = "manager")
    private String manager;
}
@Slf4j
public class XStreamService {
    @Test
    public void beanAndXml(){
        Department department = new Department();
        department.setName("技术部");
        department.setAccount(new Integer("26"));
        department.setManager("艾迪");
        department.setCompany("广州唯品会");

        XStream xStream = new XStream();
        xStream.processAnnotations(Department.class);
        xStream.omitField(Department.class, "account");
        String xml = xStream.toXML(department);
        log.info("XML序列化：\n{}", xml);
    }
}
//执行结果，没有生成account节点
XML序列化：
<department company="广州唯品会">
  <name>技术部</name>
  <manager>艾迪</manager>
</department>

使用@XStreamOmitField注解隐藏

@Data
@XStreamAlias(value = "department")
public class Department {
    @XStreamAsAttribute
    @XStreamAlias(value = "company")
    private String company;
    @XStreamAlias(value = "name")
    private String name;
    @XStreamAlias(value = "account")
    @XStreamOmitField
    private Integer account;
    @XStreamAlias(value = "manager")
    private String manager;
}
@Slf4j
public class XStreamService {
    @Test
    public void beanAndXml(){
        Department department = new Department();
        department.setName("技术部");
        department.setAccount(new Integer("26"));
        department.setManager("艾迪");
        department.setCompany("广州唯品会");

        XStream xStream = new XStream();
        xStream.processAnnotations(Department.class);
        String xml = xStream.toXML(department);
        log.info("XML序列化：\n{}", xml);
    }
}
//执行结果，没有生成account节点
XML序列化：
<department company="广州唯品会">
  <name>技术部</name>
  <manager>艾迪</manager>
</department>

链接：

https://www.yiibai.com/xstream
https://www.cnblogs.com/LiZhiW/p/4313493.html

eleganthua

关注

0
点赞
踩
3

收藏

觉得还不错? 一键收藏
0
评论
XStream常用功能应用

XStream的使用一. XStream官网二. XStream介绍三. XStream的简单使用三. XStream的基础使用（一）节点重命名（二）为节点设置属性（三）忽略跟节点一. XStream官网 http://x-stream.github.io二. XStream介绍XStream在运行时使用Java反射机制对要进行序列化的对象树的结构进行探索，并不需要对对象作出修改。XStream可以序列化内部字段，包括私private和final字段，并且支持非公开类以及内部类。在缺省情况下，X
复制链接

扫一扫