使用ResponseBodyAdvice返回值为String出现cannot be cast to java.lang.String异常

置顶 已于 2023-07-14 10:21:29 修改
阅读量2.6w 收藏 7
点赞数 7
分类专栏： spring 系列 文章标签： java 开发语言
于 2023-07-08 18:46:43 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/wagnteng/article/details/131615248
版权

使用ResponseBodyAdvice返回值为String出现cannot be cast to java.lang.String异常

背景

由于项目中为了全局返回统一的JSON格式，使用ResponseBodyAdvice进行拦截，拦截的时候会将返回的信息统一一个对象返回到前端。但是有的同事将一个String的响应对象返回，结果报错com.example.demoweb.config.ApiResponse cannot be cast to java.lang.String

ResponseBodyAdvice 拦截器实现

ServletResponseBodyAdvice

package com.example.demoweb.config;

import cn.hutool.extra.servlet.ServletUtil;
import cn.hutool.json.JSONUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.converter.StringHttpMessageConverter;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.validation.BindException;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.validation.ObjectError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

import javax.servlet.http.HttpServletRequest;
import java.util.Objects;

/**
 * @author tengwang8
 */
@ControllerAdvice
@Slf4j
public class ServletResponseBodyAdvice implements ResponseBodyAdvice<Object> {
    @Autowired
    private ApplicationContext applicationContext;
    @ExceptionHandler(BusinessException.class)
    @ResponseBody
    public ApiResponse businessException(BusinessException e) {
        log.error(" business  exception code = {} ,msg = {}", e.getCode(), e.getMsg());


        return ApiResponse.failed(e.getCode(), e.getMsg());
    }


    /**
     * 参数绑定异常
     *
     * @param e 异常
     * @return 异常结果
     */
    @ExceptionHandler(value = BindException.class)
    @ResponseBody
    public ApiResponse handleBindException(BindException e) {
        log.error("params bind exception: ", e);
        return wrapperBindingResult(e.getBindingResult());
    }

    /**
     * 参数校验异常，将校验失败的所有异常组合成一条错误信息
     *
     * @param e 异常
     * @return 异常结果
     */
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    @ResponseBody
    public ApiResponse handleValidException(MethodArgumentNotValidException e) {
        log.error("params valid exception:", e);
        return wrapperBindingResult(e.getBindingResult());
    }


    /**
     * 包装绑定异常结果
     *
     * @param bindingResult 绑定结果
     * @return 异常结果
     */
    private ApiResponse wrapperBindingResult(BindingResult bindingResult) {
        StringBuilder msg = new StringBuilder();

        for (ObjectError error : bindingResult.getAllErrors()) {
            msg.append(", ");
            if (error instanceof FieldError) {
                msg.append(((FieldError) error).getField()).append(": ");
            }
            msg.append(error.getDefaultMessage() == null ? "" : error.getDefaultMessage());

        }
        return ApiResponse.failed(ResultCode.UNAUTHORIZED, msg.substring(2));
    }


    /**
     * 这里直接返回true,表示对任何handler的responsebody都调用beforeBodyWrite方法
     *
     * @param methodParameter
     * @param aClass
     * @return
     */
    @Override
    public boolean supports(MethodParameter methodParameter, Class aClass) {
        return true;
    }


    // 修改responsebody
    @Override
    public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
        if (o instanceof ApiResponse) {
            return  o;
        } else {
            return ApiResponse.success(o);
        }
    }


    /**
     * 未定义异常
     *
     * @param e 异常
     * @return 异常结果
     */
    @ExceptionHandler(value = Exception.class)
    @ResponseBody
    public ApiResponse handleException(Exception e) {
        log.error("handleException :", e);
        return ApiResponse.failed(ResultCode.FAILED);
    }


}

TestDemoController

/**
 * @author tengwang8
 * @date 2022年09月19日 11:02
 */
@RestController
public class TestDemoController {
    @GetMapping("/tt")
    @ResponseBody
    public String test(){

        return "sadsadsad";
    }

}

控制台输出：


java.lang.ClassCastException: com.example.demoweb.config.ApiResponse cannot be cast to java.lang.String
	at org.springframework.http.converter.StringHttpMessageConverter.addDefaultHeaders(StringHttpMessageConverter.java:44) ~[spring-web-5.3.22.jar:5.3.22]
	at org.springframework.http.converter.AbstractHttpMessageConverter.write(AbstractHttpMessageConverter.java:211) ~[spring-web-5.3.22.jar:5.3.22]
	at org.springframework.web.servlet.mvc.method.annotation.AbstractMessageConverterMethodProcessor.writeWithMessageConverters(AbstractMessageConverterMethodProcessor.java:293) ~[spring-webmvc-5.3.22.jar:5.3.22]
	at org.springframework.web.servlet.mvc.method.annotation.RequestResponseBodyMethodProcessor.handleReturnValue(RequestResponseBodyMethodProcessor.java:183) ~[spring-webmvc-5.3.22.jar:5.3.22]
	at org.springframework.web.method.support.HandlerMethodReturnValueHandlerComposite.handleReturnValue(HandlerMethodReturnValueHandlerComposite.java:78) ~[spring-web-5.3.22.jar:5.3.22]
	at org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:135) ~[spring-webmvc-5.3.22.jar:5.3.22]
	at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:895) ~[spring-webmvc-5.3.22.jar:5.3.22]
	at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:808) ~[spring-webmvc-5.3.22.jar:5.3.22]
	at org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:87) ~[spring-webmvc-5.3.22.jar:5.3.22]
	at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1070) ~[spring-webmvc-5.3.22.jar:5.3.22]
	at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:963) ~[spring-webmvc-5.3.22.jar:5.3.22]
	at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1006) [spring-webmvc-5.3.22.jar:5.3.22]
	at org.springframework.web.servlet.FrameworkServlet.doGet(FrameworkServlet.java:898) [spring-webmvc-5.3.22.jar:5.3.22]
	at javax.servlet.http.HttpServlet.service(HttpServlet.java:655) [tomcat-embed-core-9.0.65.jar:4.0.FR]
	at org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:883) [spring-webmvc-5.3.22.jar:5.3.22]
	at javax.servlet.http.HttpServlet.service(HttpServlet.java:764) [tomcat-embed-core-9.0.65.jar:4.0.FR]
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:227) [tomcat-embed-core-9.0.65.jar:9.0.65]
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162) [tomcat-embed-core-9.0.65.jar:9.0.65]
	at org.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:53) [tomcat-embed-websocket-9.0.65.jar:9.0.65]
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189) [tomcat-embed-core-9.0.65.jar:9.0.65]
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162) [tomcat-embed-core-9.0.65.jar:9.0.65]
	at org.springframework.web.filter.RequestContextFilter.doFilterInternal(RequestContextFilter.java:100) [spring-web-5.3.22.jar:5.3.22]
	at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117) [spring-web-5.3.22.jar:5.3.22]
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189) [tomcat-embed-core-9.0.65.jar:9.0.65]
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162) [tomcat-embed-core-9.0.65.jar:9.0.65]
	at org.springframework.web.filter.FormContentFilter.doFilterInternal(FormContentFilter.java:93) [spring-web-5.3.22.jar:5.3.22]
	at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117) [spring-web-5.3.22.jar:5.3.22]
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189) [tomcat-embed-core-9.0.65.jar:9.0.65]
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162) [tomcat-embed-core-9.0.65.jar:9.0.65]
	at org.springframework.web.filter.CharacterEncodingFilter.doFilterInternal(CharacterEncodingFilter.java:201) [spring-web-5.3.22.jar:5.3.22]
	at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117) [spring-web-5.3.22.jar:5.3.22]
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189) [tomcat-embed-core-9.0.65.jar:9.0.65]
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162) [tomcat-embed-core-9.0.65.jar:9.0.65]
	at org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:197) [tomcat-embed-core-9.0.65.jar:9.0.65]
	at org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:97) [tomcat-embed-core-9.0.65.jar:9.0.65]
	at org.apache.catalina.authenticator.AuthenticatorBase.invoke(AuthenticatorBase.java:541) [tomcat-embed-core-9.0.65.jar:9.0.65]
	at org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:135) [tomcat-embed-core-9.0.65.jar:9.0.65]
	at org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:92) [tomcat-embed-core-9.0.65.jar:9.0.65]
	at org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:78) [tomcat-embed-core-9.0.65.jar:9.0.65]
	at org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:360) [tomcat-embed-core-9.0.65.jar:9.0.65]
	at org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:399) [tomcat-embed-core-9.0.65.jar:9.0.65]
	at org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:65) [tomcat-embed-core-9.0.65.jar:9.0.65]
	at org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:890) [tomcat-embed-core-9.0.65.jar:9.0.65]
	at org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1789) [tomcat-embed-core-9.0.65.jar:9.0.65]
	at org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:49) [tomcat-embed-core-9.0.65.jar:9.0.65]
	at org.apache.tomcat.util.threads.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1191) [tomcat-embed-core-9.0.65.jar:9.0.65]
	at org.apache.tomcat.util.threads.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:659) [tomcat-embed-core-9.0.65.jar:9.0.65]
	at org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61) [tomcat-embed-core-9.0.65.jar:9.0.65]
	at java.lang.Thread.run(Thread.java:745) [na:1.8.0_102]

通过错误信息进行分析

StringHttpMessageConverter我们看到有返回string的消息转换器报错的异常，我们断点看一下：
在这里插入图片描述
然后我们这边到是对字符串是重新包装成了一个对象，所以就会报错。

我们再尝试断点看一下如果返回值是实体对象的时候，发现这个转换器是org.springframework.http.converter.json.MappingJackson2HttpMessageConverter：

在这里插入图片描述
那说明Spring 内部是通过不同的消息转换器（MessageConverter）来处理不同的返回值，每个MessageConverer是根据返回类型和媒体类型来选择处理的。

解决方案

其实解决很简单，判断一下返回值是否是String，如果是String的话就将对象处理为Json串就好了,废话不多说，直接上代码：

public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
    if (o instanceof ApiResponse) {
        return  o;
    } else {
        ApiResponse<Object> success = ApiResponse.success(o);
        return   o instanceof String ? JSONUtil.toJsonStr(success) : success;
    }
}

总结

这个问题虽然解决了，其实我是觉得不应该这里随便写这个返回，应该按照规范来定义返回，String类型的数据适不适合返回的，这样不便于对接口响应字段的理解，所以这个虽说是技术问题，实际是规范问题，应该规范大家响应都需要返回实体对象，不管是返回一个字段还是多个字段，必须要使用实体返回。

简单简单小白
关注
  • 7
    点赞
  • 踩
  • 7
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 11
    评论
专栏目录
Java中无参带返回值方法的使用共4页.pdf.zip
10-30
Java中无参带返回值方法的使用共4页.pdf.zip
Spring boot ResponseBodyAdvice接口全局统一返回控制，Api返回值是String 类型时异常
Crystalqy的博客
03-01 3172
在大部分前后端分离项目中，后端的返回值基本都需要包装成一个GlobalResponse，其中属性有code、message、data等，来供前端使用。这样就导致大部分Api写完后都需要手动构建一个GlobalResponse对象并填充属性返回，也就造成了大量的重复代码。这类代码其实有很方便的处理方式，就是使用spring提供的responseBodyAdvice接口
ResponseBodyAdvice、String返回值报cannot be cast to java.lang.String的解决办法
weixin_45176654的博客
11-14 6316
实现ResponseBbodyAdvice接口后，Controller层返回String类型报错的解决办法 1. 问题背景 本人是“某为”的外包开发，项目早期采用的是传统三层架构+n的模式进行开发，但开发到中期后，甲方出台了项目代码规范有要求，其中就包含了冗余代码指标。为了降低无用代码冗余，我们做了很多代码结构层次上的优化。其中在减少controller层无用代码冗余的时候，采用的方案就是采用实现ResponseBbodyAdvice接口来进行的。近期由于我本人希望给页面响应特定的字符串（也就是contro
Java中带参无返回值方法的使用共4页.pdf.zip
10-30
Java中带参无返回值方法的使用共4页.pdf.zip
java. lang . UnsatisfiedLinkError: org. apache . hadoop. io. nativeio. NativeIOSWindows . access0
01-09
我在进行MapReduce本地测试的时候，遇见下面的报错： Exception in thread “main” java. lang . UnsatisfiedLinkError: org. apache . hadoop. io. nativeio. NativeIOSWindows . access0 (Ijava/ lang/String;I)Z  原因：在调用NativeIO中的access0()时调不到 解决方法：①第一步：在项目工程中加入NativelO.java，注意包名必须与源码中一致 ②第二步：将access方法的返回值改为true，不让他去调用access0() 类似
spring mvc配置ResponseBodyAdvice后返回String报错
qq_43633220的博客
09-21 2386
问题描述： 使用以下代码利用ResponseBodyAdvice来统一封装返回的数据 @RestControllerAdvice public class ResponseAdvice implements ResponseBodyAdvice<Object> { @Override public boolean supports(@NotNull MethodParameter returnType, @NotNull Class<? extends HttpMess
通过实现ResponseBodyAdvice接口做统一响应格式处理的时候，controller的返回值为String类型的时候报格式转换异常
weixin_48640132的博客
06-20 1337
因为在SpringMVC框架中，使用@RestController(@Controller + @ResponseBody)注解时，响应给前端之前框架会选择一个适当的解析器HttpMessageConverter，将controller中返回的对象解析成指定格式后写入到Response的body中。Spring有一个在后台注册HttpMessageConverter的列表。HttpMessageConverter的作用是根据预定义的mime（Content-Type）类型将请求体转换成指定的类，然后再转换回
SpringBoot（@ControllerAdvice） ResponseBodyAdvice接口全局统一返回控制，Api返回值是String 类型时异常
最新发布
z69183787的专栏
05-25 460
简而言之：因为API接口返回的是String类型，默认会被StringHttpMessageConverter转换器捕获（支持所有MediaType 并且 接口返回值是 String，并在RequestResponseBodyMethodProcessor#handleReturnValue，writeWithMessageConverters方法中的 canWrite 方法 进行判断通过后，加入可被选择的返回值转换器中）解决方案：在controlleradvice中增加单独处理。
ResponseBodyAdvice接口统一响应数据格式。
夏尔
05-22 2527
前一篇分享了一种封装统一响应对象的方法，这一节分享通过实现ResponseBodyAdvice接口来统一响应数据格式。 1.统一响应对象仍然沿用上一篇的（传送器） 2.实现ResponseBodyAdvice接口 3.测试方法 测试返回类型是String类型程序抛出了异常，报的类型转换异常，当返回类型是String时，用的是StringHttpMessageConverter转换器，无法转换...
Java的方法和返回值.doc
10-30
包含 无参无返回值 //打印输出星号的方法 //创建一个MethodDemo类的对象myMethodDemo //使用对象名。方法名()去调用方法 无参带返回值 //求长方形面积的方法 //返回语句 无参无返回值 //求最大的方法 等Java的方法和返回值的内容
Java中带参带返回值方法的使用共3页.pdf.zip
10-30
Java中带参带返回值方法的使用共3页.pdf.zip
ResultCode() in ResultCode cannot be applied to (java.lang.String,java.lang.String)
expect521的博客
08-28 2万+
解释正确代码： 对于FAILURE是正确的写法，因为在ResultCode 中并没有定义有参构造函数，即默认存在无参构造函数。解释错误代码： 因为在ResultCode 中并没有显性定义构造函数解决办法：创建构造函数，并且构造函数的参数类型与SUCCESS（“200”，“成功”）中定义的要相吻合代码：定义了有参构造函数，不再报错。ResultCode .javapackage com.yubai
实现ResponseBodyAdvice接口，统一拦截接口返回数据时，controller返回值是String 类型时异常
lrt890424的博客
11-01 1万+
为实现接口统一返回数据时自定义的拦截响应数据时出现异常情况。 如果controller 方法返回值 是String 类型时抛出异常。 异常如下： java.lang.ClassCastException: com.lk.face.common.model.ResponseDataVo cannot be cast to java.lang.String at org.springfram...
spring ResponseBodyAdvice 消息转换器 消息转换失败
zhouwenjun0820的博客
05-19 1514
当Rest方法返回String类型响应时，如果ResponseAdvice对响应进行封装成对象则会报错！ @Slf4j @RestControllerAdvice public class RestResponseBodyAdvice implements ResponseBodyAdvice<Object> { @Override public boolean supports(MethodParameter returnType, Class<? extends Htt
SpringMVC：参数处理RequestBodyAdvice和返回结果处理ResponseBodyAdvice
weixin_37672801的博客
06-18 3120
目录背景使用场景接口说明RequestBodyAdviceResponseBodyAdvice示例场景说明：参数转换自定义注解User实体对象接口返回对象自定义RequestBodyAdvice参数处理器自定义ResponseBodyAdvice返回值处理器controller接口测试注意事项在SpringBoot项目中，很多时候都需要对Controller层请求参数和响应结果做一些公共操作，这时就可以使用RequestBodyAdvice和ResponseBodyAdvice。 ResponseBod
@ResponseBody返回4种数据格式的数据
sinat_31986807的博客
04-19 6947
前言 @ResponseBody这个注解通常使用在控制层（controller）的方法上，其作用是将方法的返回值以特定的格式写入到response的body区域，进而将数据返回给客户端。当方法上面没有写ResponseBody,底层会将方法的返回值封装为ModelAndView对象。 假如是字符串则直接将字符串写到客户端,假如是一个对象，此时会将对象转化为json串然后写到客户端。这里需要注意的...
ResponseBodyAdvice接口使用导致的报错及解决
yx444535180的专栏
07-21 2052
ResponseBodyAdvice用于在返回值写入响应之前，将body的内容重新封装，直接上代码。
记录一次并发情况下的redis导致服务假死的问题
热门推荐
简单简单小白
08-29 3万+
这里默认值是false，连接释放的时候先释放resource 然后再将dataSource置为null，那如果是并发的情况下话，那有可能再下一个线程进来的时候dataSource已经就是null了，在执行第2步的时候dataSource刚好被置为null，那这个时候就无法释放连接了。,给出的解决方案是升级jedis的jar包到2.10.2版本以上，换成高版本的以后问题果然就解决了。这里要注意一下的是jedis的版本跟spring-data-redis的版本是有一个对应关系的。查看redis的源码。.....
java.lang.String cannot be cast to java.util.List
05-20
在程序中，有可能存在一个变量或方法返回值被声明为 `List` 类型，但却实际上被赋值为一个 `String` 类型的值，或者在某些情况下返回了一个 `String` 类型的值而不是 `List` 类型的值。 要解决这个错误，您需要检查...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 11
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

简单简单小白

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值