Spring boot ResponseBodyAdvice接口全局统一返回控制，Api返回值是String 类型时异常

已于 2023-11-08 11:08:09 修改
阅读量3.7k 收藏 8
点赞数 3
分类专栏： Spring Boot 文章标签： springBoot
于 2023-03-01 17:40:05 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Crystalqy/article/details/129285988
版权

ResponseBodyAdvice简介

在大部分前后端分离项目中，后端的返回值基本都需要包装成一个GlobalResponse，其中属性有code、message、data等，来供前端使用。这样就导致大部分Api写完后都需要手动构建一个GlobalResponse对象并填充属性返回，也就造成了大量的重复代码。

　　这类代码其实有很方便的处理方式，就是使用spring提供的responseBodyAdvice接口，同样有 responseBodyAdvice，就有 requestBodyAdvice。

requestBodyAdvice —— 请求体的统一处理器，一般用来对请求参数做一些统一的解密等。

responseBodyAdvice —— 响应体的统一处理器，一般用来统一返回值使用。

异常现象

在我们系统中定义一个类，实现responseBodyAdvice接口，配合@RestControllerAdvice注解就可以实现全局统一返回了，在实际使用中遇到一个问题，如果Api方法返回值 是String 类型时抛出异常。其他的目前一切正常，错误信息：


java.lang.ClassCastException: com.cxm.common.entrity.response.GlobalResponse cannot be cast to java.lang.String
    at org.springframework.http.converter.StringHttpMessageConverter.getContentLength(StringHttpMessageConverter.java:43)
    at org.springframework.http.converter.AbstractHttpMessageConverter.addDefaultHeaders(AbstractHttpMessageConverter.java:260)
    at org.springframework.http.converter.AbstractHttpMessageConverter.write(AbstractHttpMessageConverter.java:211)
    at org.springframework.web.servlet.mvc.method.annotation.AbstractMessageConverterMethodProcessor.writeWithMessageConverters(AbstractMessageConverterMethodProcessor.java:293)
    at org.springframework.web.servlet.mvc.method.annotation.RequestResponseBodyMethodProcessor.handleReturnValue(RequestResponseBodyMethodProcessor.java:180)
    at org.springframework.web.method.support.HandlerMethodReturnValueHandlerComposite.handleReturnValue(HandlerMethodReturnValueHandlerComposite.java:82)
    at org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:119)
    at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:895)
    at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:800)
    at org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:87)
    at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1038)
    at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:942)
    at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1005)
    at org.springframework.web.servlet.FrameworkServlet.doGet(FrameworkServlet.java:897)
    at javax.servlet.http.HttpServlet.service(HttpServlet.java:634)
    at org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:882)
    at javax.servlet.http.HttpServlet.service(HttpServlet.java:741)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:231)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
    at org.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:53)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
    at com.github.xiaoymin.swaggerbootstrapui.filter.SecurityBasicAuthFilter.doFilter(SecurityBasicAuthFilter.java:81)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
    at com.github.xiaoymin.swaggerbootstrapui.filter.ProductionSecurityFilter.doFilter(ProductionSecurityFilter.java:53)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
    at com.cxm.interceptor.CxmRequestValidFilter.doFilter(CxmRequestValidFilter.java:94)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
    at org.springframework.boot.actuate.web.trace.servlet.HttpTraceFilter.doFilterInternal(HttpTraceFilter.java:90)
    at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:107)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
    at org.springframework.web.filter.RequestContextFilter.doFilterInternal(RequestContextFilter.java:99)
    at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:107)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
    at org.springframework.web.filter.FormContentFilter.doFilterInternal(FormContentFilter.java:92)
    at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:107)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
    at org.springframework.web.filter.HiddenHttpMethodFilter.doFilterInternal(HiddenHttpMethodFilter.java:93)
    at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:107)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
    at org.springframework.boot.actuate.metrics.web.servlet.WebMvcMetricsFilter.filterAndRecordMetrics(WebMvcMetricsFilter.java:117)
    at org.springframework.boot.actuate.metrics.web.servlet.WebMvcMetricsFilter.doFilterInternal(WebMvcMetricsFilter.java:106)
    at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:107)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
    at org.springframework.web.filter.CharacterEncodingFilter.doFilterInternal(CharacterEncodingFilter.java:200)
    at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:107)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
    at com.cxm.interceptor.GzipRequestFilter.doFilter(GzipRequestFilter.java:26)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
    at org.springframework.web.filter.CorsFilter.doFilterInternal(CorsFilter.java:96)
    at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:107)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
    at org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:200)
    at org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:96)
    at org.apache.catalina.authenticator.AuthenticatorBase.invoke(AuthenticatorBase.java:490)
    at org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:139)
    at org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:92)
    at org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:74)
    at org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:343)
    at org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:408)
    at org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:66)
    at org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:834)
    at org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1415)
    at org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:49)
    at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1149)
    at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624)
    at org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)
    at java.lang.Thread.run(Thread.java:748)

源码解析

经过调试发现Spring 的HttpMessageConverter有11个：


[org.springframework.data.web.ProjectingJackson2HttpMessageConverter@21b07f0c,
 org.springframework.http.converter.ByteArrayHttpMessageConverter@3404df71,
  org.springframework.http.converter.StringHttpMessageConverter@125c42e3, 
  org.springframework.http.converter.StringHttpMessageConverter@24851f5c,
   org.springframework.http.converter.ResourceHttpMessageConverter@43fe325e, 
org.springframework.http.converter.ResourceRegionHttpMessageConverter@51939207,
 org.springframework.http.converter.xml.SourceHttpMessageConverter@21a8998c, 
org.springframework.http.converter.support.AllEncompassingFormHttpMessageConverter@2ddb0d1a,
 org.springframework.http.converter.json.MappingJackson2HttpMessageConverter@1f05b63d, 
org.springframework.http.converter.json.MappingJackson2HttpMessageConverter@524b1c70, 
org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter@37ca8b4c]

问题就出在StringHttpMessageConverter上面

具体的代码可以参考AbstractMessageConverterMethodProcessor类的writeWithMessageConverters方法

有问题的地方就出现在标记的地方write方法，调用AbstractHttpMessageConverter的write方法

接着会调用addDefaultHeaders

getContentLength有多个类实现，其中有一个就是StringHttpMessageConverter，这个类里面的getContentLength入参是String类型


@Override
    protected Long getContentLength(String str, @Nullable MediaType contentType) {
        Charset charset = getContentTypeCharset(contentType);
        return (long) str.getBytes(charset).length;
    }

这个时候会直接将对象GlobalResponse强制转换成String所以这个地方会报错

解决方案

如果返回值是String的时候，需要手动Json序列化

Spring Boot进阶(50)：「异常无处藏身」 Spring Boot全局异常处理，秒解业务难题
**My Coding Family**
06-15 1205
一文教你如何在Spring Boot项目中全局统一处理异常，非常详细具体。
Spring Boot进阶(45): Spring Boot 开发必备技能：如何优雅地返回统一结果包装！
**My Coding Family**
06-15 1840
Spring Boot 如何返回统一结果包装？一文教会你。
spring mvc配置ResponseBodyAdvice后返回String报错
qq_43633220的博客
09-21 2553
问题描述： 使用以下代码利用ResponseBodyAdvice来统一封装返回的数据 @RestControllerAdvice public class ResponseAdvice implements ResponseBodyAdvice<Object> { @Override public boolean supports(@NotNull MethodParameter returnType, @NotNull Class<? extends HttpMess
Spring MVC的异步模式（ResponseBodyEmitter、SseEmitter、StreamingResponseBody）
fyk的博客
09-10 1535
通过spring mvc异步接口，实现后端分段向前端发送信息。
SpringBoot（@ControllerAdvice） ResponseBodyAdvice接口全局统一返回控制，Api返回值是String 类型时异常
z69183787的专栏
05-25 700
简而言之：因为API接口返回的是String类型，默认会被StringHttpMessageConverter转换器捕获（支持所有MediaType 并且 接口返回值是 String，并在RequestResponseBodyMethodProcessor#handleReturnValue，writeWithMessageConverters方法中的 canWrite 方法 进行判断通过后，加入可被选择的返回值转换器中）解决方案：在controlleradvice中增加单独处理。
SpringBoot中使用ResponseBodyAdvice对响应(返回值)进行增强
最新发布
weixin_52630811的博客
10-15 433
它允许在执行带有@ResponseBody注解或ResponseEntity的控制器方法之后，但在使用HttpMessageConverter写入响应体之前自定义响应。实现方式可以直接在RequestMappingHandlerAdapter和ExceptionHandlerExceptionResolver中注册，或者更有可能使用@ControllerAdvice注解，在这种情况下，它们将被两者自动检测到。翻译内容来源于AI是 Spring 提供的一个接口。
使用ResponseBodyAdvice返回值为String出现cannot be cast to java.lang.String异常
热门推荐
简单简单小白
07-08 2万+
由于项目中为了全局返回统一的JSON格式，使用ResponseBodyAdvice进行拦截，拦截的时候会将返回的信息统一一个对象返回到前端。但是有的同事将一个String的响应对象返回，结果报错com.example.demoweb.config.ApiResponse cannot be cast to java.lang.String
springboot项目用ResponseBodyAdvice统一包装返回体-笔记
ThinkPet
05-29 1290
*** 实现 ResponseBodyAdvice接口，并重写其中的方法，即可对我们的controller进行增强操作* 不管Controller中 是否使用ResultVO对返回结果包装，* 均可被 ResponseBodyAdvice接口 处理返回数据，以使系统 统一结果，统一异常，统一日志*/ // 注意哦，这里要加上需要扫描的包 @RestControllerAdvice(basePackages = {/**
Spring Boot 捕捉全局异常 统一返回值的问题
08-19
Spring Boot 捕捉全局异常统一返回值 在 Spring Boot 框架中，捕捉全局异常并统一返回值是一个非常重要的概念。本文将通过实例代码详细介绍如何在 Spring Boot 中捕捉全局异常，并统一返回值，从而使开发者能够更好...
SpringBoot实现接口：统一返回值、全局异常处理、Swagger接口文档
pan_junbiao的博客
10-15 941
在 Spring Boot 应用中实现统一返回值和全局异常处理可以带来多方面的好处，这些好处不仅提升了代码的可读性和可维护性，还增强了应用的健壮性和用户体验。通过定义统一的返回值格式，可以确保整个应用中的API响应结构保持一致。统一的异常处理机制使得错误信息的返回方式也保持一致，便于前端开发者理解和处理。
【微服务】springboot 实现动态修改接口返回值
congge
09-28 8237
springboot 实现动态修改接口返回值
Spring Boot ResponseBodyAdvice
wangooo的博客
03-02 2181
转：https://www.cnblogs.com/gllegolas/p/12452841.html ResponseBodyAdvice是spring4.1的新特性，其作用是在响应体写出之前做一些处理，比如，修改返回值、加密等。 ResponseBodyAdvice接口是在Controller执行return之后，在response返回给浏览器或者APP客户端之前，执行的对response的一些处理。可以实现对response数据的一些统一封装或者加密等操作。 该接口一共有两个方法：
SpringBoot之ResponseBodyAdvice
zjxbllg2008的专栏
10-24 1377
可能会有这样的需求，对你的Controller返回值进行一个二次封装， 如下：code是结果码（1、成功，0、失败，2、未登录...），data为携带数据 {"code":"1","data":{"name":"xiaoming","age":"30"}} 因为SpringBoot默认的ResponseBody的处理程序就是HandlerMethodReturnValueHandler...
springboot中的ResponseBodyAdvice
记录一些工作日常和学习
11-14 775
springboot中的ResponseBodyAdvice
springboot ResponseBodyAdvice说明
weixin_43931625的博客
08-08 655
springboot ResponseBodyAdvice说明
Springboot中使用ResponseBodyAdvice对异常，分页等请求进行封装
weixin_43389741的博客
11-19 1702
在java 中，我们常常需要对接口返回的数据进行统一的封装，如调用接口异常的时候，我们不希望直接在后台报错，而是需要给前端或者友好提示是什么异常。又或者在处理分页请求的时候，我们可能需要对数据进行统一的封装(返回总条数，数据集等)，对于这个需求，我们可以使用ResponseBodyAdvice 这个接口实现。 以下是几个效果图 1. 2. 3. 4. 5. ResponseBodyAdvice 是 spring 框架中提供的一个接口，其有两个方法，如下: supports ：返回参数是一个boolean类
SpringBoot ResponseBodyAdvice使用以及常见问题
ly-chn的博客
01-25 2126
advice, 在这里意思是顾问, 其余很多场景也是顾问的意思由于篇幅问题, 注释已删, 如想看注释, 请在github中查看作用: 用于在Controller返回后, HttpMessageConverter执行转换之前执行一些转换常见场景: 统一响应结构, 如json统一包装由于版本不同, 多少有些差异, 所以不贴源码了, 基本上springboot2.x和3.x是通用的/*** 此Advice是否使用于该返回类型和Converter类型(意思是可以配置多个哦)
springboot学习-ResponseBodyAdvice
baichengshan的博客
09-28 1375
springboot ResponseBodyAdvice
springboot--拦截器和接口-ResponseBodyAdvice--WebMvcConfigurer
wlwork66的博客
05-05 2093
目标 1 你可以在自己的日志中看到自己接口的出参和入参，同时你不用在每个接口中写打印的逻辑，直接交给拦截器完成。 2 你可以任意包装你的出参，比如加上消耗的时间，添加一个唯一的uuid等等，同时这些东西都是由拦截器提供的功能。这些功能也可以做成配置化，比如你那些接口不需要这样的包装，在yml中配置一下，就可以了。 看图 接口模样 每次接口请求都会输出param，路径 消耗的时间 ...
spring boot全局异常没有捕捉到
05-26
在 Spring Boot 中，可以使用@ControllerAdvice注解来实现全局异常处理。你可以创建一个类，使用@ControllerAdvice注解标注该类，并在类中定义一个方法，使用@ExceptionHandler注解来捕获所有的异常。例如： ```java @ControllerAdvice public class GlobalExceptionHandler { @ExceptionHandler(Exception.class) @ResponseBody public String handleException(Exception e) { return "发生异常：" + e.getMessage(); } } ``` 在上面的代码中，我们定义了一个GlobalExceptionHandler类，并在类上使用@ControllerAdvice注解来标注该类，表示这是一个全局异常处理类。然后，在类中，我们定义了一个handleException方法，使用@ExceptionHandler注解来捕获所有的异常，并使用@ResponseBody注解来将方法的返回值转换为JSON格式的字符串。 如果你的全局异常处理没有生效，有可能是因为你没有将该类扫描到Spring容器中。你可以在Spring Boot的启动类上使用@ComponentScan注解或者@SpringBootApplication注解来扫描该类。例如： ```java @SpringBootApplication @ComponentScan(basePackages = {"com.example.demo"}) public class DemoApplication { public static void main(String[] args) { SpringApplication.run(DemoApplication.class, args); } } ``` 在上面的代码中，我们在@SpringBootApplication注解上使用@ComponentScan注解来扫描com.example.demo包下的所有类，包括GlobalExceptionHandler类。这样，Spring容器就会自动将GlobalExceptionHandler类加载到容器中，并且生效。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值