XStream别名指南

最新推荐文章于 2024-09-27 13:55:29 发布
最新推荐文章于 2024-09-27 13:55:29 发布
阅读量1.1k 收藏 1
点赞数
分类专栏： java 文章标签： blog string class object xml import

　　1，存在的问题
设想我们的客户端定义了一个用于XStream读写的XML文件：
我们将设计一些模型类并配置XStream按照这个XML文件格式执行读写操作。

源码 复制 打印
  1. <blog author="Guilherme Silveira">    
  2.   <entry>    
  3.     <title>first</title>    
  4.     <description>My first blog entry.</description>    
  5.   </entry>    
  6.   <entry>    
  7.     <title>tutorial</title>    
  8.     <description>    
  9.         Today we have developed a nice alias tutorial. Tell your friends! NOW!    
  10.     </description>    
  11.   </entry>    
  12. </blog>  



　　2，模型：
首先，建立一个简单的Blog对象：

源码 复制 打印
  1. package com.thoughtworks.xstream;     
  2. public class Blog {    
  3.         private Author author;    
  4.         private List entries = new ArrayList();     
  5.         public Blog(Author author) {    
  6.                 this.author = author;    
  7.         }     
  8.         public void add(Entry entry) {    
  9.                 entries.add(entry);    
  10.         }     
  11.         public List getContent() {    
  12.                 return entries;    
  13.         }    
  14. }  



然后是一个带有名字的作者对象：

源码 复制 打印
  1. package com.thoughtworks.xstream;     
  2. public class Author {    
  3.         private String name;    
  4.         public Author(String name) {    
  5.                 this.name = name;    
  6.         }    
  7.         public String getName() {    
  8.                 return name;    
  9.         }    
  10. }  


具体的blog内容对象：

源码 复制 打印
  1. package com.thoughtworks.xstream;     
  2. public class Entry {    
  3.         private String title, description;    
  4.         public Entry(String title, String description) {    
  5.                 this.title = title;    
  6.                 this.description = description;    
  7.         }    
  8. }  



虽然我们没有创建getters/setters方法，但这并不影响XStream对XML->Object文件的解析。
　　3，简单的测试
首先初始化一个blog实例，然后使用XStream来序列化

源码 复制 打印
  1. public static void main(String[] args) {     
  2.         Blog teamBlog = new Blog(new Author("Guilherme Silveira"));    
  3.         teamBlog.add(new Entry("first","My first blog entry."));    
  4.         teamBlog.add(new Entry("tutorial",    
  5.                 "Today we have developed a nice alias tutorial. Tell your friends! NOW!"));    
  6.         XStream xstream = new XStream();    
  7.         System.out.println(xstream.toXML(teamBlog));    
  8. }  



由该Blog实例解析出的XML文件为：

源码 复制 打印
  1. <com.thoughtworks.xstream.Blog>    
  2.   <author>    
  3.     <name>Guilherme Silveira</name>    
  4.   </author>    
  5.   <entries>    
  6.     <com.thoughtworks.xstream.Entry>    
  7.       <title>first</title>    
  8.       <description>My first blog entry.</description>    
  9.     </com.thoughtworks.xstream.Entry>    
  10.     <com.thoughtworks.xstream.Entry>    
  11.       <title>tutorial</title>    
  12.       <description>    
  13.         Today we have developed a nice alias tutorial. Tell your friends! NOW!    
  14.       </description>    
  15.     </com.thoughtworks.xstream.Entry>    
  16.   </entries>    
  17. </com.thoughtworks.xstream.Blog>  



　　4，为类取别名首先我们来改变XStream对com.thoughtworks.xstream.Blog的输出名称。
我们只想使用一个简单的blog来取代。下面为Blog类创建一个别名：Xstream.alias("blog",Blog.class);同样的，为Entry类创建一个别名：Xstream.alias("entry",Entry.class);好，到此输出的XML变为：

源码 复制 打印
  1. <blog>    
  2.   <author>    
  3.     <name>Guilherme Silveira</name>    
  4.   </author>    
  5.   <entries>    
  6.     <entry>    
  7.       <title>first</title>    
  8.       <description>My first blog entry.</description>    
  9.     </entry>    
  10.     <entry>    
  11.       <title>tutorial</title>    
  12.       <description>    
  13.         Today we have developed a nice alias tutorial. Tell your friends! NOW!    
  14.       </description>    
  15.     </entry>    
  16.   </entries>    
  17. </blog>  




　　5，去掉entries标记
下面，我们将实施叫做"implicit collection"的过程（即取消标记）：所有的集合类型，都不需要显示他的根标签(root tag)，你可以直接使用一个implicit collection去映射。
在我们的例子里面，我们不希望出现entries标签，只需要一个接一个的列出所有的entry标签即可。
要做到这点，只需要简单的调用XStream对象上的addImplicitCollection方法，就可以配置XStream取消对entries的输出：

源码 复制 打印
  1. package com.thoughtworks.xstream;    
  2. import java.util.ArrayList;    
  3. import java.util.List;    
  4. public class Test {    
  5.         public static void main(String[] args) {    
  6.                 Blog teamBlog = new Blog(new Author("Guilherme Silveira"));    
  7.                 teamBlog.add(new Entry("first","My first blog entry."));    
  8.                 teamBlog.add(new Entry("tutorial",    
  9.                         "Today we have developed a nice alias tutorial. Tell your friends! NOW!"));    
  10.                 XStream xstream = new XStream();    
  11.                 xstream.alias("blog", Blog.class);    
  12.                 xstream.alias("entry", Entry.class);    
  13.                 xstream.addImplicitCollection(Blog.class, "entries");    
  14.                 System.out.println(xstream.toXML(teamBlog));    
  15.         }    
  16. }  



注意addImplicitCollection方法的调用，需要描述在某个类上的某个成员变量不需要被显示。
得到的结果基本上达到了要求：

源码 复制 打印
  1. <blog>    
  2.   <author>    
  3.     <name>Guilherme Silveira</name>    
  4.   </author>    
  5.   <entry>    
  6.     <title>first</title>    
  7.     <description>My first blog entry.</description>    
  8.   </entry>    
  9.   <entry>    
  10.     <title>tutorial</title>    
  11.     <description>    
  12.         Today we have developed a nice alias tutorial. Tell your friends! NOW!    
  13.     </description>    
  14.   </entry>    
  15. </blog>  



　　7，为属性添加别名
下一步是要把author成员变量设置为XML的属性。要做到这点，我们需要告诉XStream将author属性作为Blog类的"author"属性。
xstream.useAttributeFor(Blog.class,"author")；
现在留给我们一个问题，XStream怎么讲一个Author转换成一个String对象让他在Blog节点中以author属性显示？
只需要使用SimpleValeConverter并且实现我们自己的Author转换器：
class AuthorConverter implements SingleValueConverter {
}
第一个需要实现的方法是告诉XStream该转化器是用来转换什么类型的对象：
public boolean canConvert(Class type) {
return type.equals(Author.class);
}
接下来是将一个Author实例转化成字符串：
public String toString(Object obj) {
return ((Author) obj).getName();
}
最后是相反的工作：怎么从一个字符串中得到Author实例
public Object fromString(String name) {
return new Author(name);
}
最后，该转化器看起来是这样：
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);
}
}
然后将这个转化器注册到XStream：

源码 复制 打印
  1. public class Test {    
  2.         public static void main(String[] args) {    
  3.                 Blog teamBlog = new Blog(new Author("Guilherme Silveira"));    
  4.                 teamBlog.add(new Entry("first","My first blog entry."));    
  5.                 teamBlog.add(new Entry("tutorial",    
  6.                         "Today we have developed a nice alias tutorial. Tell your friends! NOW!"));    
  7.                 XStream xstream = new XStream();    
  8.                 xstream.alias("blog", Blog.class);    
  9.                 xstream.alias("entry", Entry.class);    
  10.                 xstream.addImplicitCollection(Blog.class, "entries");    
  11.                 xstream.useAttributeFor(Blog.class, "author");    
  12.                 xstream.registerConverter(new AuthorConverter());    
  13.                 System.out.println(xstream.toXML(teamBlog));    
  14.         }    
  15. }  

最后的输出：

源码 复制 打印
  1. <blog author="Guilherme Silveira">    
  2.   <entry>    
  3.     <title>first</title>    
  4.     <description>My first blog entry.</description>    
  5.   </entry>    
  6.   <entry>    
  7.     <title>tutorial</title>    
  8.     <description>    
  9.         Today we have developed a nice alias tutorial. Tell your friends! NOW!    
  10.     </description>    
  11.   </entry>    
  12. </blog>  



在这里，useAttributeFor方法被其他几个相似功能的方法重载，包括一个接受一个额外的字符串(Class , String, String)的版本，该版本告诉XStream将该属性创建为另一个别名，比如在这里，如果使用useAttributeFor(Blog.class , "author", "auth")会将"author"属性在XML中映射成"auth"属性。

kilys0526
关注
专栏目录
java xstream jar_xStream.jar踩坑指南
weixin_34576293的博客
02-13 1220
前言第一次接触Xstream，是在做一个socket通信的项目，由于是二次重新开发，所以有部分代码沿用了原来的代码(改造前用的webservice)，其中xml字符串转换为对象，以及对象转换为xml字符串的代码用到了这个包，所以我也就照葫芦画瓢，最终把项目顺利做完了，由于没有遇到什么问题，所以也就没有对Xstream做深入的了解和探索，直到前几天又接手到一个新的项目，里面接口调用涉及到同样的业务需...
xstream-1.4.15.jar
01-28
XStream 反序列化漏洞（CVE-2020-26258 & 26259）,修复jar包 xstream-1.4.15.jar Xstream 是 Java 类库，用来将对象序列化成 XML (JSON) 或反序列化为对象。XStream 是一款开源软件，允许在 BSD 许可证的许可下分发...
xstream 别名的用法
热门推荐
subuser的专栏
03-19 3万+
1.xstream的alias使用方法：        1.1 作用：将序列化中的类全量名称，用别名替换。        1.2  使用方法：xstream.alias("blog", Blog.class);        1.3  示例：             要序列化的类： package test.xstream.test; public class Author { p
详解XStream别名
weixin_33860528的博客
12-20 319
在上一节中，我们已经看到了XStream是多么的简单易用，本文将继续以实例的方式讲解XStream别名。毕竟，你的JAVA对象不可能总是与XML结构毫发无差的，谁也不确定某个开发者手误打错了字母，或者是报文的名称发生了变化。假设输出如下的XML结构，我们应该怎么做呢？&lt;blog author="一个木瓜"&gt;     &lt;entry&gt;       &lt;title&gt;第一...
java的xstream,XStream - 别名
weixin_29363919的博客
03-16 191
XStream - 别名别名是用来将Java对象序列化为特殊格式的XML的一种方式，接下来我们看一下将Student对象格式化成指定格式XML的例子。firstMyfirstassignment.secondMysecondassignment.基于上面的XML格式，创建一个Studment类.classStudent{privateStringstudentName;privat...
关于XStream相关的常用方法；设置别名；忽略属性；设置xml字段属性
boss_way的博客
11-09 7959
关于XStream相关的常用方法 1.设置别名 //第一个参数是想要设置的别名，第二个是类对象 xstream.alias(“省份”,Province.class);//类别名 // 第一个参数是想要设置的别名，第二个是类对象，第三个是对应的类中的属性名 xstream.aliasField(“编号”,City.class,”id”);//属性别名   2.忽略属性 // 第一
java回复图文消息_微信公众号开发之回复图文消息java代码
weixin_39832628的博客
02-13 200
微信公众号开发之回复图文消息，供大家参考，具体内容如下图文消息的主要参数说明通过微信官方的消息接口指南，可以看到对图文消息的参数介绍，如下图所示：从上图可以了解到：1、图文消息的个数限制为10，也就是图文中ArticleCount的值(图文消息的个数，限制在10条以内)2、对于图文消息，第一条图文的图片显示为大图，其他图文的图片显示为小图。3、第一条图文的图片大小建议为640*320，其他图文的图...
xStream 开发指南
04-27
xStream 是一个强大的 Java 库，它允许开发者轻松地在 Java 对象和 XML 或 JSON 文档之间进行序列化和反序列化。这个框架的核心优势在于其简单易用的API和高度自定义的能力，使得对象的表示能精确地映射到 XML 或 ...
xstream最新版 - xstream-1.4.18.jar
12-21
xstream最新版jar包
xstream-1.4.19.jar
05-04
xstream-1.4.19.jar
Xstream基本使用
qq_40085888的博客
08-24 1645
  Xstream是一个封装了xml与javaObj互转的框架. 下面记录下一些基本用法 注意,转换的时候,是根据字段名称来进行的,与set get方法名无关 1. @XStreamAlias("alias") 用于指定obj对应xml中的元素 &lt;?xml version="1.0" encoding="UTF-8"?&gt; &lt;aliasDemo&gt; &lt...
XStream生成XMl文件，设置别名
孤雁是天的寂寞
09-24 1093
public class B2BPayToXml { public Head head; public Body body; public void setHead(Head head) { this.head = head; } public void setBody(Body body) { this.bo...
XStream 如何使用注解定义别名
奋斗的土豆
07-07 4028
@XStreamAlias("ContractRoot") public class ContractRoot { @XStreamAlias("TcpCont") private TcpCont TcpCont; @XStreamAsAttribute//以属性的形式出现 @XStreamAlias("SvcCont") private SvcCont SvcCont; publi
XStream指定别名
tuxq5721
12-10 2993
XStream Alias 总结 要达到的效果 需要的Model 简单测试 类别名 字段别名 隐式集合 属性别名 包别名   总结 主要如下： 可以使用类的别名来改变标签名称
java 利用Xstream对list中的string起别名
青鸟飞鱼
01-09 3724
1. [代码]1.实体类：PersonBean     跳至 [1] [2] [3] [4] [5] [6] [7] [8] [9] [全屏预览] ? 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 2
java-快速将普通main类变为javafx类，并加载自定义fxml
最新发布
随笔
09-27 98
java-快速将普通main类变为javafx类，并加载自定义fxml
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值