看看XStream注解

最新推荐文章于 2025-04-23 13:15:40 发布
转载 最新推荐文章于 2025-04-23 13:15:40 发布 · 136 阅读 · 0 ·
CC 4.0 BY-SA版权
原文链接：https://yq.aliyun.com/articles/412643
文章标签：

#java

前文展示了使用别名更改XML展示内容，在这一节，可以使用注解更简单的更改XML展示。


（1）最简单的注解示例


1. 输出响应消息

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
package com.favccxx.favsoft.pojo;
public class ResponseMessage {
    private int messageType;
    private String messageContent;
    public ResponseMessage(int messageType, String messageContent){
        this.messageType = messageType;
        this.messageContent = messageContent;
    }
    public int getMessageType() {
        return messageType;
    }
    public void setMessageType(int messageType) {
        this.messageType = messageType;
    }
    public String getMessageContent() {
        return messageContent;
    }
    public void setMessageContent(String messageContent) {
        this.messageContent = messageContent;
    }
}


2. 开始测试

1
2
3
4
5
6
7
8
9
10
package com.favccxx.favsoft.main;
import com.favccxx.favsoft.pojo.ResponseMessage;
import com.thoughtworks.xstream.XStream;
public class MainAnnotations {
    public static void main(String[] args) {
        XStream stream = new XStream();
        ResponseMessage msg = new ResponseMessage(200, "成功");
        System.out.println(stream.toXML(msg));
    }
}


3. 测试结果

1
2
3
4
<com.favccxx.favsoft.pojo.ResponseMessage>
  <messageType>200</messageType>
  <messageContent>成功</messageContent>
</com.favccxx.favsoft.pojo.ResponseMessage>


4. 使用注解后的输出内容

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
package com.favccxx.favsoft.pojo;
import com.thoughtworks.xstream.annotations.XStreamAlias;
@XStreamAlias("message")
public class ResponseMessage {
    @XStreamAlias("type")
    private int messageType;
    @XStreamAlias("content")
    private String messageContent;
    public ResponseMessage(int messageType, String messageContent){
        this.messageType = messageType;
        this.messageContent = messageContent;
    }
    public int getMessageType() {
        return messageType;
    }
    public void setMessageType(int messageType) {
        this.messageType = messageType;
    }
    public String getMessageContent() {
        return messageContent;
    }
    public void setMessageContent(String messageContent) {
        this.messageContent = messageContent;
    }
}


1
xstream.processAnnotations(ResponseMessage.class);


1
2
3
4
<message>
  <type>200</type>
  <content>成功</content>
</message>


（2）使用集合注解


2.1 响应消息对象

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
package com.favccxx.favsoft.pojo;
import java.util.Arrays;
import java.util.List;
import com.thoughtworks.xstream.annotations.XStreamAlias;
@XStreamAlias("message")
public class ResponseMessage {
    @XStreamAlias("type")
    private int messageType;
    @XStreamAlias("content")
    private List<String> messageContent;
    public ResponseMessage(int messageType, String ... messageContent){
        this.messageType = messageType;
        this.messageContent = Arrays.asList(messageContent);
    }
    public int getMessageType() {
        return messageType;
    }
    public void setMessageType(int messageType) {
        this.messageType = messageType;
    }
    public List<String> getMessageContent() {
        return messageContent;
    }
    public void setMessageContent(List<String> messageContent) {
        this.messageContent = messageContent;
    }
}


2.2 开始测试

1
2
3
4
5
6
7
8
9
10
11
package com.favccxx.favsoft.main;
import com.favccxx.favsoft.pojo.ResponseMessage;
import com.thoughtworks.xstream.XStream;
public class MainAnnotations {
    public static void main(String[] args) {
        XStream xstream = new XStream();
        xstream.processAnnotations(ResponseMessage.class);
        ResponseMessage msg = new ResponseMessage(28, "终于爬上来了！","我忘带钥匙了！！！");
        System.out.println(xstream.toXML(msg));
    }
}


2.3 输出结果

1
2
3
4
5
6
7
8
9
<message>
  <type>28</type>
  <content class="java.util.Arrays$ArrayList">
    <a class="string-array">
      <string>终于爬上来了！</string>
      <string>我忘带钥匙了！！！</string>
    </a>
  </content>
</message>


2.4使用@XStreamImplicit注解将集合标记为隐式集合

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
package com.favccxx.favsoft.pojo;
import java.util.Arrays;
import java.util.List;
import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.annotations.XStreamImplicit;
@XStreamAlias("message")
public class ResponseMessage {
    @XStreamAlias("type")
    private int messageType;
    @XStreamImplicit
    private List<String> messageContent;
    public ResponseMessage(int messageType, String... messageContent) {
        this.messageType = messageType;
        this.messageContent = Arrays.asList(messageContent);
    }
    public int getMessageType() {
        return messageType;
    }
    public void setMessageType(int messageType) {
        this.messageType = messageType;
    }
    public List<String> getMessageContent() {
        return messageContent;
    }
    public void setMessageContent(List<String> messageContent) {
        this.messageContent = messageContent;
    }
}


2.5 输出结果

1
2
3
4
5
<message>
  <type>28</type>
  <string>终于爬上来了！</string>
  <string>我忘带钥匙了！！！</string>
</message>


2.6 在原有注解对象上，对字段进行别名

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
package com.favccxx.favsoft.pojo;
import java.util.Arrays;
import java.util.List;
import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.annotations.XStreamImplicit;
@XStreamAlias("message")
public class ResponseMessage {
    @XStreamAlias("type")
    private int messageType;
    @XStreamImplicit(itemFieldName="dialog")
    private List<String> messageContent;
    public ResponseMessage(int messageType, String... messageContent) {
        this.messageType = messageType;
        this.messageContent = Arrays.asList(messageContent);
    }
    public int getMessageType() {
        return messageType;
    }
    public void setMessageType(int messageType) {
        this.messageType = messageType;
    }
    public List<String> getMessageContent() {
        return messageContent;
    }
    public void setMessageContent(List<String> messageContent) {
        this.messageContent = messageContent;
    }
}


2.7 输出内容如下

1
2
3
4
5
<message>
  <type>28</type>
  <dialog>终于爬上来了！</dialog>
  <dialog>我忘带钥匙了！！！</dialog>
</message>


（3）属性别名


3.1响应消息

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
package com.favccxx.favsoft.pojo;
import java.util.Arrays;
import java.util.List;
import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.annotations.XStreamAsAttribute;
import com.thoughtworks.xstream.annotations.XStreamConverter;
import com.thoughtworks.xstream.annotations.XStreamImplicit;
import com.thoughtworks.xstream.converters.basic.BooleanConverter;
@XStreamAlias("message")
public class ResponseMessage {
    @XStreamAlias("type")
    @XStreamAsAttribute
    private int messageType;
    @XStreamImplicit(itemFieldName = "dialog")
    private List<String> messageContent;
    @XStreamAsAttribute
    @XStreamConverter(value = BooleanConverter.class, booleans = { false }, strings = { "yes", "no" })
    private boolean important;
    public ResponseMessage(int messageType, boolean important, String... messageContent) {
        this.messageType = messageType;
        this.messageContent = Arrays.asList(messageContent);
        this.important = important;
    }
    public int getMessageType() {
        return messageType;
    }
    public void setMessageType(int messageType) {
        this.messageType = messageType;
    }
    public List<String> getMessageContent() {
        return messageContent;
    }
    public void setMessageContent(List<String> messageContent) {
        this.messageContent = messageContent;
    }
}


3.2输出内容

1
2
3
4
<message type="28" important="yes">
  <dialog>终于爬上来了！</dialog>
  <dialog>我忘带钥匙了！！！</dialog>
</message>


（4）所有字段变为文本，值得注意的是，转换为文本的内容，只能是String类型的，因为转换器是StringValueConvertor。


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
package com.favccxx.favsoft.pojo;
import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.annotations.XStreamConverter;
import com.thoughtworks.xstream.converters.basic.BooleanConverter;
import com.thoughtworks.xstream.converters.extended.ToAttributedValueConverter;
@XStreamAlias("message")
@XStreamConverter(value = ToAttributedValueConverter.class, strings = { "messageContent" })
public class ResponseMessage {
    @XStreamAlias("type")
    private int messageType;
    @XStreamAlias("content")
    private String messageContent;
    @XStreamConverter(value = BooleanConverter.class, booleans = { false }, strings = { "yes", "no" })
    private boolean important;
    public ResponseMessage(int messageType, boolean important, String messageContent) {
        this.messageType = messageType;
        this.messageContent = messageContent;
        this.important = important;
    }
    public int getMessageType() {
        return messageType;
    }
    public void setMessageType(int messageType) {
        this.messageType = messageType;
    }
    public String getMessageContent() {
        return messageContent;
    }
    public void setMessageContent(String messageContent) {
        this.messageContent = messageContent;
    }
    public boolean isImportant() {
        return important;
    }
    public void setImportant(boolean important) {
        this.important = important;
    }
}


1
<message type="200" important="yes">今天星期五</message>


（5）省略字段

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
package com.favccxx.favsoft.pojo;
import java.util.Arrays;
import java.util.List;
import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.annotations.XStreamConverter;
import com.thoughtworks.xstream.annotations.XStreamImplicit;
import com.thoughtworks.xstream.annotations.XStreamOmitField;
import com.thoughtworks.xstream.converters.basic.BooleanConverter;
@XStreamAlias("message")
public class ResponseMessage {
    @XStreamOmitField
    private int messageType;
    @XStreamImplicit(itemFieldName="content")
    private List<String> messageContent;
    @XStreamConverter(value = BooleanConverter.class, booleans = { false }, strings = { "yes", "no" })
    private boolean important;
    public ResponseMessage(int messageType, boolean important, String... messageContent) {
        this.messageType = messageType;
        this.important = important;
        this.messageContent = Arrays.asList(messageContent);
    }
    public int getMessageType() {
        return messageType;
    }
    public void setMessageType(int messageType) {
        this.messageType = messageType;
    }
    public List<String> getMessageContent() {
        return messageContent;
    }
    public void setMessageContent(List<String> messageContent) {
        this.messageContent = messageContent;
    }
    public boolean isImportant() {
        return important;
    }
    public void setImportant(boolean important) {
        this.important = important;
    }
}
1
2
3
4
5
<message>
  <content>今天星期五</content>
  <content>明天去逛街</content>
  <important>yes</important>
</message>


（6）自动检测注解

可以使用下述方法自动检测注解，而不用每次都为每个类设置注解

1
2
xstream.autodetectAnnotations(true);
// xstream.processAnnotations(ResponseMessage.class);


总结：使用注解比别名方便易用，但是当一个类被多次重用时，使用别名会更明智些。





本文转自 genuinecx 51CTO博客，原文链接：http://blog.51cto.com/favccxx/1893995，如需转载请自行联系原作者
java 利用Xstream注解生成和解析xml
vampire2777的博客
04-28 2380
1.Xstream简介； 使用限制: JDK版本不能<1.5. 虽然预处理注解是安全的,但自动侦查注解可能发生竞争条件. 特点: 简化的API; 无映射文件; 高性能,低内存占用; 整洁的XML; 不需要修改对象;支持内部私有字段,不需要setter/getter方法,final字段;非公有类,内部类;类不需要默认构造器,完全对象图支持.维护对象引用计数,循环引用. i
使用XStream处理Xml文档和实体类之间的转换的几种方式
crazyzhr32的博客
12-10 2252
首先说一下背景（觉得没用可以直接跳过看代码），最近在和其他系统做对接的时候用到了xml作为传输格式的内容，涉及到了xml和实体类的互相转换，然后也上网查了一下，一开始尝试了dom4j不过发现有些繁琐，后来继续查资料，找到了XStream，发现这个还是很好用的，作为总结也把使用方法写一下，供大家参考吧，不足之处望指出！ 1.项目结构（PersonList.java没卵用的，忽略之）
Xstream之常用方式与常用注解
weixin_30952103的博客
02-04 401
示例代码 Java代码 BlogteamBlog=newBlog(newAuthor("GuilhermeSilveira")); teamBlog.add(newEntry("first","Myfirstblogentry.")); eamBlog.add(newEntry("tutorial","Todaywehavede...
Xstream注解
天天的专栏
03-20 6465
Xstream注解常用知识：  @XStreamAlias("message") 别名注解   作用目标: 类,字段   @XStreamImplicit 隐式集合   @XStreamImplicit(itemFieldName="part")   作用目标: 集合字段   @XStreamConverter(SingleValueCalendarConverter.class) 注
XStream 注解
千里之行始于足下
05-27 1689
– Start package shangbo.xstream.example5; import java.util.ArrayList; import java.util.List; import com.thoughtworks.xstream.XStream; public class App { public static void main(String[] args...
xstream.zip
05-30
首先，我们来看XStream的基本用法。在Java项目中引入xstream-0.1.jar文件后，可以按照以下步骤进行操作： 1. 引入XStream实例： ```java import com.thoughtworks.xstream.XStream; XStream xstream = new XStream...
好用的xStream XML和JAVA对象互相转换的简单示例
09-04
接下来，我们来看看如何使用XStream进行XML和Java对象的转换。首先，我们需要一个简单的Java对象，例如： ```java public class Person { private String name; private int age; private Address address; //...
XStream：Java对象XML序列化工具
从文件的描述来看，"XStream_jar.zip"是一个压缩包文件，它包含了XStream库的jar文件。当需要在项目中使用XStream时，通常需要将这个jar文件添加到项目的类路径中，以便Java程序能够加载和使用XStream。 在实际的...
深入理解XStream 1.3 API官方手册指南
首先，从标题来看，文档名为“XStream 1.3 API 手册”，这暗示了文档将详细讲述该库的API使用方法。API是Application Programming Interface（应用程序编程接口）的缩写，是一组定义、协议和工具的集合，它能够帮助...
解决XStream注解同名冲突
05-13
多个类注解@XStreamAlias,value相同、且在集合上使用了@XStreamImplicit会出现异常： com.thoughtworks.xstream.converters.ConversionException: No field 'null' found in class '.....(注解的类路径)' ---- Debugging information ---- message : No field 'null' found in class '.....' cause-exception : com.thoughtworks.xstream.converters.reflection.MissingFieldException cause-message : No field 'null' found in class '......' class : ...... required-type : ...... converter-type : com.thoughtworks.xstream.converters.reflection.ReflectionConverter path : /.../... line number : 1 version : 1.4.7 ------------------------------- 该包解决了这个bug
XStream分析（2）
kris的杀手之路
11-08 2554
XStream   使用XStream的初衷   研究和使用XStream的原因是我在项目中的一个预研。在项目中需要应用到对XML文件的管理和配置，因此需要一个能够将对象保存为XML的工具库，在这里有多种方法实现，我也研究并进行了比对，比如与Zeus工具的比对，与Java自身的XML工具库的比对等。在这里，我就描述下我的XStream学习过程和研究结果。   XStream简单介绍
Xstream使用及注解
weixin_43861630的博客
04-11 1214
Xstream toxml
XStream注解开启（注解扫描）方式
H_233的博客
12-10 3116
 先附上XStream官方文档和API地址： 官方文档：http://x-stream.github.io/annotations-tutorial.html API文档：http://x-stream.github.io/javadoc/  这种通过使用XStream的注解，来完成相关配置开发，必须要开启注解以保证注解生效，否则注解无效，默认注解是不生效的。 如下图，未开启注解序列化的...
XStream注解使用简介
热门推荐
.... 永远年轻，永远热泪盈眶
03-20 5万+
Xstream简介 Xstream是一种OXMapping 技术，是用来处理XML文件序列化的框架,在将JavaBean序列化，或将XML文件反序列化的时候，不需要其它辅助类和映射文件，使得XML序列化不再繁索。Xstream也可以将JavaBean序列化成Json或反序列化，使用非常方便。本文章主要介绍Xstream相关注解的使用。 XStream注解使用 假设要生成如下 xml报文： <...
深入理解XStream解析与应用
最新发布
weixin_28999139的博客
04-23 906
XStream 是一个简单易用的Java库，用于将Java对象转换成XML格式的字符串，或者反过来将XML字符串转换成Java对象。它不依赖Java的序列化API，因此允许开发者在无需实现Serializable接口的情况下进行对象的序列化操作。XStream特别适合于那些需要与XML格式数据交互的应用程序，同时它还支持XML到JSON的转换。在本章中，我们将探究XStream的以下核心特性：轻量级：XStream设计简洁，易于集成和扩展。无依赖性。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值