程序博客网 > 重庆淘宝运营

xstream解析

来源：互联网 发布：重庆淘宝运营 编辑：程序博客网 时间：2024/05/17 04:41
XStream是一个序列化对象为XML或XML转换为对象的库.

特点:
简化的API;
无映射文件;
高性能,低内存占用;
整洁的XML;
不需要修改对象;支持内部私有字段,不需要setter/getter方法,final字段;非公有类,内部类;类不需要默认构造器,完全对象图支持.维护对象引用计数,循环引用. i
提供序列化接口;
自定义转换类型策略;
详细的错误诊断;
快速输出格式;当前支持 JSON 和 morphing.

使用场景
Transport      转换
Persistence    持久化对象
Configuration  配置
Unit Tests     单元测试

限制

enhanced 模式: JDK版本 不能<1.5.
虽然预处理注解是安全的,但自动侦查注解可能发生竞争条件.

两分钟简单教程
http://xstream.codehaus.org/tutorial.html

XML解析器
1. XPP3 (需要 xpp3-[version].jar)
XStream xstream = new XStream(new XppDriver());

2. JAXP DOM
XStream xstream = new XStream(new DomDriver());

类型别名Alias
XStream 默认使用完全限制类名作为XML的元素名称.通过使用别名可修改元素名称为指定名称.
xstream.alias("person", Person.class);
xstream.alias("phonenumber", PhoneNumber.class);

字段别名
Stream 默认使用字段名, 优先级高于类型.
集合字段中的对象默认使用类型别名.
xstream.aliasField("phonenumber", Person.class, "phone");

注意: Person.class  是包含此字段的类,而不是字段的类型.字段是phone, 别名是phonenumber. 下面也是如此.

序列化与反序列化
对象不需要实现序列化接口. 反序列的对象与原对象不是同一对象.
String xml = xstream.toXML(obj);

T obj = (T)xstream.fromXML(xml);

隐式集合
当我们使用集合类时不想显示集合,只显示里面的元素即可.
使用隐式集合前:

<list>
   <element />
   <element />
<list>

使用隐式集合:
xstream.addImplicitCollection(Person.class, "list");

使用隐式集合后:

   <element />
   <element />

XML属性
将类的字段转换成类映射元素的一个属性,而不是元素.
xstream.useAttributeFor(Blog.class, "author");
xstream.registerConverter(new AuthorConverter()); //  注册将对象转换成字符串的转换类.

class AuthorConverter implements SingleValueConverter {

        public String toString(Object obj) {
                return ((Author) obj).getName();
        }

        public Object fromString(String name) {
                return new Author(name);
        }

        public boolean canConvert(Class type) {
                return type.equals(Author.class);
        }

}

SingleValueConverter  转换成简单字符串
Converter                  转换成对象



包别名
xstream.aliasPackage("my.company", "org.thoughtworks");

注解
@XStreamAlias("message") 别名注解
作用目标: 类,字段

@XStreamImplicit 隐式集合
@XStreamImplicit(itemFieldName="part")
作用目标: 集合字段

@XStreamConverter(SingleValueCalendarConverter.class) 注入转换器
作用目标: 对象

@XStreamAsAttribute 转换成属性
作用目标: 字段

@XStreamOmitField 忽略字段
作用目标: 字段

Auto-detect Annotations 自动侦查注解
xstream.autodetectAnnotations(true);

自动侦查注解与XStream.processAnnotations(Class[] cls)的区别在于性能.自动侦查注解将缓存所有类的类型.

对象流
bjectOutputStream out = xstream.createObjectOutputStream(someWriter);
ObjectInputStream in = xstream.createObjectInputStream(someReader);

持久化对象

public void persist(String dir, List objects)
{
PersistenceStrategy strategy = new FilePersistenceStrategy(new File(System.getProperty("user.home"), dir));

List<?> list = new XmlArrayList(strategy);

list.addAll(objects);
}

JSON
解析器:
Jettison StAX

XStreamFacade.java

Java代码  收藏代码
  1. package cn.bisoft.java.test;  
  2.   
  3. import java.io.File;  
  4. import java.util.List;  
  5.   
  6. import com.thoughtworks.xstream.XStream;  
  7. import com.thoughtworks.xstream.io.json.JettisonMappedXmlDriver;  
  8. import com.thoughtworks.xstream.io.json.JsonHierarchicalStreamDriver;  
  9. import com.thoughtworks.xstream.io.xml.DomDriver;  
  10. import com.thoughtworks.xstream.io.xml.XppDriver;  
  11. import com.thoughtworks.xstream.persistence.FilePersistenceStrategy;  
  12. import com.thoughtworks.xstream.persistence.PersistenceStrategy;  
  13. import com.thoughtworks.xstream.persistence.XmlArrayList;  
  14.   
  15. public class XStreamFacade  
  16. {  
  17.     private static XStream xstream;  
  18.   
  19.     public static final String JAXP_DOM_XML = "JAXP DOM";  
  20.   
  21.     public static final String XPP3_XML_PARSER = "XPP3";  
  22.   
  23.     public static final String STAX_JSON_PARSER = "Jettison StAX";  
  24.   
  25.     public static final String WRITER_JSON_PARSER = "Only Writer JSON";  
  26.   
  27.     public synchronized static XStream getXStream(String driver)  
  28.     {  
  29.         if (JAXP_DOM_XML.equals(driver))  
  30.         {  
  31.             xstream = new XStream(new DomDriver());  
  32.             xstream.autodetectAnnotations(true);  
  33.         }  
  34.         else if (XPP3_XML_PARSER.equals(driver))  
  35.         {  
  36.             xstream = new XStream(new XppDriver());  
  37.             xstream.autodetectAnnotations(true);  
  38.         }  
  39.         else if (STAX_JSON_PARSER.equals(driver))  
  40.         {  
  41.             xstream = new XStream(new JettisonMappedXmlDriver());  
  42.             xstream.setMode(XStream.NO_REFERENCES);  
  43.         }  
  44.         else if (WRITER_JSON_PARSER.equals(driver))  
  45.         {  
  46.             xstream = new XStream(new JsonHierarchicalStreamDriver());  
  47.             xstream.setMode(XStream.NO_REFERENCES);  
  48.         }  
  49.         else  
  50.         {  
  51.             xstream = new XStream(new DomDriver());  
  52.         }  
  53.   
  54.         return xstream;  
  55.     }  
  56.   
  57.     @SuppressWarnings("unchecked")  
  58.     public void persist(String dir, List objects)  
  59.     {  
  60.         PersistenceStrategy strategy = new FilePersistenceStrategy(new File(System.getProperty("user.home"), dir));  
  61.   
  62.         List<?> list = new XmlArrayList(strategy);  
  63.   
  64.         list.addAll(objects);  
  65.     }  
  66.   
  67. }  


------------
扩展:
1.
XBird

2.
XStream.XPATH_RELATIVE_REFERENCES

(Default) Uses relative XPath references to signify duplicate references. This produces XML with the least clutter.

XStream.XPATH_ABSOLUTE_REFERENCES
Uses absolute XPath references to signify duplicate references. This might produce for some situations better readable XML. Note, that XStream will read XML with relative paths as well as with absolute paths independent of the XPATH mode.

XStream.ID_REFERENCES
Uses ID references to signify duplicate references. In some scenarios, such as when using hand-written XML, this is easier to work with.

XStream.NO_REFERENCES
This disables object graph support and treats the object structure like a tree. Duplicate references are treated as two separate objects and circular references cause an exception. This is slightly faster and uses less memory than the other two modes.

3.
转换器

示例

XStreamFacade.java

Java代码  收藏代码
  1. package cn.bisoft.java.test;  
  2.   
  3. import java.io.File;  
  4. import java.util.List;  
  5.   
  6. import com.thoughtworks.xstream.XStream;  
  7. import com.thoughtworks.xstream.converters.reflection.ReflectionProvider;  
  8. import com.thoughtworks.xstream.converters.reflection.Sun14ReflectionProvider;  
  9. import com.thoughtworks.xstream.io.json.JettisonMappedXmlDriver;  
  10. import com.thoughtworks.xstream.io.json.JsonHierarchicalStreamDriver;  
  11. import com.thoughtworks.xstream.io.xml.DomDriver;  
  12. import com.thoughtworks.xstream.io.xml.XppDriver;  
  13. import com.thoughtworks.xstream.persistence.FilePersistenceStrategy;  
  14. import com.thoughtworks.xstream.persistence.PersistenceStrategy;  
  15. import com.thoughtworks.xstream.persistence.XmlArrayList;  
  16.   
  17. /** 
  18.  * XStreamFacade 
  19.  *  
  20.  * <pre> 
  21.  * 提供对XStream的初始化,降低使用XStream API的复杂性. 
  22.  * @link  
  23.  * </pre> 
  24.  * @author tl 
  25.  * @version 1.0, 2011-6-10 
  26.  */  
  27. public class XStreamFacade  
  28. {  
  29.     public static final String JAXP_DOM_XML = "JAXP DOM";  
  30.   
  31.     public static final String XPP3_XML_PARSER = "XPP3";  
  32.   
  33.     public static final String STAX_JSON_PARSER = "Jettison StAX";  
  34.   
  35.     public static final String WRITER_JSON_PARSER = "Only Writer JSON";  
  36.   
  37.     /** 
  38.      * 获取XStream对象. 
  39.      *  
  40.      * <pre> 
  41.      * 根据驱动获取XStream对象,若没有提供驱动,则默认使用JAXP-DOM驱动. 
  42.      * </pre> 
  43.      * @param driver 驱动名称 
  44.      * @param isStaticSupported 是否支持静态变量转换 
  45.      * @return XStream 
  46.      */  
  47.     public synchronized static XStream getXStream(String driver, boolean isStaticSupported)  
  48.     {  
  49.         ReflectionProvider reflectProvider = null;  
  50.   
  51.         if (isStaticSupported)  
  52.         {  
  53.             reflectProvider = new EnhancedModeReflectProvider();  
  54.         }  
  55.         else  
  56.         {  
  57.             reflectProvider = new Sun14ReflectionProvider();  
  58.         }  
  59.   
  60.         if (JAXP_DOM_XML.equals(driver))  
  61.         {  
  62.   
  63.             xstream = new XStream(reflectProvider, new DomDriver());  
  64.             xstream.autodetectAnnotations(true);  
  65.   
  66.             System.err.println(xstream.getReflectionProvider());  
  67.         }  
  68.         else if (XPP3_XML_PARSER.equals(driver))  
  69.         {  
  70.             xstream = new XStream(reflectProvider, new XppDriver());  
  71.             xstream.autodetectAnnotations(true);  
  72.         }  
  73.         else if (STAX_JSON_PARSER.equals(driver))  
  74.         {  
  75.             xstream = new XStream(reflectProvider, new JettisonMappedXmlDriver());  
  76.             xstream.setMode(XStream.NO_REFERENCES);  
  77.         }  
  78.         else if (WRITER_JSON_PARSER.equals(driver))  
  79.         {  
  80.             xstream = new XStream(reflectProvider, new JsonHierarchicalStreamDriver());  
  81.             xstream.setMode(XStream.NO_REFERENCES);  
  82.         }  
  83.         else  
  84.         {  
  85.             xstream = new XStream(reflectProvider, new DomDriver());  
  86.         }  
  87.   
  88.         return xstream;  
  89.     }  
  90.   
  91.     /** 
  92.      * 持久化对象列表. 
  93.      *  
  94.      * <pre> 
  95.      *      持久化对象列表,存储到指定用户主目录下的指定目录 
  96.      * </pre> 
  97.      * @param dir 目录 
  98.      * @param objects 对象列表 
  99.      */  
  100.     @SuppressWarnings("unchecked")  
  101.     public void persist(String dir, List objects)  
  102.     {  
  103.         PersistenceStrategy strategy = new FilePersistenceStrategy(new File(System.getProperty("user.home"), dir));  
  104.   
  105.         List<?> list = new XmlArrayList(strategy);  
  106.   
  107.         list.addAll(objects);  
  108.     }  
  109.   
  110.     // prinvate fields.  
  111.     private static XStream xstream;  
  112.   
  113. }  


EnhancedModeReflectProvider.java

Java代码  收藏代码
  1. /** 
  2.  * <pre> 
  3.  * Title:       EnhancedModeReflectProvider.java 
  4.  * Author:      tl 
  5.  * Create:      2011-6-10 下午02:50:18 
  6.  * Copyright:   Copyright (c) 2011 
  7.  * Company:     Shenzhen ***** 
  8.  * <pre> 
  9.  */  
  10. package cn.bisoft.java.test;  
  11.   
  12. import java.lang.reflect.Field;  
  13. import java.lang.reflect.Modifier;  
  14.   
  15. import com.thoughtworks.xstream.converters.reflection.Sun14ReflectionProvider;  
  16.   
  17. /** 
  18.  * <pre> 
  19.  * 支持静态字段转换,但有缺陷,字段不能映射成属性. 
  20.  * </pre> 
  21.  * @author tl 
  22.  * @version 1.0, 2011-6-10 
  23.  */  
  24. public class EnhancedModeReflectProvider extends Sun14ReflectionProvider  
  25. {  
  26.     @Override  
  27.     protected boolean fieldModifiersSupported(Field field)  
  28.     {  
  29.         return !(Modifier.isTransient(field.getModifiers()));  
  30.     }  
  31.       
  32. }  


ExampleMessageBody.java

Java代码  收藏代码
  1. package cn.bisoft.java.test;  
  2.   
  3. import java.util.ArrayList;  
  4. import java.util.Date;  
  5. import java.util.List;  
  6.   
  7. import com.thoughtworks.xstream.annotations.XStreamAlias;  
  8. import com.thoughtworks.xstream.annotations.XStreamAsAttribute;  
  9. import com.thoughtworks.xstream.annotations.XStreamInclude;  
  10. import com.thoughtworks.xstream.annotations.XStreamOmitField;  
  11.   
  12. @SuppressWarnings("unused")  
  13. @XStreamAlias("body")  
  14. public class ExampleMessageBody  
  15. {  
  16.     @XStreamAsAttribute  
  17.     private static final String type = "example";  
  18.       
  19.     private String id = "message id";  
  20.   
  21.     private Date timestamp;  
  22.       
  23.     /** 当userList节点必须存在是, 需要初始化. 值为空的字段是不会输出到XML的. */  
  24.     @XStreamAlias("users")  
  25.     private List<User> userList = new ArrayList<User>();  
  26.       
  27.     @XStreamAlias("user")  
  28.     public static class User  
  29.     {  
  30.         @XStreamAsAttribute  
  31.         private String id;  
  32.   
  33.         @XStreamAsAttribute  
  34.         private Date birth;  
  35.           
  36.         @XStreamOmitField  
  37.         private String password;  
  38.   
  39.         public String getId()  
  40.         {  
  41.             return id;  
  42.         }  
  43.   
  44.         public void setId(String id)  
  45.         {  
  46.             this.id = id;  
  47.         }  
  48.   
  49.         public Date getBirth()  
  50.         {  
  51.             return birth;  
  52.         }  
  53.   
  54.         public void setBirth(Date birth)  
  55.         {  
  56.             this.birth = birth;  
  57.         }  
  58.   
  59.         public String getPassword()  
  60.         {  
  61.             return password;  
  62.         }  
  63.   
  64.         public void setPassword(String password)  
  65.         {  
  66.             this.password = password;  
  67.         }  
  68.           
  69.     }  
  70.   
  71.       
  72.     public String getId()  
  73.     {  
  74.         return id;  
  75.     }  
  76.   
  77.     public void setId(String id)  
  78.     {  
  79.         this.id = id;  
  80.     }  
  81.   
  82.     public Date getTimestamp()  
  83.     {  
  84.         return timestamp;  
  85.     }  
  86.   
  87.     public void setTimestamp(Date timestamp)  
  88.     {  
  89.         this.timestamp = timestamp;  
  90.     }  
  91.   
  92.     public List<User> getUserList()  
  93.     {  
  94.         return userList;  
  95.     }  
  96.   
  97.     public void setUserList(List<User> userList)  
  98.     {  
  99.         this.userList = userList;  
  100.     }  
  101.   
  102. }  


TestXStream.java

Java代码  收藏代码
  1. package cn.bisoft.java.test;  
  2.   
  3. import java.util.ArrayList;  
  4. import java.util.Date;  
  5. import java.util.List;  
  6.   
  7. import com.thoughtworks.xstream.XStream;  
  8.   
  9. public class TestXStream  
  10. {  
  11.       
  12.     public static void main(String[] args)  
  13.     {  
  14.         XStream xstream = XStreamFacade.getXStream(XStreamFacade.JAXP_DOM_XML, true);  
  15.           
  16.         ExampleMessageBody body = new ExampleMessageBody();  
  17.           
  18.         body.setId("0");  
  19.         body.setTimestamp(new Date());  
  20.           
  21.         List<ExampleMessageBody.User> userList = new ArrayList<ExampleMessageBody.User>();  
  22.         ExampleMessageBody.User user = new ExampleMessageBody.User();  
  23.         user.setBirth(new Date());  
  24.         user.setId("tl");  
  25.         user.setPassword("123456");  
  26.         userList.add(user);  
  27.           
  28.         body.setUserList(userList);  
  29.           
  30.         xstream.useAttributeFor("type", ExampleMessageBody.class);  
  31.         String xml = xstream.toXML(body);  
  32.           
  33.         System.out.println(xml);  
  34.     }  
  35. }  


说明:
1. 静态字段其实没有必要序列化.
2. 集合类型通常需要进行初始化.
重庆淘宝运营 重庆淘宝运营
原创粉丝点击
热门IT博客
笑傲江湖 排名 知乎笑傲江湖 排名 知乎
淘宝卖家如何寄快递淘宝卖家如何寄快递
横须贺刺绣外套淘宝
设计装修软件
mysql时间戳转日期
淘宝锚点定位跳转
顶速网络机顶盒
类似王侯将相宁有种乎
植物学 网络
电脑上解压缩软件
淘宝参加会员打折
怎么在淘宝搜岛国片
外汇看盘软件
淘宝订单时间
下载淘宝网2016新版
小米手机没有4g网络
第一装甲师 知乎
幼儿学拼音软件
抗美援朝不该打 知乎
python 重载
热门问题 老师的惩罚 人脸识别 我在镇武司摸鱼那些年 重生之率土为王 我在大康的咸鱼生活 盘龙之生命进化 天生仙种 凡人之先天五行 春回大明朝 姑娘不必设防，我是瞎子 金鸡叫天都 黄山天都 天都学院 天都赛鸽 天都峰旅游 松鼠跳天都 黄山天都峰 不朽天都 天都城 天都峰资料 大理天都 血色天都 天都数控 天都峰拼音 天都公园 霍天都 太乙近天都 天都峰图片 天都赛鸽中心 金鸡叫天都图片 天都公棚秋棚 爬天都峰教案 爬天都峰教学设计 黄山天都价格 爬天都峰课文 云外天都作品 黄山天都16支价格 拘留十五天都干啥 爬天都峰板书设计 天都峰在哪里 尚宫云外天都 天都赛鸽中心秋棚 云南天都公棚 黄山金鸡叫天都照片 爬天都峰板书 天都烟16支价格 天都峰的资料 云南大理天都赛鸽文化中心 登天都峰阅读答案 酬组词 酬

程序博客网，程序员的互联网技术博客家园。csdn论坛精品 msdn技术资料都在这里