XStream中设置编码、忽略没有关联属性和支持CDATA

最新推荐文章于 2022-07-11 21:02:44 发布

原创最新推荐文章于 2022-07-11 21:02:44 发布 · 3.1k 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#XStream

其它专栏收录该内容

16 篇文章

订阅专栏

本文介绍XStream的高级用法，包括设置编码、忽略无关属性、使用常见注解、支持CDATA块及安全警告处理。通过实例展示了如何避免转换错误、增强数据安全性并优化XML与对象间的转换。

一、设置编码

XStream中可以设置转换后的编码格式；

XStream xStream = new XStream(new DomDriver("GBK"));

二、忽略没有关联的属性

“no such field”类似于这样的错误。
问题分析
我们在使用XStream对象时，一般都会直接new一个对象出来，例如

XStream xstream = new XStream();
1
这样使用之后，xml中的所有属性都需要被待转化的模型识别，假如有一个字段没有对应上，即会抛出错误。
问题解决方案
XStream 官方也提供这样一种构造方法。

XStream xstream = new XStream() {
    @Override
    protected MapperWrapper wrapMapper(MapperWrapper next) {
        return new MapperWrapper(next) {
            @Override
            public boolean shouldSerializeMember(Class definedIn, String fieldName) {
                if (definedIn == Object.class) {
                    return false;
                }
                return super.shouldSerializeMember(definedIn, fieldName);
            }
        };
    }
};
xstream.processAnnotations(XXX.class);

三、常用的注解

1）注解 @XStreamAlias(“ProdCount”) 可以为普通的字段进行别名设置
2）注解 @XStreamImplicit(itemFieldName=“Product”) 可以对list集合进行别名设置
3）注解 @XStreamConverter(value = XmlDateConverter.class) 日期转化器
4）注解 @XStreamOmitField 忽略某个字段

四、xml转换为对象时，使其支持CDATA块

/**
 * 对象到xml的处理
 * 扩展xstream，使其支持CDATA块
 */
	private XStream xstream = new XStream(new XppDriver() {
	    public HierarchicalStreamWriter createWriter(Writer out) {
	            return new PrettyPrintWriter(out) {
	                // 对所有xml节点的转换都增加CDATA标记
	                boolean cdata = true;
	 
	                @SuppressWarnings("rawtypes")
	                public void startNode(String name, Class clazz) {
	                    super.startNode(name, clazz);
	                }
	 
	                protected void writeText(QuickWriter writer, String text) {
	                    if (cdata) {
	                        writer.write("<![CDATA[");
	                        writer.write(text);
	                        writer.write("]]>");
	                    } else {
	                        writer.write(text);
	                    }
	                }
	            };
	        }
	    });

五、xstream出现安全警告
在debug运行的时候，发现一个警告：Security framework of XStream not initialized, XStream is probably vulnerable

意思是：xstream 的安全框架没有初始化，xstream 容易受攻击。

解决方法：xStream对象设置默认安全防护，同时设置允许的类

XStream xStream = newXStream();
XStream.setupDefaultSecurity(xStream);
xStream.allowTypes(new Class[]{Test.class, Test1.class});