Xstream学习笔记.doc

Xstream操作Xml与Json1. Xstream介绍1(1) Xstream介绍1(2) Xstream的简单例子12. Xstream的基本使用2(1) Xstream序列化XML2(2) Xstream序列化Json33. Xstream序列化重命名3(1) 为包重命名：Xstream.aliasPackage()方法3(2) 为类重命名：Xstream.alias()方法3(3) 为字段重命名：Xstream.aliasField()方法4(4) 省略集合根节点：Xstream.addImplicitCollection()方法4(5) 把字段节点设置成属性：Xstream.useAttributeFor()方法5(6) 隐藏字段：xstream.omitField()方法54. Xstream注解的使用6(1) 设置Xstream应用注解6(2) 重命名注解：XStreamAlias()6(3) 省略集合根节点：XStreamImplicit7(4) 把字段节点设置成属性：XStreamAsAttribute7(5) 隐藏字段：XStreamOmitField8(6) 设置转换器：XStreamConverter()85. Xstream自定义的转换器8(1) Xstream自带的转换器8(2) 使用自定义的转换器8(3) 常用的转换器接口与抽象类106. Xstream对象流的使用10(1) Xstream对象输出流10(2) Xstream对象输出流117. Xstream持久化API11(1) 保存JavaBean对象11(2) 读取并删除JavaBean对象128. Xstream操作Json12(1) Xstream序列化Json的重命名12(2) 去掉序列化Json的根节点13(3) Json的解析器区别14作者：李志伟时间：2014-06-301. Xstream介绍(1) Xstream介绍Xstream是一种OXMapping 技术，是用来处理XML文件序列化的框架,在将JavaBean序列化，或将XML文件反序列化的时候，不需要其它辅助类和映射文件，使得XML序列化不再繁索。Xstream也可以将JavaBean序列化成Json或反序列化，使用非常方便。(2) Xstream的简单例子class Person/JavaBean实体类private String name;private int age;public Person(String name,int age)=name;this.age=age;Overridepublic String toString()return Person name= + name + , age= + age + ;public class Testpublic static void main(String args)Person bean=new Person(张三,19);XStream xstream = new XStream();/XML序列化String xml = xstream.toXML(bean);System.out.println(xml);/XML反序列化bean=(Person)xstream.fromXML(xml);System.out.println(bean);xstream = new XStream(new JettisonMappedXmlDriver();xstream.setMode(XStream.NO_REFERENCES);/Json序列化String json=xstream.toXML(bean);System.out.println(json);/Json反序列bean=(Person)xstream.fromXML(json);System.out.println(bean);程序运行结果： 张三 19Person name=张三, age=19test.Person:name:张三,age:19Person name=张三, age=19注意：Xstream序列化XML时需要引用的jar包：xstream-version.jar、xpp3-version.jar、xmlpull-version.jar。Xstream序列化Json需要引用的jar包：jettison-version.jar。使用Xstream序列化时，对JavaBean没有任何限制。JavaBean的字段可以是私有的，也可以没有getter或setter方法，还可以没有默认的构造函数。2. Xstream的基本使用(1) Xstream序列化XMLXstream序列化XML时可以允许用户使用不同的XML解析器，用户可以使用一个标准的JAXP DOM解析器或自Java6集成StAX解析器。这样用户就不需要依赖xpp3-version.jar。Xstream序列化XML时，也可以对XML节点重命名。public class Testpublic static void main(String args)Person bean=new Person(张三,19);/XStream xstream = new XStream();/需要XPP3库/XStream xstream = new XStream(new DomDriver();/不需要XPP3库XStream xstream = new XStream(new StaxDriver();/不需要XPP3库开始使用Java6 xstream.alias(人,Person.class);/为类名节点重命名/XML序列化String xml = xstream.toXML(bean);System.out.println(xml);/XML反序列化bean=(Person)xstream.fromXML(xml);System.out.println(bean);程序运行结果：张三19Person name=张三, age=19(2) Xstream序列化JsonXstream序列化Json与序列化XML类似，例如：public class Testpublic static void main(String args)Person bean=new Person(张三,19);XStream xstream = new XStream(new JettisonMappedXmlDriver();/设置Json解析器 xstream.setMode(XStream.NO_REFERENCES);/设置reference模型,不引用xstream.alias(人,Person.class);/为类名节点重命名/Json序列化String xml = xstream.toXML(bean);System.out.println(xml);/Json反序列化bean=(Person)xstream.fromXML(xml);System.out.println(bean);程序运行结果：人:name:张三,age:19Person name=张三, age=193. Xstream序列化重命名(1) 为包重命名：Xstream.aliasPackage()方法public class Testpublic static void main(String args)Person bean=new Person(张三,19);XStream xstream = new XStream();xstream.aliasPackage(com.lzw, test);/为包名称重命名/序列化String xml = xstream.toXML(bean);System.out.println(xml);/反序列化bean=(Person)xstream.fromXML(xml);System.out.println(bean);程序运行结果： 张三 19Person name=张三, age=19(2) 为类重命名：Xstream.alias()方法public class Testpublic static void main(String args)Person bean=new Person(张三,19);XStream xstream = new XStream();xstream.alias(人, Person.class);/为类名节点重命名/序列化String xml = xstream.toXML(bean);System.out.println(xml);/反序列化bean=(Person)xstream.fromXML(xml);System.out.println(bean);程序运行结果： 张三 19Person name=张三, age=19(3) 为字段重命名：Xstream.aliasField()方法public class Testpublic static void main(String args)Person bean=new Person(张三,19);XStream xstream = new XStream();xstream.aliasField(姓名, Person.class,name);/为类的字段节点重命名xstream.aliasField(年龄, Person.class,age);/为类的字段节点重命名/序列化String xml = xstream.toXML(bean);System.out.println(xml);/反序列化bean=(Person)xstream.fromXML(xml);System.out.println(bean);程序运行结果： 张三 19Person name=张三, age=19(4) 省略集合根节点：Xstream.addImplicitCollection()方法class Personprivate String name;private int age;private List friends;public Person(String name, int age, String. friends) = name;this.age = age;this.friends = Arrays.asList(friends);Overridepublic String toString()return Person name= + name + , age= + age + , friends= + friends + ;public class Testpublic static void main(String args)Person bean =new Person(张三,19,李四,王五,赵六);XStream xstream = new XStream();xstream.addImplicitCollection(Person.class, friends);/省略集合根节点/序列化String xml = xstream.toXML(bean);System.out.println(xml);/反序列化bean=(Person)xstream.fromXML(xml);System.out.println(bean);程序运行结果： 张三 19 李四 王五 赵六Person name=张三, age=19, friends=李四, 王五, 赵六(5) 把字段节点设置成属性：Xstream.useAttributeFor()方法public class Testpublic static void main(String args)Person bean =new Person(张三,19,李四,王五,赵六);XStream xstream = new XStream();xstream.useAttributeFor(Person.class, name);/把字段节点设置成属性/序列化String xml = xstream.toXML(bean);System.out.println(xml);/反序列化bean=(Person)xstream.fromXML(xml);System.out.println(bean);程序运行结果： 19 李四 王五 赵六 Person name=张三, age=19, friends=李四, 王五, 赵六(6) 隐藏字段：xstream.omitField()方法public class Testpublic static void main(String args)Person bean =new Person(张三,19,李四,王五,赵六);XStream xstream = new XStream();xstream.omitField(Person.class, friends);/把字段节点隐藏/序列化String xml = xstream.toXML(bean);System.out.println(xml);/反序列化bean=(Person)xstream.fromXML(xml);System.out.println(bean);程序运行结果： 张三 19Person name=张三, age=19, friends=null4. Xstream注解的使用(1) 设置Xstream应用注解使用Xstream注解前需要对Xstream进行配置，可以使用两种方式：应用某个JavaBean类的注解或自动使用JavaBean类的注解。代码如下：XStream xstream = new XStream();cessAnnotations(Person.class);/应用Person类的注解xstream.autodetectAnnotations(true);/自动检测注解(2) 重命名注解：XStreamAlias()XStreamAlias(人)class PersonXStreamAlias(姓名)private String name;XStreamAlias(年龄)private int age;XStreamAlias(朋友)private List friends;public Person(String name, int age, String. friends) = name;this.age = age;this.friends = Arrays.asList(friends);Overridepublic String toString()return Person name= + name + , age= + age + , friends= + friends + ;程序运行结果： 张三 19 李四 王五 赵六 Person name=张三, age=19, friends=李四, 王五, 赵六(3) 省略集合根节点：XStreamImplicitclass Personprivate String name;private int age;/XStreamImplicit/只隐藏集合根节点XStreamImplicit(itemFieldName=朋友)/设置重复的节点名，可能会导致无法反序列化private List friends;public Person(String name, int age, String. friends) = name;this.age = age;this.friends = Arrays.asList(friends);Overridepublic String toString()return Person name= + name + , age= + age + , friends= + friends + ;程序运行结果： 张三 19 李四 王五 赵六Person name=张三, age=19, friends=李四, 王五, 赵六(4) 把字段节点设置成属性：XStreamAsAttributeclass PersonXStreamAsAttributeprivate String name;XStreamAsAttributeprivate int age;private List friends;public Person(String name, int age, String. friends) = name;this.age = age;this.friends = Arrays.asList(friends);Overridepublic String toString()return Person name= + name + , age= + age + , friends= + friends + ;程序运行结果： 李四 王五 赵六 Person name=张三, age=19, friends=李四, 王五, 赵六(5) 隐藏字段：XStreamOmitFieldclass Personprivate String name;private int age;XStreamOmitFieldprivate List friends;public Person(String name, int age, String. friends) = name;this.age = age;this.friends = Arrays.asList(friends);Overridepublic String toString()return Person name= + name + , age= + age + , friends= + friends + ;程序运行结果： 张三 19Person name=张三, age=19, friends=null(6) 设置转换器：XStreamConverter()class Personprivate String name;private int age; XStreamConverter(value=BooleanConverter.class,booleans=false,strings=男,女)private boolean sex;public Person(String name, int age, boolean sex) = name;this.age = age;this.sex=sex;Overridepublic String toString()return Person name= + name + , age= + age + , sex= + sex + ;程序运行结果： 张三 19 男Person name=张三, age=19, sex=true5. Xstream自定义的转换器(1) Xstream自带的转换器Xstream内部有许多转换器，用于JavaBean对象到XML或Json之间的转换。这些转换器的详细信息网址：/converters.html(2) 使用自定义的转换器class Personprivate String name;private int age;public Person(String name, int age) = name;this.age = age;public String getName()return name;public void setName(String name) = name;public int getAge()return age;public void setAge(int age)this.age = age;Overridepublic String toString()return Person name= + name + , age= + age + ;public class PersonConverter implements Converter Override/定义转换器能转换的JavaBean类型public boolean canConvert(Class type)return type.equals(Person.class);Override/把对象序列化成XML或Jsonpublic void marshal(Object value, HierarchicalStreamWriter writer, MarshallingContext context)Person person = (Person) value; writer.startNode(姓名); writer.setValue(person.getName(); writer.endNode(); writer.startNode(年龄); writer.setValue(person.getAge()+); writer.endNode(); writer.startNode(转换器); writer.setValue(自定义的转换器); writer.endNode();Override/把XML或Json反序列化成对象public Object unmarshal(HierarchicalStreamReader reader, UnmarshallingContext context) Person person = new Person(,-1); reader.moveDown(); person.setName(reader.getValue(); reader.moveUp(); reader.moveDown(); person.setAge(Integer.parseInt(reader.getValue(); reader.moveUp(); return person;public class Testpublic static void main(String args)Person bean =new Person(张三,19);XStream xstream = new XStream();xstream.registerConverter(new PersonConverter();/注册转换器/序列化String xml = xstream.toXML(bean);System.out.println(xml);/反序列化bean=(Person)xstream.fromXML(xml);System.out.println(bean);程序运行结果： 张三 19 自定义的转换器Person name=张三, age=19(3) 常用的转换器接口与抽象类SingleValueConverter：单值转换接口AbstractSingleValueConverter：单值转换抽象类Converter：常规转换器接口6. Xstream对象流的使用(1) Xstream对象输出流class Personprivate String name;private int age;public Person(String name, int age) = name;this.age = age;public class Testpublic static void main(String args) throws IOExceptionXStream xstream = new XStream();ObjectOutputStream out = xstream.createObjectOutputStream(System.out);out.writeObject(new Person(张三,12);out.writeObject(new Person(李四,19);out.writeObject(Hello);out.writeInt(12345);out.close();程序运行结果： 张三 12 李四 19 Hello 12345注意：XStream对象流是通过标准java.io.ObjectOutputStream和java.io.ObjectInputStream对象。因为XML文档只能有一个根节点,必须包装在一个序列化的所有元素 额外的根节点。 这个根节点默认 上面的例子所示。 (2) Xstream对象输出流class Personprivate String name;private int age;public Person(String name, int age) = name;this.age = age;Overridepublic String toString()return Person name= + name + , age= + age + ;public class Testpublic static void main(String args) throws IOException, ClassNotFoundExceptionString s=张三1212345;StringReader reader = new StringReader(s);XStream xstream = new XStream();ObjectInputStream in = xstream.createObjectInputStream(reader);System.out.println(Person) in.readObject();System.out.println(in.readInt();程序运行结果：Person name=张三, age=12123457. Xstream持久化API(1) 保存JavaBean对象class Personprivate String name;private int age;public Person(String name, int age) = name;this.age = age;Overridepublic String toString()return Person name= + name + , age= + age + ;public class Testpublic static void main(String args) throws IOException, ClassNotFoundExceptionPersistenceStrategy strategy = new FilePersistenceStrategy(new File(D:tmp);List list = new XmlArrayList(strategy);list.add(new Person(张三,13);/保存数据list.add(new Person(李四,21);list.add(new Person(王五,17);程序运行结果：如果我们检查D:tmp目录,有三个文件:int0.xml、int1.xml、int2.xml；每个对象都被序列化到XML文件里。(2) 读取并删除JavaBean对象public class Testpublic static void main(String args) throws IOException, ClassNotFoundExceptionPersistenceStrategy strategy = new FilePersistenceStrategy(new File(D:tmp);List list = new XmlArrayList(strategy);for (Iterator it = list.iterator(); it.hasNext();)System.out.println(Person) it.next();it.remove();/删除对象序列化文件程序运行结果：Person name=张三, age=13Person name=李四, age=21Person name=王五, age=178. Xstream操作Json(1) Xstream序列化Json的重命名XStreamAlias(人)class PersonXStreamAlias(姓名)priva