当前位置：首页 > news >正文

Xstream使用教程

news 2025/7/4 18:27:37

1.Xstream介绍

官网：https://x-stream.github.io/tutorial.html

介绍：XStream 对象序列化和反序列化为 XML的一个JAVA类库。JDK 1.4以上适用。

PS:与JAXB相比，Xstream更好用一些，像XStreamImplicit这种注解，我在JAXB没找到

2.Xstream注解使用说明

@XStreamAlias(“message”) 别名注解
作用目标: 类,字段

@XStreamImplicit 隐式集合

@XStreamImplicit(itemFieldName=“part”)
作用目标: 集合字段

@XStreamConverter(SingleValueCalendarConverter.class) 注入转换器
作用目标: 对象

@XStreamAsAttribute 转换成属性
作用目标: 字段

@XStreamOmitField 忽略字段
作用目标: 字段

使用注解时需要开启:
xstream.autodetectAnnotations(true);

3.使用教程

<!--xml报文组装、解析；最新版本1.4.20已修复反序列化漏洞-->
<dependency><groupId>com.thoughtworks.xstream</groupId><artifactId>xstream</artifactId><version>1.4.20</version>
</dependency>
<dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId>
</dependency>

@AllArgsConstructor
@XStreamAlias("Class")
@Data
public class Class {@XStreamAlias("NUM")private int num;@XStreamImplicitprivate List<Student> StudentList;}

@AllArgsConstructor
@XStreamAlias("Student")
@Data
public class Student {@XStreamAlias("Name")private String name;@XStreamAlias("Age")private String age;}

@Slf4j
public class xmlUtils {public static String objToXML(Object xmlData)  {String postDataXML;try {//指定解析编码为UTF-8，并解决XStream对出现双下划线的bugXStream xStreamForReqData = new XStream(new DomDriver("UTF-8", newXmlFriendlyNameCoder("-_", "_")));//开启当前将被序列化为XML的类的注解xStreamForReqData.processAnnotations(xmlData.getClass());//将要提交给API的数据对象转换成XML格式数据Post给APIString postDataXMLOld = xStreamForReqData.toXML(xmlData);postDataXML = postDataXMLOld.replace("&quot;", "\"");//为Bean转换后的XML加上头信息//postDataXML = XML_TAG + postDataXML;} catch (Exception e) {log.error("Object converts into XML go wrong", e);throw e;}return postDataXML;}public static void main(String[] args) {List<Student> studentList = new ArrayList<>();studentList.add(new Student("小虎", "18"));studentList.add(new Student("小华", "18"));studentList.add(new Student("小李", "19"));Class aClass = new Class(studentList.size(),studentList);System.out.println(objToXML(aClass));}
}

最后的结果：

<Class><NUM>3</NUM><Student><Name>小虎</Name><Age>18</Age></Student><Student><Name>小华</Name><Age>18</Age></Student><Student><Name>小李</Name><Age>19</Age></Student>
</Class>