Spring Boot 统一数据返回格式的解决方案

 更新时间:2024年03月30日 14:43:21   作者:Dikz12  
统?的数据返回格式使? @ControllerAdvice 和 ResponseBodyAdvice 的?式实现,下面给大家分享Spring Boot 统一数据返回格式的解决方案,感兴趣的朋友一起看看吧
(福利推荐:【腾讯云】服务器最新限时优惠活动,云服务器1核2G仅99元/年、2核4G仅768元/3年,立即抢购>>>:9i0i.cn/qcloud

(福利推荐:你还在原价购买阿里云服务器?现在阿里云0.8折限时抢购活动来啦!4核8G企业云服务器仅2998元/3年,立即抢购>>>:9i0i.cn/aliyun

实现统一数据格式

统?的数据返回格式使? @ControllerAdvice 和 ResponseBodyAdvice 的?式实现;
@ControllerAdvice : 表?控制器通知类.
比如:添加类 ResponseAdvice , 实现 ResponseBodyAdvice 接?, 并在类上添加
@ControllerAdvice 注解.

import com.example.demo.model.Result;
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;
@ControllerAdvice
public class ResponseAdvice implements ResponseBodyAdvice {
    @Override
    public boolean supports(MethodParameter returnType, Class converterType) {
        return true;
    }
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType,
                                  MediaType selectedContentType, Class selectedConverterType,
                                  ServerHttpRequest request, ServerHttpResponse response) {
        return Result.success(body); //返回 Result 类型的数据
    }
}

 supports?法: 判断是否要执?beforeBodyWrite?法. true为执?, false不执?. 通过该?法可以 选择哪些类或哪些?法的response要进?处理, 其他的不进?处理.

beforeBodyWrite?法:对response?法进?具体操作处理.

 测试 

 写一些不同的返回结果,看看哪些会出现问题!

import com.example.demo.model.BookInfo;
import com.example.demo.model.Result;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/test")
public class TestController {
    @RequestMapping("/t1")
    public Integer t1() {
        return 12334;
    }
    @RequestMapping("/t2")
    public String t2() {
        return "hello";
    }
    @RequestMapping("/t3")
    public Boolean t3() {
        return true;
    }
    @RequestMapping("/t4")
    public BookInfo t4() {
        return new BookInfo();
    }
    @RequestMapping("/t5")
    public Result t5() {
        return Result.success("success");
    }
}

1.返回结果为Integer,可以正确响应.

2.返回结果为String,结果显示内部错误.

 控制台查看日志:

3.返回结果为Boolean,可以正常响应.

 4.返回结果为BookInfo对象,可以正常响应.

5.返回结果为Result,发现又进行了一次封装.

 问题:1.返回结果为String,不能正常进行处理了;2.返回结果为Result,又多进行了一次封装.

 原因分析

这时候就会非常纳闷了,为什么就处理String的时候会出错呢?就不得不去看源码分析了.

SpringMVC (也就是在初始化时) 默认会注册?些?带的 HttpMessageConverter (转换器) (从先后顺序排列分别为 ByteArrayHttpMessageConverter , StringHttpMessageConverter , SourceHttpMessageConverter , SourceHttpMessageConverter , AllEncompassingFormHttpMessageConverter )

 这些转换器是有先后顺序的,是用ArrayList存储的.会根据我们的返回结果挨个判断使用哪个转换器!!!

此时,就会发现问题就出现在 StringHttpMessageConverter.

处理的内容主要是在AbstractMessageConverterMethodProcessor 中 会有一个writeWithMessageConverters()方法.

通过getAdvice()拿到了beforBodyWrite 就会对body进行处理,处理完之后并没有结束(body变成了Result类型),此时,也并没有出错。会继续执行((HttpMessageConverter) converter).write(body, selectedMediaType, outputMessage).

 由于 StringHttpMessageConverter 重写了addDefaultHeaders?法, 所以会执??类的?法

然??类 StringHttpMessageConverter 的addDefaultHeaders?法定义接收参数为String, 此

时t为Result类型, 所以出现类型不匹配" Result cannot be cast to java.lang.String "的异常.

 解决方案

1.当返回结果为Result时,就直接返回body.

2.当返回结果为String时,采用SpringBoot内置提供的Jackson来实现信息的序列化 

@ControllerAdvice
public class ResponseAdvice implements ResponseBodyAdvice {
    @Autowired
    private ObjectMapper objectMapper;
    @Override
    public boolean supports(MethodParameter returnType, Class converterType) {
        return true;
    }
    @SneakyThrows
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType,
                                  MediaType selectedContentType, Class selectedConverterType,
                                  ServerHttpRequest request, ServerHttpResponse response) {
        //body 是返回的结果
        //当返回结果为Result类型时,就直接返回body
        if (body instanceof Result) {
            return body;
        }
        //返回结果为String类型, 使?SpringBoot内置提供的Jackson来实现信息的序列化
        if (body instanceof String) {
            return objectMapper.writeValueAsString(Result.success(body));
        }
        return Result.success(body); //返回 Result 类型的数据
    }
}

到此这篇关于Spring Boot 统一数据返回格式 分析 和 处理的文章就介绍到这了,更多相关Spring Boot 统一数据返回格式内容请搜索程序员之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持程序员之家!

相关文章

  • Maven离线模式打包全过程

    Maven离线模式打包全过程

    这篇文章主要介绍了Maven离线模式打包全过程,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-04-04
  • 关于@RequestLine的使用及配置

    关于@RequestLine的使用及配置

    这篇文章主要介绍了关于@RequestLine的使用及配置方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-07-07
  • Java Redis Redisson配置教程详解

    Java Redis Redisson配置教程详解

    这篇文章主要介绍了Java Redis Redisson配置教程,包括Session共享配置及其他Redisson的Config配置方式,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-08-08
  • Eclipse使用maven搭建spring mvc图文教程

    Eclipse使用maven搭建spring mvc图文教程

    这篇文章主要为大家分享了Eclipse使用maven搭建spring mvc图文教程,感兴趣的小伙伴们可以参考一下
    2016-05-05
  • SpringBoot工程启动顺序与自定义监听超详细讲解

    SpringBoot工程启动顺序与自定义监听超详细讲解

    这篇文章主要介绍了SpringBoot工程启动顺序与自定义监听,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习吧
    2022-11-11
  • Java实现一个简易聊天室流程

    Java实现一个简易聊天室流程

    这篇文章主要介绍了我的java课程设计一个多人聊天室(socket+多线程)本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-11-11
  • Java实现Html转Pdf的方法

    Java实现Html转Pdf的方法

    这篇文章主要介绍了Java实现Html转Pdf的方法,实例分析了java基于ITextRenderer类操作页面及系统自带字体生成pdf文件的相关技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-07-07
  • Java最常用的6个简单的计算题

    Java最常用的6个简单的计算题

    本篇文章给大家整理的在JAVA中最常用到的简单的计算题,对此有兴趣的朋友可以测试参考下。
    2018-02-02
  • Spring MVC Controller传递枚举值的实例

    Spring MVC Controller传递枚举值的实例

    这篇文章主要介绍了Spring MVC Controller传递枚举值的实例,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • Springboot Redis设置key前缀的方法步骤

    Springboot Redis设置key前缀的方法步骤

    这篇文章主要介绍了Springboot Redis设置key前缀的方法步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-04-04

最新评论

?


http://www.vxiaotou.com