XStream使用详解

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730

阅读目录 开始 1.Xstream介绍 2.Xstream的基本使用 3.Xstream序列化重命名 4.Xstream注解的使用 5.Xstream自定义的转换器 6.Xstream对象流的使用 7.Xstream持久化API 8.Xstream操作Json 回到顶部 1.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)     {         this.name=name;         this.age=age;     }     @Override     public String toString()     {         return "Person [name=" + name + ", age=" + age + "]";     } } public class Test {     public 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);     } }     程序运行结果： <test.Person>   <name>张三</name>   <age>19</age> </test.Person> Person [name=张三, age=19] {"test.Person":{"name":"张三","age":19}} Person [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序列化XML     Xstream序列化XML时可以允许用户使用不同的XML解析器，用户可以使用一个标准的JAXP DOM解析器或自Java6集成StAX解析器。这样用户就不需要依赖xpp3-[version].jar。     Xstream序列化XML时，也可以对XML节点重命名。 public class Test {     public 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);     } }     程序运行结果： <?xml version="1.0" ?><人><name>张三</name><age>19</age></人> Person [name=张三, age=19] (2)Xstream序列化Json     Xstream序列化Json与序列化XML类似，例如： public class Test {     public 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":19}} Person [name=张三, age=19] 回到顶部 3.Xstream序列化重命名   (1)为包重命名：Xstream.aliasPackage()方法 public class Test {     public 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);     } }     程序运行结果： <com.lzw.Person>   <name>张三</name>   <age>19</age> </com.lzw.Person> Person [name=张三, age=19] (2)为类重命名：Xstream.alias()方法 public class Test {     public 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);     } }     程序运行结果： <人>   <name>张三</name>   <age>19</age> </人> Person [name=张三, age=19] (3)为字段重命名：Xstream.aliasField()方法 public class Test {     public 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);     } }     程序运行结果： <test.Person>   <姓名>张三</姓名>   <年龄>19</年龄> </test.Person> Person [name=张三, age=19] (4)省略集合根节点：Xstream.addImplicitCollection()方法 class Person {     private String name;     private int age;     private List friends;     public Person(String name, int age, String... friends)     {         this.name = name;         this.age = age;         this.friends = Arrays.asList(friends);     }     @Override     public String toString()     {         return "Person [name=" + name + ", age=" + age + ", friends=" + friends + "]";     } } public class Test {     public 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);     } }     程序运行结果： <test.Person>   <name>张三</name>   <age>19</age>   <string>李四</string>   <string>王五</string>   <string>赵六</string> </test.Person> Person [name=张三, age=19, friends=[李四, 王五, 赵六]] (5)把字段节点设置成属性：Xstream.useAttributeFor()方法 public class Test {     public 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);     } }     程序运行结果： <test.Person name="张三">   <age>19</age>   <friends class="java.util.Arrays$ArrayList">     <a class="string-array">       <string>李四</string>       <string>王五</string>       <string>赵六</string>     </a>   </friends> </test.Person> Person [name=张三, age=19, friends=[李四, 王五, 赵六]] (6)隐藏字段：xstream.omitField()方法 public class Test {     public 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);     } }     程序运行结果： <test.Person>   <name>张三</name>   <age>19</age> </test.Person> Person [name=张三, age=19, friends=null] 回到顶部 4.Xstream注解的使用   (1)设置Xstream应用注解     使用Xstream注解前需要对Xstream进行配置，可以使用两种方式：应用某个JavaBean类的注解或自动使用JavaBean类的注解。代码如下： XStream xstream = new XStream(); xstream.processAnnotations(Person.class);//应用Person类的注解 xstream.autodetectAnnotations(true);//自动检测注解 (2)重命名注解：@XStreamAlias() @XStreamAlias("人") class Person {     @XStreamAlias("姓名")     private String name;     @XStreamAlias("年龄")     private int age;     @XStreamAlias("朋友")     private List friends;     public Person(String name, int age, String... friends)     {         this.name = name;         this.age = age;         this.friends = Arrays.asList(friends);     }     @Override     public String toString()     {         return "Person [name=" + name + ", age=" + age + ", friends=" + friends + "]";     } }     程序运行结果： <人>   <姓名>张三</姓名>   <年龄>19</年龄>   <朋友 class="java.util.Arrays$ArrayList">     <a class="string-array">       <string>李四</string>       <string>王五</string>       <string>赵六</string>     </a>   </朋友> </人> Person [name=张三, age=19, friends=[李四, 王五, 赵六]] (3)省略集合根节点：@XStreamImplicit class Person {     private String name;     private int age;     //@XStreamImplicit//只隐藏集合根节点     @XStreamImplicit(itemFieldName="朋友")//设置重复的节点名，可能会导致无法反序列化     private List<String> friends;     public Person(String name, int age, String... friends)     {         this.name = name;         this.age = age;         this.friends = Arrays.asList(friends);     }     @Override     public String toString()     {         return "Person [name=" + name + ", age=" + age + ", friends=" + friends + "]";     } }     程序运行结果： <test.Person>   <name>张三</name>   <age>19</age>   <朋友>李四</朋友>   <朋友>王五</朋友>   <朋友>赵六</朋友> </test.Person> Person [name=张三, age=19, friends=[李四, 王五, 赵六]] (4)把字段节点设置成属性：@XStreamAsAttribute class Person {     @XStreamAsAttribute     private String name;     @XStreamAsAttribute     private int age;     private List<String> friends;     public Person(String name, int age, String... friends)     {         this.name = name;         this.age = age;         this.friends = Arrays.asList(friends);     }     @Override     public String toString()     {         return "Person [name=" + name + ", age=" + age + ", friends=" + friends + "]";     } }     程序运行结果： <test.Person name="张三" age="19">   <friends class="java.util.Arrays$ArrayList">     <a class="string-array">       <string>李四</string>       <string>王五</string>       <string>赵六</string>     </a>   </friends> </test.Person> Person [name=张三, age=19, friends=[李四, 王五, 赵六]] (5)隐藏字段：@XStreamOmitField class Person {     private String name;     private int age;     @XStreamOmitField     private List<String> friends;     public Person(String name, int age, String... friends)     {         this.name = name;         this.age = age;         this.friends = Arrays.asList(friends);     }     @Override     public String toString()     {         return "Person [name=" + name + ", age=" + age + ", friends=" + friends + "]";     } }     程序运行结果： <test.Person>   <name>张三</name>   <age>19</age> </test.Person> Person [name=张三, age=19, friends=null] (6)设置转换器：@XStreamConverter() class Person {     private String name;     private int age;         @XStreamConverter(value=BooleanConverter.class,booleans={false},strings={"男","女"})     private boolean sex;     public Person(String name, int age, boolean sex)     {         this.name = name;         this.age = age;         this.sex=sex;     }     @Override     public String toString()     {         return "Person [name=" + name + ", age=" + age + ", sex=" + sex + "]";     } }     程序运行结果： <test.Person>   <name>张三</name>   <age>19</age>   <sex>男</sex> </test.Person> Person [name=张三, age=19, sex=true] 回到顶部 5.Xstream自定义的转换器   (1)Xstream自带的转换器     Xstream内部有许多转换器，用于JavaBean对象到XML或Json之间的转换。这些转换器的详细信息网址：http://xstream.codehaus.org/converters.html (2)使用自定义的转换器 class Person {     private String name;     private int age;     public Person(String name, int age)     {         this.name = name;         this.age = age;     }     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;     }     @Override     public 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或Json     public 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 Test {     public 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);     } }     程序运行结果： <test.Person>   <姓名>张三</姓名>   <年龄>19</年龄>   <转换器>自定义的转换器</转换器> </test.Person> Person [name=张三, age=19] (3)常用的转换器接口与抽象类     SingleValueConverter：单值转换接口     AbstractSingleValueConverter：单值转换抽象类     Converter：常规转换器接口 回到顶部 6.Xstream对象流的使用   (1)Xstream对象输出流 class Person {     private String name;     private int age;     public Person(String name, int age)     {         this.name = name;         this.age = age;     } } public class Test {     public static void main(String[] args) throws IOException     {               XStream 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();     } }     程序运行结果： <object-stream>   <test.Person>     <name>张三</name>     <age>12</age>   </test.Person>   <test.Person>     <name>李四</name>     <age>19</age>   </test.Person>   <string>Hello</string>   <int>12345</int> </object-stream>     注意：XStream对象流是通过标准java.io.ObjectOutputStream和java.io.ObjectInputStream对象。因为XML文档只能有一个根节点,必须包装在一个序列化的所有元素 额外的根节点。 这个根节点默认 < object-stream > 上面的例子所示。 (2)Xstream对象输出流 class Person {     private String name;     private int age;     public Person(String name, int age)     {         this.name = name;         this.age = age;     }     @Override     public String toString()     {         return "Person [name=" + name + ", age=" + age + "]";     } } public class Test {     public static void main(String[] args) throws IOException, ClassNotFoundException     {         String s="<object-stream><test.Person><name>张三</name><age>12</age></test.Person><int>12345</int></object-stream>";         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=12] 12345 回到顶部 7.Xstream持久化API   (1)保存JavaBean对象 class Person {     private String name;     private int age;     public Person(String name, int age)     {         this.name = name;         this.age = age;     }     @Override     public String toString()     {         return "Person [name=" + name + ", age=" + age + "]";     } } public class Test {     public static void main(String[] args) throws IOException, ClassNotFoundException     {         PersistenceStrategy 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目录,有三个文件:int@0.xml、int@1.xml、int@2.xml；每个对象都被序列化到XML文件里。 (2)读取并删除JavaBean对象 public class Test {     public static void main(String[] args) throws IOException, ClassNotFoundException     {         PersistenceStrategy 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=13] Person [name=李四, age=21] Person [name=王五, age=17] 回到顶部 8.Xstream操作Json   (1)Xstream序列化Json的重命名 @XStreamAlias("人") class Person {     @XStreamAlias("姓名")     private String name;     @XStreamAlias("年龄")     private int age;     public Person(String name, int age)     {         this.name = name;         this.age = age;     }     @Override     public String toString()     {         return "Person [name=" + name + ", age=" + age + "]";     } } public class Test {     public static void main(String[] args)     {         Person bean=new Person("张三",19);         XStream xstream = new XStream(new JettisonMappedXmlDriver());//设置Json解析器         xstream.autodetectAnnotations(true);         //Json序列化         String xml = xstream.toXML(bean);         System.out.println(xml);         //Json反序列化         bean=(Person)xstream.fromXML(xml);         System.out.println(bean);     } }     程序运行结果： {"人":{"姓名":"张三","年龄":19}} Person [name=张三, age=19]     注意：Xstream序列化Json的重命名的方式与其序列化成XML的方式一样！ (2)去掉序列化Json的根节点 class Person {     private String name;     private int age;     public Person(String name, int age)     {         this.name = name;         this.age = age;     }     @Override     public String toString()     {         return "Person [name=" + name + ", age=" + age + "]";     } } public class Test00 {     public static void main(String[] args)     {         Person bean=new Person("张三",19);         XStream xstream = new XStream(new JsonHierarchicalStreamDriver()         {             public HierarchicalStreamWriter createWriter(Writer writer)             {                 return new JsonWriter(writer, JsonWriter.DROP_ROOT_MODE);             }         });         //Json序列化         String xml = xstream.toXML(bean);         System.out.println(xml);     } }     程序运行结果： { "name": "张三", "age": 19 }     注意：去掉根节点后的Json串是不能反序列化的，因为XStream 不知道它的类型。 (3)Json的解析器区别     前面两个例子使用了不同的Json解析器，这里说明他们的不同之处： JettisonMappedXmlDriver：是支持序列化和反序列化Json的。 JsonHierarchicalStreamDriver：只支持序列化，不支持反序列化。 -------------------------------------------------------------------