xstream中几个注解的含义和用法(转）

XStream是个很强大的工具，能将Java对象和xml之间相互转化。xstream不在意java类中成员变量是私有还是公有，也不在乎是否有默认构造函数。它调用方式也非常简单：从xml对象转化为java对象，使用fromXML()方法；从java对象序列化为xml，toXML()即可，很方便。xstream也支持注解方式，这些都是为了简化输出而设计，下面为大家简单说一下这几个注解的含义和用法。

1. 当没有任何注解情况下

[java] view plaincopy

public class Cat {
//名字
private String name;
//大小
private Integer age;
//玩具球球具有颜色属性
private List<Ball> balls;
Cat(String name,Integer age,List<Ball> balls){
this.name = name;
this.age = age;
this.balls=balls;
}
//getter/setter方法为了赋值使用

其中Ball定义如下：

[java] view plaincopy

public class Ball {
//颜色
private String color;
Ball(String color){
this.color = color;
}

没有任何注解，输出如下：

[java] view plaincopy

public static void main(String[] args) throws Exception{
//初始化cat
List<Ball> balls = new ArrayList<Ball>();
balls.add(new Ball("red"));
Cat cat = new Cat("馄饨",1,balls);
//初始化结束
//为了方便查找将文件制定到D盘cat.xml中
FileOutputStream fout = new FileOutputStream("D:/cat.xml");
XStream xs = new XStream();
xs.toXML(cat,fout);
}<span style="font-size:14px;">
</span>

得到Cat.xml如下

[java] view plaincopy

<com.timejob.node.Cat>
<name>馄饨</name>
<age>1</age>
<balls>
<com.timejob.node.Ball>
<color>red</color>
</com.timejob.node.Ball>
</balls>
</com.timejob.node.Cat>

1. @XStreamAlias("cat") 等同于 xstream.alias("cat", Cat.class);

[java] view plaincopy

@XStreamAlias("cat") //here
public class Cat {
//名字
private String name;
//大小
private Integer age;
//玩具球球具有颜色属性
private List<Ball> balls;

我们需要明确给出，哪个类的注解需要被激活：

[java] view plaincopy

public static void main(String[] args) throws Exception{
//初始化cat
List<Ball> balls = new ArrayList<Ball>();
balls.add(new Ball("red"));
Cat cat = new Cat("馄饨",1,balls);
//初始化结束
//为了方便查找将文件制定到D盘cat.xml中
FileOutputStream fout = new FileOutputStream("D:/cat.xml");
XStream xs = new XStream();
//xs.alias("cat", Cat.class); //等同于 @XStreamAlias("cat")
xs.processAnnotations(Cat.class);//将Cat.class类上的注解将会使用
xs.toXML(cat,fout);
}

当我们在Cat类名使用该注解时，表明该类序列化为xml时，类名com.timejob.node.Cat将替换成cat输出，这样使得xml更清晰简短：

[java] view plaincopy

<cat>
<name>馄饨</name>
<age>1</age>
<balls>
<com.timejob.node.Ball>
<color>red</color>
</com.timejob.node.Ball>
</balls>
</cat>

2. XStreamAsAttribute 作用是将类内成员作为父节点属性输出，等同于xstream.useAttributeFor(Cat.class, "name")

[java] view plaincopy

@XStreamAlias("cat")
public class Cat {
//名字
@XStreamAsAttribute // here 将name作为Cat属性输出在父节点
private String name;
//大小
private Integer age;
//玩具球球具有颜色属性
private List<Ball> balls;

其他代码保持不变，输出后cat.xml如下：

[java] view plaincopy

<cat name="馄饨">
<age>1</age>
<balls>
<com.timejob.node.Ball>
<color>red</color>
</com.timejob.node.Ball>
</balls>
</cat>

我们看到name属性已经作为 cat的属性输出在根节点上

3. @XStreamAlias 作用就是将属性按照别名输出，等同于xstream.aliasField("catAge", Cat.class, "age");

[java] view plaincopy

@XStreamAlias("cat")
public class Cat {
//名字
@XStreamAsAttribute
private String name;
//大小
@XStreamAlias("catAge") //here
private Integer age;
//玩具球球具有颜色属性
private List<Ball> balls;

得到cat.xml文件如下：

[java] view plaincopy

<cat name="馄饨">
<catAge>1</catAge>
<balls>
<com.timejob.node.Ball>
<color>red</color>
</com.timejob.node.Ball>
</balls>
</cat>

4.对于集合常用的注解 @XStreamImplicit 去除<Balls></Balls>显示，只显示之间的<Ball></Ball>节点元素

[java] view plaincopy

@XStreamAlias("cat")
public class Cat {
//名字
@XStreamAsAttribute
private String name;
//大小
@XStreamAlias("catAge")
private Integer age;
//玩具球球具有颜色属性
@XStreamImplicit //here
private List<Ball> balls;

此时输出如下：

[java] view plaincopy

<cat name="馄饨">
<catAge>1</catAge>
<com.timejob.node.Ball>
<color>red</color>
</com.timejob.node.Ball>
</cat>

这样看起来就更加简洁了。

4.还有几个注解，都是比较好理解的，如@XStreamOmitField 表明该属性不会被序列化到xml中。

[java] view plaincopy

@XStreamAlias("cat")
public class Cat {
//名字
@XStreamAsAttribute
private String name;
//大小
@XStreamAlias("catAge")
private Integer age;
//玩具球球具有颜色属性
@XStreamImplicit
private List<Ball> balls;
@XStreamOmitField //here
private String noCare;

常用的就这么几个，其他的再讨论和学习吧。

转载于:https://www.cnblogs.com/Syria/p/6422280.html

xstream中几个注解的含义和用法(转）相关推荐

C和C++中argc和argv的含义以及用法
C和C++中argc和argv的含义以及用法各位小伙伴在接触C和C++的时候,总会看到这样的东西很多伙伴应该都一直注意到了这两个参数,但是很多伙伴编写多年C和C++代码,还没有使用过这两个参数.a ...
2.aop中几个注解的含义
参考地址:http://elim.iteye.com/blog/2395255 转载于:https://www.cnblogs.com/jiangjing/p/8953583.html
（转）C++ main函数中参数argc和argv含义及用法
原博地址:https://blog.csdn.net/dcrmg/article/details/51987413 argc 是 argument count的缩写,表示传入main函数的参数个数: ...
python中 [：：-1]的含义和用法
例子如上图所示.简单来说,a[::-1]就是将序列a中的元素翻转.
【IOS开发】SwiftUI中的反斜杠\含义以及用法
1.@Environment(\.colorScheme)中的\是什么意思? 在 SwiftUI 中,使用 \(反斜杠)可以访问环境中的键路径(key path),这样你就可以获取环境变量的值.键路径 ...
C++ main函数中参数argc和argv含义及用法（ argument count和 argument vector）
rgc 是 argument count的缩写,表示传入main函数的参数个数: argv 是 argument vector的缩写(注意:不是argument value的缩写,自己以前理解错了), ...
HTML中的script标签的含义和用法
<script> 标签通常放置在一个 HTML 网页的头部标签 <head> 标签内,用于链接外部 JavaScript 文件的外部资源标签.
UML类图中各种箭头和线条的含义和用法（转）
UML类图中箭头和线条的含义和用法 1.UML中关系本节向大家学习一下UML箭头.线条代表的意义,UML中关系主要有依赖,聚合,合成,泛化和实现等,下面就让我们来看一下这些关系如何用UML箭头和线条 ...
Spring 中的各种注解，光会用可不够哦！
来源:https://digdeep.cnblogs.com/digdeep/p/4525567.html 1. Java中的注解 2. 使用元注解来自定义注解和处理自定义注解 3. spri ...

xstream中几个注解的含义和用法(转）

xstream中几个注解的含义和用法(转）相关推荐

最新文章

热门文章