Xstream解析xml文件与对象之间的转换

1.前言

在之前做的项目中有需求需要解析xml文件，发现XStream非常好用，使用也简单，在此做个记录
官方文档：http://x-stream.github.io/download.html

2.依赖

 		<dependency>
            <groupId>com.thoughtworks.xstream</groupId>
            <artifactId>xstream</artifactId>
            <version>1.4.10</version>
        </dependency>
        <dependency>
            <groupId>commons-io</groupId>
            <artifactId>commons-io</artifactId>
            <version>2.4</version>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
            <version>1.18.20</version>
        </dependency>

3.实体类

import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.annotations.XStreamAsAttribute;
import com.thoughtworks.xstream.annotations.XStreamImplicit;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.ToString;
import lombok.experimental.Accessors;

import java.util.List;

@Data
@Accessors(chain = true)
@AllArgsConstructor
@NoArgsConstructor
@XStreamAlias("animal")
@ToString
public class Animal {

    //设置标签别名
    @XStreamAlias("dogs")
    private Dogs dogs;
    //设置标签别名
    @XStreamAlias("having")
    private String having;

    @Data
    @Accessors(chain = true)
    @AllArgsConstructor
    @NoArgsConstructor
    @ToString
    @XStreamAlias("dogs")
    public static class Dogs {

        @XStreamAlias("dog")
        //标记为集合或者数组
        //An annotation for marking a field as an implicit collection or array.
        @XStreamImplicit
        private List<Dog> dog;

    }
    @Data
    @Accessors(chain = true)
    @AllArgsConstructor
    @NoArgsConstructor
    @ToString
    @XStreamAlias("dog")
    public static class Dog {
        /**
         * 标记为标签内的属性
         * <dog id="1" name="小狗"/>
         */

        @XStreamAlias("id")
        @XStreamAsAttribute
        private int id;
        @XStreamAlias("name")
        @XStreamAsAttribute
        private String name;
    }

}

4.解析工具类

import com.learn.demo.mylearnaop.pojo.Animal;
import com.thoughtworks.xstream.XStream;
import com.thoughtworks.xstream.io.xml.DomDriver;
import org.apache.commons.io.FileUtils;

import java.io.*;
import java.util.Arrays;
import java.util.List;
interface XmlResolver<T> {
    XStream builder();

    default T parse(String xml) {
        return (T) builder().fromXML(xml);
    }

    default T serialize(Object obj) {
        return (T) builder().toXML(obj);
    }
}

public class XmlStream<T> implements Serializable {
    XmlResolver xmlResolver;

    public XmlStream() {
        xmlResolver = () -> {
            XStream xStream = new XStream(new DomDriver("UTF-8"));
            XStream.setupDefaultSecurity(xStream);
            xStream.allowTypes(new Class[]{Animal.class, Animal.Dog.class, Animal.Dogs.class});
            xStream.processAnnotations(new Class[]{Animal.class, Animal.Dogs.class, Animal.Dog.class});
            xStream.aliasSystemAttribute(null, "class");
            xStream.aliasSystemAttribute(null, "serialization");
            return xStream;
        };
    }

   

}

5.测试

 public static void main(String[] args) throws IOException {
        XmlStream<Animal> xmlStream = new XmlStream<>();
        Animal animal = new Animal();
        Animal.Dogs dogs = new Animal.Dogs();
        animal.setHaving("吃东西");
        animal.setDogs(dogs);
        List<Animal.Dog> dogList = Arrays.asList(new Animal.Dog(1, "小狗"), new Animal.Dog(2, "小黄狗"));
        dogs.setDog(dogList);
        //将对象转成xml标签
        Object serialize = xmlStream.xmlResolver.serialize(animal);
        FileUtils.writeStringToFile(new File("F:\\xxx\\test.xml"),serialize.toString(),"UTF-8");
        String s = FileUtils.readFileToString(new File("F:\\xxx\\test.xml"), "UTF-8");

        Object parse = xmlStream.xmlResolver.parse(s);
        System.out.println(parse.toString());
    }

6.测试结果

6.1 序列化结果

<animal>
  <dogs>
    <dog id="1" name="小狗"/>
    <dog id="2" name="小黄狗"/>
  </dogs>
  <having>吃东西</having>
</animal>

6.2控制台反序列化结果

Animal(dogs=Animal.Dogs(dog=[Animal.Dog(id=1, name=小狗), Animal.Dog(id=2, name=小黄狗)]), having=吃东西)