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

 更新时间:2024年03月30日 14:43:21   作者:Dikz12  
统⼀的数据返回格式使⽤ @ControllerAdvice 和 ResponseBodyAdvice 的⽅式实现,下面给大家分享Spring Boot 统一数据返回格式的解决方案,感兴趣的朋友一起看看吧

实现统一数据格式

统⼀的数据返回格式使⽤ @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 统一数据返回格式内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Spring Bean作用域与生命周期全解析(推荐)

    Spring Bean作用域与生命周期全解析(推荐)

    Spring Bean作用域与生命周期详解,涵盖 Singleton、Prototype、Request、Session、Application 五种作用域,解析其特点、配置方式及适用场景,感兴趣的朋友跟随小编一起看看吧
    2026-05-05
  • IDEA Reformat Code 格式化代码(详解)

    IDEA Reformat Code 格式化代码(详解)

    平时使用Ctrl+Alt+L可以格式化代码,idea帮你整理空格,换行等,让代码看起来更整洁,今天通过本文给大家分享IDEA Reformat Code 格式化 的过程,感兴趣的朋友一起看看吧
    2023-11-11
  • Java实现分解任意输入数的质因数算法示例

    Java实现分解任意输入数的质因数算法示例

    这篇文章主要介绍了Java实现分解任意输入数的质因数算法,涉及java数学运算相关操作技巧,需要的朋友可以参考下
    2017-10-10
  • SpringMVC处理multipart请求的示例代码

    SpringMVC处理multipart请求的示例代码

    本篇文章主要介绍了SpringMVC处理multipart请求的示例代码,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-01-01
  • Java中的CompletionService批量异步执行详解

    Java中的CompletionService批量异步执行详解

    这篇文章主要介绍了Java中的CompletionService批量异步执行详解,我们知道线程池可以执行异步任务,同时可以通过返回值Future获取返回值,所以异步任务大多数采用ThreadPoolExecutor+Future,需要的朋友可以参考下
    2023-12-12
  • SpringBoot内存数据导出成Excel的实现方法

    SpringBoot内存数据导出成Excel的实现方法

    这篇文章主要给大家介绍了关于SpringBoot内存数据导出成Excel的实现方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-12-12
  • SpringCloud Gateway鉴权和跨域解决方案

    SpringCloud Gateway鉴权和跨域解决方案

    网关是介于客户端和服务器端之间的中间层,所有的外部请求都会先经过 网关这一层,也就是说,API 的实现方面更多的考虑业务逻辑,而安全、性能、监控可以交由 网关来做,这样既提高业务灵活性又不缺安全性,本文给大家介绍SpringCloud Gateway鉴权和跨域解决方案,一起看看吧
    2023-11-11
  • jmeter的时间戳函数使用

    jmeter的时间戳函数使用

    在使用jmeter做接口测试的时候,经常会要用到日期这种函数,本文主要介绍了jmeter的时间戳函数使用,感兴趣的可以了解一下
    2021-11-11
  • 详解JVM如何判断一个对象是否可以被回收

    详解JVM如何判断一个对象是否可以被回收

    在c++中,当我们使用完某个对象的时候,需要显示的将对象回收,在java中,jvm会帮助我们进行垃圾回收,无需程序员自己写代码进行回收,下面我们就来看看JVM是如何判断一个对象是否可以被回收的吧
    2023-11-11
  • 轻松掌握Java命令模式

    轻松掌握Java命令模式

    这篇文章主要帮助大家轻松掌握Java命令模式,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-09-09

最新评论