XStream实现Java对象到xml的相互转换

使用xStream实现xml和object的相互转换  

官方地址：http://x-stream.github.io/index.html

1.xStream的依赖

<!-- https://mvnrepository.com/artifact/com.thoughtworks.xstream/xstream --> 
<dependency> 
    <groupId>com.thoughtworks.xstream</groupId> 
    <artifactId>xstream</artifactId> 
    <version>1.4.11.1</version> 
</dependency>

2.object到xml的转换

例如有java类如下：

// 1.Person
public class Person
{
    private String name;
    private int age;
    private boolean sex;
    private Job job;
    // getter、setter省略
}
// 2. Job
public class Job
{
    private String jobName;
    private int jobLife;
    // getter、setter省略
}

新建java对象：

Job job = new Job();
job.setJobName("it");
job.setJobLife(4);
Person p = new Person();
p.setName("zs");
p.setAge(6);
p.setSex(true);
p.setJob(job);

使用xStream生成xml：

XStream xStream =new XStream();
String xml = xStream.toXML(p);
System.out.println(xml);

得到结果：

 

我们看到Person类转化为xml后标签为com.app.model.Person全类名，我们希望能够简化为简单的Person标签，这时候就使用到xStream的alias(别名)设置

使用别名：

(1) xStream的别名设置方法：

类别名：xStream.alias("Person", Person.class);// 别名，类

字段别名：xStream.aliasField("jobInfo", Person.class, "job");// 别名，类，要设置别名的字段

// 解释：给Person设置别名Person，给Person类中的job属性设置别名jobInfo

(2) 注解方式：

在Person类上加注解：@XStreamAlias("Person")

在job属性上加注解：@XStreamAlias("jobInfo")

读取类中的注解：xStream.processAnnotations(Person.class);

上述两种方式均可得到结果：

 

3.xml到object的转换

例如有xml文件Person.xml：

<?xml version="1.0" encoding="UTF-8"?>
<Person>
  <name>zs</name>
  <age>6</age>
  <sex>true</sex>
  <jobInfo>
    <jobName>it</jobName>
    <jobLife>4</jobLife>
  </jobInfo>
</Person>

使用xStream读取xml：

XStream xStream = new XStream();
XStream.setupDefaultSecurity(xStream);// 设置安全权限
xStream.allowTypes(new Class[] {Person.class});// 设置可转换类型
xStream.processAnnotations(Person.class);
Person p = (Person)xStream.fromXML(new File("E:/Person.xml"));

得到Person对象：

4.多个同名标签到集合的转换@XStreamImplicit

例如有xml：

<?xml version="1.0" encoding="UTF-8"?>
<Person>
    <name>zs</name>
    <age>6</age>
    <sex>true</sex>
    <jobInfo>
        <jobName>it</jobName>
        <jobLife>4</jobLife>
    </jobInfo>
    <jobInfo>
        <jobName>it</jobName>
        <jobLife>3</jobLife>
    </jobInfo>
    <jobInfo>
        <jobName>it</jobName>
        <jobLife>2</jobLife>
    </jobInfo>
</Person>

 

使用@XStreamImplicit(itemFieldName = "jobInfo")将多个jobInfo标签转换为Job集合，如下：

@XStreamAlias("Person")
public class Person
{
    private String name;
    private int age;
    private boolean sex;
    @XStreamImplicit(itemFieldName = "jobInfo")
    private List<Job> jobs;
}

5.标签属性的读取@XStreamAsAttribute

例如有xml：

<?xml version="1.0" encoding="UTF-8"?>
<Person>
    <name>zs</name>
    <age>6</age>
    <sex>true</sex>
    <jobInfo status="online">
        <jobName>it</jobName>
        <jobLife>4</jobLife>
    </jobInfo>
</Person>

在Job类中使用@XStreamAsAttribute读取属性值

public class Job
{
    @XStreamAsAttribute
    private String status;
    private String jobName;
    private int jobLife;
}

若属性名带有下划线_，则要增加配置：

XStream xstream = new XStream(new XppDriver(new XmlFriendlyNameCoder("_-", "_")));

6.读取标签属性值和标签内的值

例如有xml：

<?xml version="1.0" encoding="UTF-8"?>
<Person>
    <name>zs</name>
    <age>6</age>
    <sex>true</sex>
    <jobInfo status="online">it</jobInfo>
</Person>

使用@XStreamAsAttribute获取属性值

使用XStream的转换器ToAttributedValueConverter获取标签内的值

@XStreamConverter(value = ToAttributedValueConverter.class, strings = {"value"})
public class Job
{
    @XStreamAsAttribute
    private String status;
    private String value;
}

 

封装的转换方法：

public static <T> T xml2Bean(Class<T> clazz, String xml)
{
    T obj = null;
    if (!StringUtils.isEmpty(xml))
    {
        XStream xstream = new XStream(new XppDriver(new XmlFriendlyNameCoder("_-", "_")));// 解决java_下划线转义异常问题
        XStream.setupDefaultSecurity(xstream);
        xstream.setClassLoader(XsteamUtil.class.getClassLoader());
        xstream.allowTypes(new Class[] {...});// 设置可转换类型
        // xstream.allowTypes(new Class[] {clazz});
        xstream.processAnnotations(clazz);
        xstream.autodetectAnnotations(true);
        obj = (T)xstream.fromXML(xml);
    }
    return obj;
}

2020.11.04发现在springboot jar包部署环境下会报类型转换异常，原因是springboot项目中不是使用的默认classloader，解决方案重设xStream的classloader。

xstream.setClassLoader(XsteamUtil.class.getClassLoader());