XStream 解析 XML 深入剖析

港控/mmm° 2022-03-26 09:10 642阅读 0赞

**目录**

XStream xml 解析概述

XStream 快速入门

Java 对象转 XML 字符串

Java 对象转 xml 文件

XML 转 Java 对象

Alias 别名设置

--------------------

# **XStream xml 解析概述** #

1、XStream 是市面上解析 XML 中非常优秀的第三库之一，可以轻易的将 Java 对象和 xml 文档相互转换，而且可以修改某个特定的属性和节点名称，甚至还支持json的转换；(XStream is a simple library to serialize objects to XML and back again.)

2、XStream相对于XML的意义，就相当于Gson相对于Json的意义

3、创建XSteam对象的方式很简单，只需要new XStream()即可；Java到xml，用toXML()方法；Xml到Java，用fromXML()方法。

<table> 
 <tbody> 
  <tr> 
   <td> <p>1、<span style="color:#4b4b4b;">更多详细介绍可以参看</span>官网：<a href="http://x-stream.github.io/index.html" rel="nofollow">http://x-stream.github.io/index.html</a></p> <p><span style="color:#4b4b4b;">2、官网 2 两分钟简要教程：</span><a href="http://x-stream.github.io/tutorial.html" rel="nofollow">http://x-stream.github.io/tutorial.html</a>（在左侧的 " Tutorials " 标签下）。</p> <p>3、XStream 解析 JSON 的教程：<a href="http://x-stream.github.io/json-tutorial.html" rel="nofollow">http://x-stream.github.io/json-tutorial.html</a></p> <p>4、更多完整的学习路径：<a href="http://www.studytrails.com/java/xml/xstream/xstream-introduction/" rel="nofollow">http://www.studytrails.com/java/xml/xstream/xstream-introduction/</a></p> </td> 
  </tr> 
 </tbody> 
</table>

4、二进制 jar 包官网下载地址：[http://x-stream.github.io/download.html][http_x-stream.github.io_download.html]

<table> 
 <tbody> 
  <tr> 
   <td> <p>DomDriver：纯 Java JDK Dom 解析驱动，此时无需导入额外的 Jar 包，只要导入 xstream、xmlull 两个 jar 包即可</p> <p>Dom4JDriver：dom4j 解析，此时需要额外导入 dom4j-xxx.jar 包</p> <p>XppDriver、XppDomDriver、Xpp3Driver、Xpp3DomDriver：xpp 解析驱动，此时需要额外导入 xpp3_min-xxx.jar 包</p> <p><span style="color:#f33b45;">使用无参默认构造器 XStream()时，默认会使用 XppDriver 解析驱动，所以需要导入 xpp3 包，否则抛异常</span></p> <p><span style="color:#f33b45;">反序列化使用的驱动与序列化时使用的驱动无关，不用一致。</span></p> </td> 
  </tr> 
 </tbody> 
</table>

5、Maven 依赖：

<dependency>
        <groupId>com.thoughtworks.xstream</groupId>
        <artifactId>xstream</artifactId>
        <version>1.4.13</version>
    </dependency>

**constructor：**通常使用默认构造器即可。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdteDE5OTMzMjg_size_16_color_FFFFFF_t_70][]

# **XStream 快速入门** #

1、先准备一个 POJO 对象 User。

import java.util.Date;
    /**
     * Created by Administrator on 2019/1/16 0016.
     */
    public class User {
        private Integer uId;
        private String uName;
        private Date birthday;
        private Float salary;
        private String info;
    
        //省略 getter、setter 方法未粘贴
    }

## Java 对象转 XML 字符串 ##

<table> 
 <tbody> 
  <tr> 
   <td>toXML(Object)</td> 
   <td>用于将 单个POJO对象、POJO 列表、POJO 数组等转为 xml 字符串</td> 
  </tr> 
  <tr> 
   <td>toXML(Object,OutputStream)</td> 
   <td>用于将 单个POJO对象、POJO 列表、POJO 数组等转为 xml 字符串，并通过字节流输出。</td> 
  </tr> 
  <tr> 
   <td>toXML(Object,Write)</td> 
   <td>用于将 单个POJO对象、POJO 列表、POJO 数组等转为 xml 字符串，并通过字符流输出。</td> 
  </tr> 
 </tbody> 
</table>

**1）POJO 对象转 XML 字符串：**

import com.thoughtworks.xstream.XStream;
    import java.util.Date;
    public class XStreamTest {
        //POJO 对象转 XML 字符串
        public static void main(String[] args) {
            User user = new User();
            user.setuId(101);
            user.setuName("Joni");
            user.setBirthday(new Date());
            user.setSalary(8989.88f);
    
            XStream xStream = new XStream();
            String userXml = xStream.toXML(user);
            System.out.println("POJO:\n" + user);
            System.out.println("xml:\n" + userXml);
        }
    }

控制台输出如下。可以看出生成的 xml 字符串默认是没有根元素 <xml/> 标签的，根元素默认使用的 POJO 的类路径com.lct.test.User。

<table> 
 <tbody> 
  <tr> 
   <td>POJO:<br> User{birthday=Wed Jan 16 17:06:56 CST 2019, uId=101, uName='Joni', salary=8989.88, info='null'}<br> xml:<br><span style="color:#f33b45;">&lt;com.lct.test.User&gt;<br> &nbsp; &lt;uId&gt;101&lt;/uId&gt;<br> &nbsp; &lt;uName&gt;Joni&lt;/uName&gt;<br> &nbsp; &lt;birthday&gt;2019-01-16 09:06:56.787 UTC&lt;/birthday&gt;<br> &nbsp; &lt;salary&gt;8989.88&lt;/salary&gt;<br> &lt;/com.lct.test.User&gt;</span></td> 
  </tr> 
 </tbody> 
</table>

**2）List<Object> 转 xml 字符串：**

public class XStreamTest {
        public static void main(String[] args) {
            User user1 = new User();
            User user2 = new User();
            user1.setuId(101);
            user1.setuName("Joni");
            user1.setBirthday(new Date());
            user1.setSalary(8989.88f);
            user2.setuId(102);
            user2.setuName("Coco");
            user2.setBirthday(new Date());
            user2.setSalary(12000.00f);
    
    
            List<User> userList = new ArrayList<User>();
            userList.add(user1);
            userList.add(user2);
    
            XStream xStream = new XStream();
            //将整个list转为xml字符串，POJO 为null的属性不会转换
            String userXml = xStream.toXML(userList);
            System.out.println(userXml);
        }
    }

控制台输出如下：

<table> 
 <tbody> 
  <tr> 
   <td>&lt;<span style="color:#f33b45;">list</span>&gt;<br> &nbsp; &lt;<span style="color:#f33b45;">com.lct.test.User</span>&gt;<br> &nbsp; &nbsp; &lt;uId&gt;101&lt;/uId&gt;<br> &nbsp; &nbsp; &lt;uName&gt;Joni&lt;/uName&gt;<br> &nbsp; &nbsp; &lt;birthday&gt;2019-01-17 08:21:35.916 UTC&lt;/birthday&gt;<br> &nbsp; &nbsp; &lt;salary&gt;8989.88&lt;/salary&gt;<br> &nbsp; &lt;/com.lct.test.User&gt;<br> &nbsp; &lt;com.lct.test.User&gt;<br> &nbsp; &nbsp; &lt;uId&gt;102&lt;/uId&gt;<br> &nbsp; &nbsp; &lt;uName&gt;Coco&lt;/uName&gt;<br> &nbsp; &nbsp; &lt;birthday&gt;2019-01-17 08:21:35.916 UTC&lt;/birthday&gt;<br> &nbsp; &nbsp; &lt;salary&gt;12000.0&lt;/salary&gt;<br> &nbsp; &lt;/com.lct.test.User&gt;<br> &lt;/list&gt;</td> 
  </tr> 
 </tbody> 
</table>

上面是没有别名时的默认转换结果，也可以像如下所示为类设置别名，修改默认 <list>、<com.lct.test.User>：

XStream xStream = new XStream();
    xStream.alias("user", User.class);
    xStream.alias("userList", List.class);
    //将整个list转为xml字符串，POJO 为null的属性不会转换
    String userXml = xStream.toXML(userList);
    System.out.println(userXml);

此时输出如下（注意：如果序列化的时候使用了别名，则反序列化的时候也要使用别名）：

<table> 
 <tbody> 
  <tr> 
   <td>&lt;<span style="color:#f33b45;">userList</span>&gt;<br> &nbsp; &lt;<span style="color:#f33b45;">user</span>&gt;<br> &nbsp; &nbsp; &lt;uId&gt;101&lt;/uId&gt;<br> &nbsp; &nbsp; &lt;uName&gt;Joni&lt;/uName&gt;<br> &nbsp; &nbsp; &lt;birthday&gt;2019-01-17 08:24:04.546 UTC&lt;/birthday&gt;<br> &nbsp; &nbsp; &lt;salary&gt;8989.88&lt;/salary&gt;<br> &nbsp; &lt;/user&gt;<br> &nbsp; &lt;user&gt;<br> &nbsp; &nbsp; &lt;uId&gt;102&lt;/uId&gt;<br> &nbsp; &nbsp; &lt;uName&gt;Coco&lt;/uName&gt;<br> &nbsp; &nbsp; &lt;birthday&gt;2019-01-17 08:24:04.546 UTC&lt;/birthday&gt;<br> &nbsp; &nbsp; &lt;salary&gt;12000.0&lt;/salary&gt;<br> &nbsp; &lt;/user&gt;<br> &lt;/userList&gt;</td> 
  </tr> 
 </tbody> 
</table>

**3）Array<Object> 转 xml 字符串：**

public class XStreamTest {
        public static void main(String[] args) {
            User user1 = new User();
            User user2 = new User();
            user1.setuId(1000);
            user1.setuName("Joni");
            user1.setBirthday(new Date());
            user1.setSalary(9800.88f);
            user2.setuId(1001);
            user2.setuName("Tom");
            user2.setBirthday(new Date());
            user2.setSalary(14000.00f);
    
            User[] userArray = new User[2];
            userArray[0] = user1;
            userArray[1] = user2;
    
            XStream xStream = new XStream();
            /**可以选择为根标签的设置别名
             * xStream.alias("user", User.class);
             * xStream.alias("userList", List.class);
             * */
            String userXml = xStream.toXML(userArray);
            System.out.println(userXml);
        }
    }

此时控制台输出：

<table> 
 <tbody> 
  <tr> 
   <td>&lt;<span style="color:#f33b45;">com.lct.test.User-array</span>&gt;<br> &nbsp; &lt;<span style="color:#f33b45;">com.lct.test.User</span>&gt;<br> &nbsp; &nbsp; &lt;uId&gt;1000&lt;/uId&gt;<br> &nbsp; &nbsp; &lt;uName&gt;Joni&lt;/uName&gt;<br> &nbsp; &nbsp; &lt;birthday&gt;2019-01-17 08:34:29.437 UTC&lt;/birthday&gt;<br> &nbsp; &nbsp; &lt;salary&gt;9800.88&lt;/salary&gt;<br> &nbsp; &lt;/com.lct.test.User&gt;<br> &nbsp; &lt;com.lct.test.User&gt;<br> &nbsp; &nbsp; &lt;uId&gt;1001&lt;/uId&gt;<br> &nbsp; &nbsp; &lt;uName&gt;Tom&lt;/uName&gt;<br> &nbsp; &nbsp; &lt;birthday&gt;2019-01-17 08:34:29.437 UTC&lt;/birthday&gt;<br> &nbsp; &nbsp; &lt;salary&gt;14000.0&lt;/salary&gt;<br> &nbsp; &lt;/com.lct.test.User&gt;<br> &lt;/com.lct.test.User-array&gt;</td> 
  </tr> 
 </tbody> 
</table>

**4）Map<String,Object> 转 xml 字符串：**

public static void main(String[] args) {
            User user1 = new User();
            User user2 = new User();
            user1.setuId(9526);
            user1.setuName("Joni");
            user1.setBirthday(new Date());
            user1.setSalary(9800.88f);
            user2.setuId(9527);
            user2.setuName("Tom");
            user2.setBirthday(new Date());
            user2.setSalary(14000.00f);
    
            Map<String, User> userMap = new Hashtable<String, User>();
            userMap.put("user1", user1);
            userMap.put("user2", user2);
    
            XStream xStream = new XStream();
            /**也可以为 User 类与 Hashtable 类设置别名
             * xStream.alias("user", User.class);
             * xStream.alias("userMap", Hashtable.class);
             */
            String userXml = xStream.toXML(userMap);
            System.out.println(userXml);
        }

控制台输出如下：

<table> 
 <tbody> 
  <tr> 
   <td>&lt;<span style="color:#f33b45;">userMap</span>&gt;<br> &nbsp; &lt;<span style="color:#f33b45;">entry</span>&gt;<br> &nbsp; &nbsp; <span style="color:#f33b45;">&lt;string&gt;user2&lt;/string&gt;<br> &nbsp; &nbsp; &lt;user&gt;</span><br> &nbsp; &nbsp; &nbsp; &lt;uId&gt;9527&lt;/uId&gt;<br> &nbsp; &nbsp; &nbsp; &lt;uName&gt;Tom&lt;/uName&gt;<br> &nbsp; &nbsp; &nbsp; &lt;birthday&gt;2019-01-17 08:37:21.498 UTC&lt;/birthday&gt;<br> &nbsp; &nbsp; &nbsp; &lt;salary&gt;14000.0&lt;/salary&gt;<br> &nbsp; &nbsp; &lt;/user&gt;<br> &nbsp; &lt;/entry&gt;<br> &nbsp; &lt;entry&gt;<br> &nbsp; &nbsp; &lt;string&gt;user1&lt;/string&gt;<br> &nbsp; &nbsp; &lt;user&gt;<br> &nbsp; &nbsp; &nbsp; &lt;uId&gt;9526&lt;/uId&gt;<br> &nbsp; &nbsp; &nbsp; &lt;uName&gt;Joni&lt;/uName&gt;<br> &nbsp; &nbsp; &nbsp; &lt;birthday&gt;2019-01-17 08:37:21.498 UTC&lt;/birthday&gt;<br> &nbsp; &nbsp; &nbsp; &lt;salary&gt;9800.88&lt;/salary&gt;<br> &nbsp; &nbsp; &lt;/user&gt;<br> &nbsp; &lt;/entry&gt;<br> &lt;/userMap&gt;</td> 
  </tr> 
 </tbody> 
</table>

这里介绍了常用的 POJO、List、Array、Map，其余的也是同理，实际应用中通常 List 就足够了。需要注意的是：如果序列化的时候使用了别名，则反序列化的时候也要使用别名。

## Java 对象转 xml 文件 ##

1、上面已经介绍了将 POJO 转为 xml 字符串，可以自己将转换好的 xml 字符串通过 I/O 流写到磁盘，或者网络传输，而 XStream 也重载了到磁盘的方法。

![20190116172618137.png][]

2、使用第二个 OutputStream 字节输出流、或者第三个 Write 字符打印流都可以。

**1）** **toXML(Object,Write)**：Write 是字符输出流。

public static void main(String[] args) {
            try {
                User user = new User();
                user.setuId(101);
                user.setuName("Joni");
                user.setBirthday(new Date());
                user.setSalary(8989.88f);
    
                /**理论上自然是可以保存为任意类型的文件，但是既然是解析xml，则保存为 xml 格式即可
                 * saveFilePath：xml文件的路径，*.xml文件不存在时会自动创建，但是其父目录必须存在，即如下所示的 E:/wmx/test/ 必须存在，
                 * 否则报错 "java.io.FileNotFoundException",xml文件存在时内容会覆盖
                 * 这里使用 PrintWriter-字符打印输出流，它继承于Writer。
                 * */
                String saveFilePath = "E:/wmx/test/" + new Random().nextInt(10000) + ".xml";
                PrintWriter printWriter = new PrintWriter(saveFilePath, "UTF-8");
                /**标准的xml文件是必须得有根标签 <xml> 的，根据实际需求绝对是否添加
                 * 当不加 <xml>根标签时，使用 XStream 能快速的反序列化，将文件内容直接转换为 POJO、Lsit 等*/
                printWriter.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n");
    
                XStream xStream = new XStream();
                /**toXML(Object obj, Writer out)*/
                xStream.toXML(user, printWriter);
                printWriter.flush();
                printWriter.close();
                System.out.println("xml 文件生成完毕...");
            } catch (FileNotFoundException e) {
                e.printStackTrace();
            } catch (UnsupportedEncodingException e) {
                e.printStackTrace();
            }
        }

![20190117171035865.gif][]

上面演示的虽然是单个 POJO，显然多个时也是一样的，都是调用 toXML方法。注意如下：

<table> 
 <tbody> 
  <tr> 
   <td> <p>1）如果序列化的时候使用了别名，则反序列化的时候也要使用别名</p> <p>2）xml 文件的默认头信息&nbsp;&lt;?xml version="1.0" encoding="UTF-8"?&gt; 写与不写，XStream 都能反序列化为 POJO。</p> </td> 
  </tr> 
 </tbody> 
</table>

**2）toXML(Object,OutputStream)**：OutputStream 字节输出流。

public static void main(String[] args) {
            try {
                User user1 = new User();
                User user2 = new User();
                user1.setuId(101);
                user1.setuName("Joni");
                user1.setBirthday(new Date());
                user1.setSalary(8989.88f);
                user2.setuId(101);
                user2.setuName("Joni");
                user2.setBirthday(new Date());
                user2.setSalary(8989.88f);
                List<User> userList = new ArrayList<User>();
                userList.add(user1);
                userList.add(user2);
    
                /**理论上自然是可以保存为任意类型的文件，但是既然是解析xml，则保存为 xml 格式即可
                 * saveFilePath：xml文件的路径，*.xml文件不存在时会自动创建，但是其父目录必须存在，即如下所示的 E:/wmx/test/ 必须存在，
                 * 否则报错 "java.io.FileNotFoundException",xml文件存在时内容会覆盖。这里使用 OutputStream-字节输出流
                 * */
                String saveFilePath = "E:/wmx/test/" + new Random().nextInt(10000) + ".xml";
                OutputStream outputStream = new FileOutputStream(saveFilePath);
                XStream xStream = new XStream();
                /**toXML(Object obj, OutputStream out)
                 * obj 也可以 List、map、array 等；out：字节输出流*/
                xStream.toXML(userList, outputStream);
                outputStream.flush();
                outputStream.close();
                System.out.println("xml 文件生成完毕...");
            } catch (FileNotFoundException e) {
                e.printStackTrace();
            } catch (UnsupportedEncodingException e) {
                e.printStackTrace();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }

![20190117172315123.gif][]

仅仅是输出流不一样，其它的都与 toXML(Object,Write) 一致。

## XML 转 Java 对象 ##

1、从 xml 文件反序列化将文本内容解析为 Java 对象，重载了很多方法，这里挑其中部分进行演示。

2、不推荐使用 fromXML(String xml)，因为容易抛异常：StreamException: 前言中不允许有内容。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdteDE5OTMzMjg_size_16_color_FFFFFF_t_70 1][]

**1）fromXML(File)：根据文件 File 反序列为 POJO**

import com.thoughtworks.xstream.XStream;
    import com.thoughtworks.xstream.io.xml.DomDriver;
    import com.thoughtworks.xstream.io.xml.Xpp3Driver;
    import java.io.File;
    import java.io.FileNotFoundException;
    import java.io.PrintWriter;
    import java.io.UnsupportedEncodingException;
    import java.util.Date;
    
    /**
     * Created by Administrator on 2019/1/16 0016.
     */
    public class XStreamTest {
        public static void main(String[] args) throws FileNotFoundException, UnsupportedEncodingException {
            /**
             * DomDriver：纯 Java JDK Dom 解析驱动，此时无需导入额外的 Jar 包，只要导入 xstream、xmlpill两个 jar 包即可
             * Dom4JDriver：dom4j 解析，此时需要额外导入 dom4j-xxx.jar 包
             * XppDriver、XppDomDriver、Xpp3Driver、Xpp3DomDriver：xpp 解析驱动，此时需要额外导入 xpp3_min-xxx.jar 包
             * 使用无参默认构造器 XStream()时，默认会使用 XppDriver 解析驱动，所以需要导入 xpp3 包，否则抛异常
             **/
            XStream xStream = new XStream(new DomDriver());
            User user_ = (User) xStream.fromXML(new File("E:/xml/123.xml"));
            System.out.println("user_:" + user_);
        }
    }

![20190118131513959.gif][]

**2）fromXML(InputStream)：根据字节输入流 反序列为 POJO**

public static void main(String[] args) throws FileNotFoundException, UnsupportedEncodingException {
            /**
             * DomDriver：纯 Java JDK Dom 解析驱动，此时无需导入额外的 Jar 包，只要导入 xstream、xmlpill两个 jar 包即可
             * Dom4JDriver：dom4j 解析，此时需要额外导入 dom4j-xxx.jar 包
             * XppDriver、XppDomDriver、Xpp3Driver、Xpp3DomDriver：xpp 解析驱动，此时需要额外导入 xpp3_min-xxx.jar 包
             * 使用无参默认构造器 XStream()时，默认会使用 XppDriver 解析驱动，所以需要导入 xpp3 包，否则抛异常
             * 反序列化使用的驱动与序列化时使用的驱动无关，不用一致
             **/
            XStream xStream = new XStream();
            /**如果 toXML 的时候使用了别名，则反序列化的时候也要使用别名*/
            xStream.alias("user", User.class);
            InputStream inputStream = new FileInputStream("E:/xml/234.xml");
            User user_ = (User) xStream.fromXML(inputStream);
            System.out.println("user_:" + user_);
        }

![20190118133708345.gif][]

**3）fromXML(URL)：根据统一资源定位符反序列为 POJO**

1、url 即可以指向网络上的文件，如 "http://www.xxx/xxx/123.xml"，也可以是本地文件，如 "file:///E:/xml/456.xml"，本地时必须加前缀 file:/// 表示协议。

public static void main(String[] args) throws FileNotFoundException, UnsupportedEncodingException, MalformedURLException {
            /**
             * DomDriver：纯 Java JDK Dom 解析驱动，此时无需导入额外的 Jar 包，只要导入 xstream、xmlpill两个 jar 包即可
             * Dom4JDriver：dom4j 解析，此时需要额外导入 dom4j-xxx.jar 包
             * XppDriver、XppDomDriver、Xpp3Driver、Xpp3DomDriver：xpp 解析驱动，此时需要额外导入 xpp3_min-xxx.jar 包
             * 使用无参默认构造器 XStream()时，默认会使用 XppDriver 解析驱动，所以需要导入 xpp3 包，否则抛异常
             * 反序列化使用的驱动与序列化时使用的驱动无关，不用一致
             **/
            XStream xStream = new XStream();
            /**如果 toXML 的时候使用了别名，则反序列化的时候也要使用别名*/
            xStream.alias("user", User.class);
            /**
             * url 即可以指向网络上的文件，如 "http://www.xxx/xxx/123.xml"，
             * url 也可以是本地文件，如 "file:///E:/xml/456.xml"，本地时必须加前缀 file:/// 表示协议，否则报错未知的协议
             * 对于 xml 文件头信息 "<?xml version="1.0" encoding="UTF-8"?>",xstream 会自动忽略的，所以文件中有也没关系，但不能写错，否则报错
             */
            URL url = new URL("file:///E:/xml/456.xml");
            User user_ = (User) xStream.fromXML(url);
            System.out.println("user_:" + user_);
        }

![20190118135257762.gif][]

**4）fromXML(Reader)：根据字符输入流反序列为 POJO**

1、Reader 推荐使用 FileReader，其次是 InputStreamReader 。

public static void main(String[] args) throws FileNotFoundException, UnsupportedEncodingException, MalformedURLException {
            /**
             * DomDriver：纯 Java JDK Dom 解析驱动，此时无需导入额外的 Jar 包，只要导入 xstream、xmlpill两个 jar 包即可
             * Dom4JDriver：dom4j 解析，此时需要额外导入 dom4j-xxx.jar 包
             * XppDriver、XppDomDriver、Xpp3Driver、Xpp3DomDriver：xpp 解析驱动，此时需要额外导入 xpp3_min-xxx.jar 包
             * 使用无参默认构造器 XStream()时，默认会使用 XppDriver 解析驱动，所以需要导入 xpp3 包，否则抛异常
             * 反序列化使用的驱动与序列化时使用的驱动无关，不用一致
             **/
            XStream xStream = new XStream();
            /**如果 toXML 的时候使用了别名，则反序列化的时候也要使用别名*/
            xStream.alias("user", User.class);
    
            /**fromXML(Reader reader)：reader 是字符输入流，有很多子类，
             * 可以通过 InputStreamReader 将字节流转为字符流，也可以直接使用 FileReader
             * 如：Reader reader = new FileReader("E:/xml/8017.xml");
             * 但是不能用 StringReader ,推荐 FileReader
             * */
            InputStream inputStream = new FileInputStream("E:/xml/8017.xml");
            Reader reader = new InputStreamReader(inputStream, Charset.forName("UTF-8"));
            /**fromXML 返回的 Object ，如果是单个对象，则转为 POJO对象，如果是多个，则转为list即可
             * */
            List<User> userList = (List<User>) xStream.fromXML(reader);
            for (User user : userList) {
                System.out.println("user:" + user);
            }
        }

![2019011815223292.gif][]

# Alias 别名设置 #

1、提醒：如果序列化的时候使用了别名，则反序列化的时候也要使用别名。设置别名不是必须的，纯粹是为了显示好看。

**1）aliasPackage 设置别名**

1、使用别名修改 POJO 对象生成 xml 字符串中默认的包名。

/**
     * Created by Administrator on 2019/1/16 0016.
     */
    public class XStreamTest {
        public static void main(String[] args) {
            User user = new User();
            user.setuId(101);
            user.setuName("Joni");
            user.setBirthday(new Date());
            user.setSalary(8989.88f);
    
            XStream xStream = new XStream();
            /**className： user 的类名，如 com.lct.test.User;
             * packageName：user 类的包名，com.lct.test*/
            String className = user.getClass().getName();
            String packageName = className.substring(0, className.lastIndexOf("."));
            /**使用 pojo 替换默认的包名 com.lct.test*/
            xStream.aliasPackage("pojo", packageName);
    
            String userXml = xStream.toXML(user);
            System.out.println(userXml);
        }
    }

控制台输出如下：

<table> 
 <tbody> 
  <tr> 
   <td>&lt;<span style="color:#f33b45;">pojo</span>.User&gt;<br> &nbsp; &lt;uId&gt;101&lt;/uId&gt;<br> &nbsp; &lt;uName&gt;Joni&lt;/uName&gt;<br> &nbsp; &lt;birthday&gt;2019-01-17 03:41:31.198 UTC&lt;/birthday&gt;<br> &nbsp; &lt;salary&gt;8989.88&lt;/salary&gt;<br> &lt;/<span style="color:#f33b45;">pojo</span>.User&gt;</td> 
  </tr> 
 </tbody> 
</table>

2、如果没有 xStream.aliasPackage("pojo", packageName);则生成的 xml 字符串的根目录会是  <com.lct.test.User>，这里用 pojo 字符代替了包名 com.lct.test。

**2）alias 设置类别名**

1、使用别名修改 POJO 对象生成 xml 字符串中默认的类名。

2、alias(String name, Class type)，name：类的别名；type：POJO 类型

2、控制台输出如下，默认根目录应该是 com.lcet.test.User，现在使用别名 user 代替了。

<table> 
 <tbody> 
  <tr> 
   <td>user:<br> User{birthday=Thu Jan 17 11:56:15 CST 2019, uId=101, uName='Joni', salary=8989.88, info='null'}<br> userXml:<br> &lt;<span style="color:#f33b45;">user</span>&gt;<br> &nbsp; &lt;uId&gt;101&lt;/uId&gt;<br> &nbsp; &lt;uName&gt;Joni&lt;/uName&gt;<br> &nbsp; &lt;birthday&gt;2019-01-17 03:56:15.498 UTC&lt;/birthday&gt;<br> &nbsp; &lt;salary&gt;8989.88&lt;/salary&gt;<br> &lt;/<span style="color:#f33b45;">user</span>&gt;</td> 
  </tr> 
 </tbody> 
</table>

**3）aliasField：**设置字段别名

public class XStreamTest {
        public static void main(String[] args) {
            User user = new User();
            user.setuId(101);
            user.setuName("Joni");
            user.setBirthday(new Date());
            user.setSalary(8989.88f);
    
            XStream xStream = new XStream();
            /**使用别名修改默认的类名*/
            xStream.alias("user", User.class);
            /**
             * 使用别名修改类的属性名称
             * aliasField(String alias, Class definedIn, String fieldName)
             * alias：别名、definedIn：类型、fieldName：被修改的字段名
             */
            xStream.aliasField("userId", User.class, "uId");
            xStream.aliasField("userName", User.class, "uName");
    
            //xml：将 POJO 对象转为xml字符串
            String userXml = xStream.toXML(user);
            System.out.println("user:\n" + user);
            System.out.println("userXml:\n" + userXml);
        }
    }

控制台输出如下，user 是修改的类别名，userId 与 userName 是属性别名，分别替换了默认的 uId，uName：

<table> 
 <tbody> 
  <tr> 
   <td>user:<br> User{birthday=Thu Jan 17 12:28:11 CST 2019, uId=101, uName='Joni', salary=8989.88, info='null'}<br> userXml:<br> &lt;<span style="color:#f33b45;">user</span>&gt;<br> &nbsp; &lt;<span style="color:#f33b45;">userId</span>&gt;101&lt;/userId&gt;<br> &nbsp; &lt;<span style="color:#f33b45;">userName</span>&gt;Joni&lt;/userName&gt;<br> &nbsp; &lt;birthday&gt;2019-01-17 04:28:11.551 UTC&lt;/birthday&gt;<br> &nbsp; &lt;salary&gt;8989.88&lt;/salary&gt;<br> &lt;/<span style="color:#f33b45;">user</span>&gt;</td> 
  </tr> 
 </tbody> 
</table>

本文演示在线源码：[https://gitee.com/wangmx1993/my-document/blob/08b04414d64a6b1c551f3c4f523c85df032bc50f/docs/XStreamUtils.java][https_gitee.com_wangmx1993_my-document_blob_08b04414d64a6b1c551f3c4f523c85df032bc50f_docs_XStreamUtils.java]

官网的2两分钟快速教程：[http://x-stream.github.io/tutorial.html][http_x-stream.github.io_tutorial.html]，在左侧的 " Tutorials " 标签下。

[http_x-stream.github.io_download.html]: http://x-stream.github.io/download.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdteDE5OTMzMjg_size_16_color_FFFFFF_t_70]: /images/20220326/8e2ae4a276dc49d89a01d2d01a810cbe.png
[20190116172618137.png]: /images/20220326/73862414a09947e597cc142e201f6991.png
[20190117171035865.gif]: /images/20220326/60356af164fe445d86962ab812d4c93c.png
[20190117172315123.gif]: /images/20220326/d917547383fd4d4a8baca892e1eac564.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdteDE5OTMzMjg_size_16_color_FFFFFF_t_70 1]: /images/20220326/eefe638f00c64eb39e31274b47137e7b.png
[20190118131513959.gif]: /images/20220326/0d21b997c45b433086192aea5bd97c37.png
[20190118133708345.gif]: /images/20220326/e90caebc9fe2483dae7d7fe0ddf77141.png
[20190118135257762.gif]: /images/20220326/83ab6e3c17994d088989dff785077076.png
[2019011815223292.gif]: /images/20220326/86ca913bdf144bd3972952f024db4731.png
[https_gitee.com_wangmx1993_my-document_blob_08b04414d64a6b1c551f3c4f523c85df032bc50f_docs_XStreamUtils.java]: https://gitee.com/wangmx1993/my-document/blob/08b04414d64a6b1c551f3c4f523c85df032bc50f/docs/XStreamUtils.java
[http_x-stream.github.io_tutorial.html]: http://x-stream.github.io/tutorial.html