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

已于 2023-11-08 11:08:09 修改
阅读量3.6k 收藏 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序列化

Crystalqy
关注
  • 3
    点赞
  • 踩
  • 8
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
Spring Boot进阶(45): Spring Boot 开发必备技能：如何优雅地返回统一结果包装！
**My Coding Family**
06-15 1645
Spring Boot 如何返回统一结果包装？一文教会你。
springboot spring aop 拦截器注解方式实现脱敏
02-13
在Spring Boot应用中，Spring AOP（面向切面编程）是一种强大的工具，它允许我们创建横切关注点，如日志记录、权限检查等，这些关注点可以被编织到应用程序的多个点上，而无需侵入核心业务逻辑。在本案例中，我们将...
Spring Boot 捕捉全局异常 统一返回值的问题
08-19
主要介绍了Spring Boot 捕捉全局异常 统一返回值，本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
@ControllerAdvice + ResponseBodyAdvice实现返回统一结构
qq_45464560的博客
08-13 1315
实现返回统一数据结构
SpringBoot 实现RequestBodyAdvice封装统一接受类功能
最新发布
白白白鲤鱼的博客
06-21 1021
SpringBoot 实现RequestBodyAdvice封装统一接受类功能
SpringBoot（@ControllerAdvice） ResponseBodyAdvice接口全局统一返回控制，Api返回值是String 类型时异常
z69183787的专栏
05-25 595
简而言之：因为API接口返回的是String类型，默认会被StringHttpMessageConverter转换器捕获（支持所有MediaType 并且 接口返回值是 String，并在RequestResponseBodyMethodProcessor#handleReturnValue，writeWithMessageConverters方法中的 canWrite 方法 进行判断通过后，加入可被选择的返回值转换器中）解决方案：在controlleradvice中增加单独处理。
spring boot2 (39)- 统一返回结果和ResponseBodyAdvice
JAVA博客
02-18 435
本篇介绍rest接口，如何返回统一的状态码、消息、数据等。
SpringMVC统一封装响应结果接口返回String类型时的异常问题分析
m0_50275872的博客
06-26 1693
利用ResponseAdvisor对Controller的响应结果做了统一封装，接口返回String类型时，抛出类型转换异常。
Spring Boot 无侵入式 实现API接口统一JSON格式返回
小魏的奇妙世界
10-06 1万+
无侵入式 统一返回JSON格式 其实本没有没打算写这篇博客的，但还是要写一下写这篇博客的起因是因为，现在呆着的这家公司居然没有统一的API返回格式????，询问主管他居然告诉我用HTTP状态码就够用了（fxxk），天哪HTTP状态码真的够用吗？在仔细的阅读了项目源码后发现，在API请求的是居然没有业务异常（黑人问好）。好吧 居然入坑了只能遵照项目风格了，懒得吐槽了。 因为项目已经开发了半年多了, 要是全...
SpringBoot统一接口返回和全局异常处理
奋斗不息，编码不止
03-12 8819
现在大多数web项目基本都是前后端分离模式，这种模式会涉及到一个前后端对接问题，所以一套完善且规范的接口是非常有必要的，不仅能够提高对接效率，也可以让我的代码看起来更加简洁优雅。本文将解决如何在基于SpringBoot前后端分离开发模式下返回统一的标准格式以及处理全局异常。 SpringBoot统一接口返回和全局异常处理一、为什么要返回统一格式1.1 返回字符串1.2 返回实体类对象1.3 返回异常二、定义返回标准格式2.1 定义返回格式2.2 定义返回对象2.3 定义状态码2.4 统一返回格式三、高级.
Spring Boot 统一数据返回格式
qq_45875349的博客
05-28 1624
使用@ControllerAdvice和@ResponseBodyAdvice统一API数据返回格式
Spring Boot 通过AOP和自定义注解实现权限控制的方法
08-25
Spring Boot 通过 AOP 和自定义注解实现权限控制的方法 在本文中，我们将探讨如何使用 Spring Boot 通过 Aspect-Oriented Programming（AOP）和自定义注解来实现权限控制。权限控制是任何应用程序的重要组件，它...
SpringBoot控制器统一的响应体加密与请求体解密的注解处理方式
08-08
为了保护数据传输的安全，通常需要对控制器返回的响应体进行加密，并确保接收到的请求体能够正确解密。在本主题中，我们将探讨如何利用自定义注解来实现SpringBoot中统一的响应体加密和请求体解密，支持MD5、SHA、...
springboot中用fastjson处理返回值为null的属性值
10-15
总结来说，通过配置Spring Boot中的FastjsonHttpMessageConverter，并利用Fastjson的`SerializerFeature`，我们可以有效地处理返回值为`null`的属性，确保这些属性在序列化时不会出现在JSON响应中。这有助于优化网络...
spring boot web切面注解实现全局异常处理、统一返回体
三少说
06-21 636
spring boot web切面注解实现全局异常处理、统一返回体
SpringBoot实现RESTful API返回统一数据格式
热门推荐
Crystalqy的博客
03-03 3万+
关于 Spring 的全局处理，有两方面要说: 统一数据返回格式 统一异常处理 通用返回值类定义： public class GlobalResponse<T> implements POJO { /** * */ private static final long serialVersionUID = 1L; @ApiModelPro...
基于EnvironmentPostProcessor实现自定义配置中心
Crystalqy的博客
07-16 2万+
SpringBoot支持动态的读取文件，留下的扩展接口org.springframework.boot.env.EnvironmentPostProcessor。这个接口是spring包下的，使用这个进行配置文件的集中管理，而不需要每个项目都去配置配置文件。这种方法也是springboot框架留下的一个扩展（可以自己去扩展） 实现demo 自定义CxmRPCConfigEnvironmentPostProcessor类实现EnvironmentPostProcessor接口 public cla
Spring Boot Actuator分析，自定义端点
Crystalqy的博客
02-07 6316
 每个Actuator端点都是有一个特定的ID用来决定端点的路径。/beans端点的默认ID就是 beans。端点的路径是由ID决定的，那么可以通过修改ID来改变端点的路径。要做的就是设置一个属性， 属性名是 endpoints.endpoint-id.id修改端点的ID：   如把/beans改为/beansome：   endpoints.beans.id=beansome   这时要是想查看...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值