xstream

一、XStream的用途
XStream是一个Java对象和XML相互转换的工具，很好很强大。提供了所有的基础类型、数组、集合等类型直接转换的支持。

     因此XML常用于数据交换、对象序列化（这种序列化和Java对象的序列化技术有着本质的区别）。

    Stream对象相当Java对象和XML之间的转换器，转换过程是双向的。创建XSteam对象的方式很简单，只需要new XStream()即

     可。 
     Java到xml，用toXML()方法。 
     Xml到Java，用fromXML()方法。

二、

   在没有任何设置默认情况下，java到xml的映射，是java成员名对应xml的元素名，java类的全名对应xml根元素的名字。而实际中，往

  往是xml和java类都有了，要完成相互转换，必须进行别名映射。

  别名配置包含三种情况： 
  1、类别名，用alias(String name, Class type)。 
  2、类成员别名，用aliasField(String alias, Class definedIn, String fieldName) 
  3、类成员作为属性别名，用 aliasAttribute(Class definedIn, String attributeName, String alias)，单独命名没有意义，还要通过 

      useAttributeFor(Class definedIn, String fieldName) 应用到某个类上。 
      别名的配置是非常重要的，但是其中有些细节问题很重要，在例子中会专门做详细说明。

     另外还有不太常用的方法： 
     addImplicitCollection(Class ownerType, String fieldName)，去掉集合类型生成xml的父节点。 
     registerConverter(Converter converter) ，注册一个转换器。

三、

如果这些基本的操作还不能满足你应用的需求，XStream提供丰富的扩展点。你可以实现自己的转换器。还可以利用XStream完成更负责的功能，比如输出其他非xml格式的数据，还可以输出html，还支持XML Dom类型数据，这些应用起来稍微复杂些。当然这些不是XStream应用的重点，也不用理会，真正需要的时候再查看API和源码研究研究。

XStream的优点很多，但是也有一些小bug，比如在定义别名中的下划线“”转换为xml后会变成“_”这个符号，很变态。因此，尽量避免在别名中实用任何符号，却是需要下划线的时候，可以考虑实用连接符“-”，这个没有问题。

另外，我们的Java Bean中，常常有一些常量，在转换过程，XStream也会将这些常量转换过去，形成常量的xml节点，这显然不是想要的结果，对于常量字段，就不做转换了。

四、

 简单例子：

/********************************************
 * 文件名称: ConfigUser.java
 * 系统名称: lzzl-learn1
 * 模块名称:
 * 软件版权: 
 * 功能说明: 
 * 系统版本: 1.0.0.1
 * 开发人员: 
 * 开发时间: 2017-8-16下午2:55:20 
 * 审核人员:
 * 相关文档:
 * 修改记录: 修改日期    修改人员    修改说明
 *********************************************/
/**   
 * Copyright © 2017 eSunny Info. Tech Ltd. All rights reserved.
 * 
 * @Package: com.lzzl.learn 
 * @author: Administrator   
 * @date: 2017-8-16 下午2:55:20 
 *
 * 
 */
package com.lzzl.learn.domain;

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

/** 
 * @ClassName: ConfigUser 
 * @Description: TODO
 * @author: Administrator
 * @date: 2017-8-16 下午2:55:20  
 */
public class ConfigUser {
    @Override
    public String toString() {
        return "ConfigUser [type=" + type + ", users=" + users + "]";
    }
    private String type;
    private List<AdminUser> users = new ArrayList<AdminUser>();
    public String getType() {
        return type;
    }
    public void setType(String type) {
        this.type = type;
    }
    public List<AdminUser> getUsers() {
        return users;
    }
    public void setUsers(List<AdminUser> users) {
        this.users = users;
    }

}



/********************************************
 * 文件名称: User.java
 * 系统名称: lzzl-learn1
 * 模块名称:
 * 软件版权: 
 * 功能说明: 
 * 系统版本: 1.0.0.1
 * 开发人员: 
 * 开发时间: 2017-8-16下午2:56:53 
 * 审核人员:
 * 相关文档:
 * 修改记录: 修改日期    修改人员    修改说明
 *********************************************/
/**   
 * Copyright © 2017 eSunny Info. Tech Ltd. All rights reserved.
 * 
 * @Package: com.lzzl.learn.domain 
 * @author: Administrator   
 * @date: 2017-8-16 下午2:56:53 
 *
 * 
 */
package com.lzzl.learn.domain;

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

/** 
 * @ClassName: User 
 * @Description: TODO
 * @author: Administrator
 * @date: 2017-8-16 下午2:56:53  
 */
public class AdminUser {
    private String name;
    private String pwd;
    @Override
    public String toString() {
        return "AdminUser [name=" + name + ", pwd=" + pwd + ", ip=" + ip + "]";
    }
    private List<String> ip = new ArrayList<String>();
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String getPwd() {
        return pwd;
    }
    public void setPwd(String pwd) {
        this.pwd = pwd;
    }
    public List<String> getIp() {
        return ip;
    }
    public void setIp(List<String> ip) {
        this.ip = ip;
    }
}

/********************************************
 * 文件名称: XstreamTest.java
 * 系统名称: lzzl-learn1
 * 模块名称:
 * 软件版权: 
 * 功能说明: 
 * 系统版本: 1.0.0.1
 * 开发人员: 
 * 开发时间: 2017-8-16下午2:50:08 
 * 审核人员:
 * 相关文档:
 * 修改记录: 修改日期    修改人员    修改说明
 *********************************************/
/**   
 * Copyright © 2017 eSunny Info. Tech Ltd. All rights reserved.
 * 
 * @Package: com.lzzl.learn 
 * @author: Administrator   
 * @date: 2017-8-16 下午2:50:08 
 *
 * 
 */
package com.lzzl.learn;

import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.net.URL;

import org.junit.Test;

import com.lzzl.learn.domain.AdminUser;
import com.lzzl.learn.domain.ConfigUser;
import com.thoughtworks.xstream.XStream;

/** 
 * @ClassName: XstreamTest 
 * @Description: TODO
 * @author: Administrator
 * @date: 2017-8-16 下午2:50:08  
 */
public class XstreamTest {

    @Test
    public void test1(){//将xml文件转换为实例
        InputStream in = XstreamTest.class.getClassLoader().getResourceAsStream("configuser.xml");
        XStream xstream = new XStream();

        xstream.alias("AdminUser", AdminUser.class);
        xstream.alias("ConfigUser", ConfigUser.class);
        ConfigUser configUser = (ConfigUser) xstream.fromXML(in);
        System.out.println(configUser);

    }

    @Test
    public void test2(){//将实例转换为xml文件
         URL url = XstreamTest.class.getClassLoader().getResource("outconfig.xml");
//       File file = new File("test.xml");
         File file = new File(url.getPath());
         System.out.println(file.getAbsolutePath());
         FileOutputStream fout = null;
        try {
            fout = new FileOutputStream(file);
        } catch (FileNotFoundException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
         XStream xstream = new XStream();

         ConfigUser configuser = new ConfigUser();
         configuser.setType("admin");
         AdminUser u = new AdminUser();
         u.setName("lili");
         u.setPwd("123");
         u.getIp().add("127.0.0.1");
         configuser.getUsers().add(u);
         xstream.alias("ConfigUser", ConfigUser.class);//设置类别名
         xstream.alias("AdminUser", AdminUser.class);

         xstream.useAttributeFor(ConfigUser.class, "type");//设置类成员为xml的一个属性
         xstream.aliasAttribute("Type", "type");//为属性设置别名

        // xstream.toXML(configuser,fout);  //把对象转换成xml格式字符串并输出到文件中
         System.out.println(xstream.toXML(configuser));//把对象转换成xml格式字符串
    }
}