Home > Backend Development > XML/RSS Tutorial > Detailed explanation of sample code of xml parsing toolkit Xstream

Detailed explanation of sample code of xml parsing toolkit Xstream

黄舟
Release: 2017-03-08 16:29:59
Original
2659 people have browsed it

Features

  1. Simplified API;

  2. No mapping files;

  3. High performance , low memory usage;

  4. Neat XML;

  5. No need to modify objects, supports internal private fields;

  6. No need for setter/getter methods, final fields;

  7. Provide serialization interface;

  8. Custom conversion type strategy;

  9. Detailed error diagnosis;

Xstream common annotations

@XStreamAlias("message") Alias ​​annotation, target : Class, field

@XStreamImplicit implicit collection

@XStreamImplicit(itemFieldName="part") Target: collection field

@XStreamConverter(SingleValueCalendarConverter.class) Injection conversion Converter, target: object

@XStreamAsAttribute Convert to attribute, target: field

@XStreamOmitField Ignore field, target: field

Example

1. Parse XML tool class

import com.thoughtworks.xstream.XStream;
import com.thoughtworks.xstream.io.xml.DomDriver;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.*;

/**
 * 输出xml和解析xml的工具类
 */
public class XmlUtil {
    private static final Logger logger = LoggerFactory.
            getLogger(XmlUtil.class);

    /**
     * java 转换成xml
     * @param obj 对象实例
     * @return String xml字符串
     * @Title: toXml
     * @Description: TODO
     */
    public static String toXml(Object obj) {
        //XStream xstream=new XStream(); //默认使用xpp解析器
        //指定编码解析器
        XStream xstream = new XStream(new DomDriver("utf-8"));
        //启用注解识别
        xstream.processAnnotations(obj.getClass());
        return xstream.toXML(obj);
    }

    /**
     * 将传入xml文本转换成Java对象
     * @param xmlStr
     * @param cls xml对应的class类
     * @return T  xml对应的class类的实例对象
     */
    public static <T> T toBean(String xmlStr, Class<T> cls) {
        XStream xstream = new XStream();
        xstream.processAnnotations(cls);
        T obj = (T) xstream.fromXML(xmlStr);
        return obj;
    }

    /**
     * 写到xml文件中去
     * @param obj      对象
     * @param absPath  绝对路径
     * @param fileName 文件名
     */
    public static boolean toXMLFile(Object obj, String absPath, String fileName) {
        String strXml = toXml(obj);
        String filePath = absPath + fileName;
        File file = new File(filePath);
        if (!file.exists()) {
            try {
                file.createNewFile();
            } catch (IOException e) {
                logger.error("file creation failed, cause is {}", e);
                return false;
            }
        }
        OutputStream ous = null;
        try {
            ous = new FileOutputStream(file);
            ous.write(strXml.getBytes());
            ous.flush();
        } catch (Exception e1) {
            logger.error("file write failed, cause is {}", e1);
            return false;
        } finally {
            if (ous != null)
                try {
                    ous.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
        }
        return true;
    }

    /**
     * 从xml文件读取报文
     * @param absPath  绝对路径
     * @param fileName 文件名
     * @param cls
     */
    public static <T> T toBeanFromFile(String absPath, String fileName, Class<T> cls) throws Exception {
        String filePath = absPath + fileName;
        InputStream ins = null;
        try {
            ins = new FileInputStream(new File(filePath));
        } catch (Exception e) {
            throw new Exception("read {" + filePath + "} file failed!", e);
        }
        XStream xstream = new XStream();
        xstream.processAnnotations(cls);
        T obj = null;
        try {
            obj = (T) xstream.fromXML(ins);
        } catch (Exception e) {
            throw new Exception("parse {" + filePath + "} file failed!", e);
        }
        if (ins != null)
            ins.close();
        return obj;
    }
}
Copy after login

2. Write Teacher class

import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.annotations.XStreamAsAttribute;
import com.thoughtworks.xstream.annotations.XStreamImplicit;
import java.util.List;

@XStreamAlias(value = "teacher")
public class Teacher {
    @XStreamAsAttribute
    private String name;
    @XStreamAsAttribute
    private String phone;
    @XStreamAsAttribute
    private int age;
    @XStreamImplicit(itemFieldName = "student")
    private List<Student> students;

    public Teacher() {
    }

    public Teacher(String name, String phone, int age, List<Student> students) {
        this.name = name;
        this.phone = phone;
        this.age = age;
        this.students = students;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getPhone() {
        return phone;
    }

    public void setPhone(String phone) {
        this.phone = phone;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public List<Student> getStudents() {
        return students;
    }

    public void setStudents(List<Student> students) {
        this.students = students;
    }
}
Copy after login

3. Write Student class

import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.annotations.XStreamAsAttribute;
@XStreamAlias(value = "student")
public class Student {
    @XStreamAsAttribute
    private String name;
    @XStreamAsAttribute
    private int age;
    @XStreamAsAttribute
    private String address;

    public Student() {
    }

    public Student(String name, int age, String address) {
        this.name = name;
        this.age = age;
        this.address = address;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public String getAddress() {
        return address;
    }

    public void setAddress(String address) {
        this.address = address;
    }
}
Copy after login

4. Test test class

import java.util.ArrayList;
import java.util.List;

public class Test {
    public static void main(String[] args) {
        Student student1 = new Student("Aaron", 24, "广州");
        Student student2 = new Student("Abel", 23, "北京");
        List<Student> students = new ArrayList<>();
        students.add(student1);
        students.add(student2);
        Teacher teacher = new Teacher("Dave", "020-123456", 46, students);
        String xml = XmlUtil.toXml(teacher);
        System.out.println(xml);
    }
}
Copy after login

5 . Running results

<teacher name="Dave" phone="020-123456" age="46">
  <student name="Aaron" age="24" address="广州"/>
  <student name="Abel" age="23" address="北京"/>
</teacher>
Copy after login


The above is the detailed content of Detailed explanation of sample code of xml parsing toolkit Xstream. For more information, please follow other related articles on the PHP Chinese website!

Related labels:
source:php.cn
Statement of this Website
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn
Popular Tutorials
More>
Latest Downloads
More>
Web Effects
Website Source Code
Website Materials
Front End Template