解决@ResponseBody作用在返回类型为String的方法时的坑

 更新时间:2023年06月17日 15:46:16   作者:BryantLmm  
这篇文章主要介绍了解决@ResponseBody作用在返回类型为String的方法时的坑,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

@ResponseBody作用在返回类型为String的方法时的坑

在默认的Spring配置中,当在返回类型为String的Controller方法时,在其上加上@ResponseBody时会出现问题,那就是返回的不再是我们期待的Json格式的字符串了,而是会变成在正常的Json串前后加上双引号。

这是为什么呢?这是因为在HTTPMessageConverter中对应写json格式相应的处理类在写json的时候默认是对String类型进行这样处理的。

以Gson为例

在SpringBoot中,有相应的Configuartion来配置用户来解析Json格式的HttpMessageConverter,经过DEBUG发现,在HttpMessageConverter列表中第一个符合处理json返回格式的是GsonHttpMessageConverter,他是在GsonHttpMessageConvertersConfiguration类中被注入的。

他对json的处理是

    @Override
    protected void writeInternal(Object o, Type type, HttpOutputMessage outputMessage)
            throws IOException, HttpMessageNotWritableException {
        Charset charset = getCharset(outputMessage.getHeaders());
        OutputStreamWriter writer = new OutputStreamWriter(outputMessage.getBody(), charset);
        try {
            if (this.jsonPrefix != null) {
                writer.append(this.jsonPrefix);
            }
            if (type != null) {
                this.gson.toJson(o, type, writer);
            }
            else {
                this.gson.toJson(o, writer);
            }
            writer.close();
        }
        catch (JsonIOException ex) {
            throw new HttpMessageNotWritableException("Could not write JSON: " + ex.getMessage(), ex);
        }
    }

因为Gson默认对String类型的对象转化为json就是会加上双引号的,所以导致了String类型的返回不再是json串了。

如果想要String类型也转为正常的json格式的话,只要重写GsonHttpMessageConverter即可。

    @Override
    protected void writeInternal(Object o, Type type, HttpOutputMessage outputMessage)
            throws IOException, HttpMessageNotWritableException {
        Charset charset = getCharset(outputMessage.getHeaders());
        OutputStreamWriter writer = new OutputStreamWriter(outputMessage.getBody(), charset);
        try {
            if (this.jsonPrefix != null) {
                writer.append(this.jsonPrefix);
            }
            if (type != null) {
                //对于String类型的,直接拼接,不转json
            if("java.lang.String".equals(type.getTypeName())){
                writer.append(value.toString());
            }else{
                this.gson.toJson(o, type, writer);
                }
                }
            }
            else {
                this.gson.toJson(o, writer);
            }
            writer.close();
        }
        catch (JsonIOException ex) {
            throw new HttpMessageNotWritableException("Could not write JSON: " + ex.getMessage(), ex);
        }
    }

对于FastJson,在测试的时候发现,对于低版本的FastJson,会存在一个问题,就是当Java对象并没有默认的构造器的时候,是会报错的,需要使用新版本的FastJson才会去寻找合适的构造器去实例化对象。

至于哪个版本才可以称为新版本,没有仔细研究,我使用的1.2.47版本已经修复这个问题。

Fastjson还是有很多坑的,之前有研究过他之前的一个远程漏洞,这个后续会写一篇文章,个人并不建议使用Fastjson,推荐Gson。

对了,如果你使用的是fastjson提供的HTTPMessageConverter,是一样会对String格式做加引号处理的,具体可以看相应源码。

心得

所以为了@ResponseBody能良好的实现返回json格式的功能,要不我们就不要返回String对象,要么就需要重写相应将返回对象处理为Json的HTTPMessageConverter,特殊化他对String类型的处理。

response.body().string()的坑坑坑!!!

一不小心 浪费了2个小时 

response.body().string()

这个东西明明就看到过是string string为啥还是写成了toString()...

写成了response.body().toString()后打印出来的就是okhttp3.internal.http.RealResponseBody@815f248这样的数据!!!

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Java实现WORD和PDF互相转换以及数据填充示例

    Java实现WORD和PDF互相转换以及数据填充示例

    本文介绍了如何使用Java实现WORD和PDF的互转以及数据填充功能,通过导入Aspose库并使用其工具类,可以轻松实现WORD和PDF模板的填充和转换,需要的朋友可以参考下
    2025-02-02
  • XML操作类库XStream使用详解

    XML操作类库XStream使用详解

    这篇文章主要给大家介绍了关于XML操作类库XStream使用的相关资料,需要的朋友可以参考下
    2023-11-11
  • Java不可变类机制浅析

    Java不可变类机制浅析

    所谓的不可变类是指这个类的实例一旦创建完成后,就不能改变其成员变量值。如JDK内部自带的很多不可变类:Interger、Long和String等。接下来通过本文给大家介绍Java不可变类机制,需要的朋友参考下
    2017-02-02
  • SpringBoot利用自定义注解实现多数据源

    SpringBoot利用自定义注解实现多数据源

    这篇文章主要为大家详细介绍了SpringBoot如何利用自定义注解实现多数据源效果,文中的示例代码讲解详细,具有一定的借鉴价值,需要的可以了解一下
    2022-10-10
  • java版微信公众平台消息接口应用示例

    java版微信公众平台消息接口应用示例

    这篇文章主要介绍了java版微信公众平台消息接口应用,结合实例形式对比分析了PHP与java应用微信公众平台接口的相关调用与操作技巧,需要的朋友可以参考下
    2017-07-07
  • java中如何调用js

    java中如何调用js

    Nashorn是Java8中引入的一个新的JavaScript引擎,它允许在JVM上运行JavaScript代码,并且可以与Java代码相互调用,Nashorn遵循JSR233规范,是一个纯Java实现的JavaScript引擎,可以与Java程序无缝集成,提供动态脚本执行和灵活性
    2025-01-01
  • 使用Java设置字型和颜色的方法详解

    使用Java设置字型和颜色的方法详解

    这篇文章主要介绍了使用Java设置字型和颜色的方法,在Java的绘图等图形化编程中较常用到,需要的朋友可以参考下
    2015-10-10
  • java获取手机已安装APK的签名摘要

    java获取手机已安装APK的签名摘要

    这篇文章主要介绍了java获取手机已安装APK的签名摘要的相关资料,需要的朋友可以参考下
    2016-02-02
  • 使用springboot在工具类中读取配置文件(ClassPathResource)

    使用springboot在工具类中读取配置文件(ClassPathResource)

    这篇文章主要介绍了使用springboot在工具类中读取配置文件(ClassPathResource),具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • Java yield()线程让步实现过程解析

    Java yield()线程让步实现过程解析

    这篇文章主要介绍了Java yield()线程让步实现过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-03-03

最新评论