让XStream使用CDATA标签处理特殊字符进行xml转换

JAVA herman 3319浏览 0评论
公告:“业余草”微信公众号提供免费CSDN下载服务(只下Java资源),关注业余草微信公众号,添加作者微信:xttblog,发送下载链接帮助你免费下载!
本博客日IP超过1800,PV 2600 左右,急需赞助商。
极客时间所有课程通过我的二维码购买后返现24元微信红包,请加博主新的微信号:xttblog,之前的微信号好友位已满,备注:返现
所有面试题(java、前端、数据库、springboot等)一网打尽,请关注文末小程序
视频教程免费领

写过微信公众号开发的人都知道,在解析含有特殊字符的xml报文时用到了CDATA标签。而随着XStream的流行起来,越来越多的人选择了这样的快速转换成对象的解析方式。然而XStream本身是并不支持CDATA标签的,那么如同让XStream也支持CDATA标签呢?

用XStream来实现java Object和XML的相互转换是最理想不过的,我们不需要过多的关注xml的拼接和解析,只需要少量的代码就能实现高效的转换。由于生成的XML需要用到特殊的字符,比如我们发生消息中包含特殊字符,以及一些特殊的表情等,转换和解析这些带有特殊字符xml时,我们希望使用CDATA标签来解决一切问题,于是对XPPDriver做了一点扩展,用于支持自定义的注解。

首先,我们需要创建自定义的标签类XStreamCDATA,用于标记需要加入CDATA标签的field(属性),代码如下:

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
public @interface XStreamCDATA {

}

接着我们需要改写XPPDriver,通过Java反射的方式去查找打上XStreamCDATA标签的field,同时需要注意这个field是否也打上了XStreamAlias标签,需要对这种情况做处理,代码如下:

public static XStream createXstream() {
    return new XStream(new XppDriver() {
        @Override
        public HierarchicalStreamWriter createWriter(Writer out) {
            return new PrettyPrintWriter(out) {
              boolean cdata = false;
              Class<?> targetClass = null;
              @Override
              public void startNode(String name,
                  @SuppressWarnings("rawtypes") Class clazz) {
                super.startNode(name, clazz);
                //业务处理,对于用XStreamCDATA标记的Field,需要加上CDATA标签
                if(!name.equals("xml")){
                  cdata = needCDATA(targetClass, name);
                }else{
                  targetClass = clazz;
                }
              }

              @Override
              protected void writeText(QuickWriter writer, String text) {
                if (cdata) {
                  writer.write(cDATA(text));
                } else {
                  writer.write(text);
                }
              }
            };
        }
    });
}
// 业余草:www.xttblog.com
private static boolean needCDATA(Class<?> targetClass, String fieldAlias){
    boolean cdata = false;
    //首先,判断自己的属性是否存在XStreamCDATA标签
    cdata = existsCDATA(targetClass, fieldAlias);
    if(cdata) 
        return cdata;
    //如果cdata为false, 则遍历所有的父类直到java.lang.Object
    Class<?> superClass = targetClass.getSuperclass();
    while(!superClass.equals(Object.class)){
        cdata = existsCDATA(superClass, fieldAlias);
        if(cdata) 
            return cdata;
        superClass = superClass.getClass().getSuperclass();
    }
    return false;
}
// 业余草:www.xttblog.com
private static boolean existsCDATA(Class<?> clazz, String fieldAlias){
    //反射获取所有属性
    Field[] fields = clazz.getDeclaredFields();
    for (Field field : fields) {
      //1.存在标有XStreamCDATA标签的field
        if(field.getAnnotation(XStreamCDATA.class) != null ){
            XStreamAlias xStreamAlias = field.getAnnotation(XStreamAlias.class);
            //2.存在XStreamAlias属性
            if(null != xStreamAlias){
                if(fieldAlias.equals(xStreamAlias.value()))
                    return true;
            }else{//不存在XStreamAlias
                if(fieldAlias.equals(field.getName()))
                return true;
            }
        }
    }
    return false;
}

一切准备工作都做好了,那么我们再做消息管理时,就可以通过@XStreamCDATA标签对属性进行注解,在Java Bean在转成XML的时候, ToUserName, FromUserName, MsgType这3个field会打上CDATA标签。

/**业余草:www.xttblog.com*/
@XStreamAlias("ToUserName")
@XStreamCDATA··
protected String toUserName;
/**业余草:www.xttblog.com*/
@XStreamAlias("FromUserName")
@XStreamCDATA
protected String fromUserName;
/**业余草:www.xttblog.com*/
@XStreamAlias("CreateTime")
protected long createTime;
/**业余草:www.xttblog.com*/
@XStreamAlias("MsgType")
@XStreamCDATA
protected String msgType;

版权声明:本文为博主原创文章,未经博主允许不得转载。

业余草公众号

最后,欢迎关注我的个人微信公众号:业余草(yyucao)!可加QQ1群:135430763(2000人群已满),QQ2群:454796847(已满),QQ3群:187424846(已满)。QQ群进群密码:xttblog,想加微信群的朋友,之前的微信号好友已满,请加博主新的微信号:xttblog,备注:“xttblog”,添加博主微信拉你进群。备注错误不会同意好友申请。再次感谢您的关注!后续有精彩内容会第一时间发给您!原创文章投稿请发送至532009913@qq.com邮箱。商务合作可添加助理微信进行沟通!

本文原文出处:业余草: » 让XStream使用CDATA标签处理特殊字符进行xml转换