springBoot统一响应类型3.1版本

devtools/2025/2/28 10:13:49/
前言:

通过实践而发现真理,又通过实践而证实真理和发展真理。从感性认识而能动地发展到理性认识,又从理性认识而能动地指导革命实践,改造主观世界和客观世界。实践、认识、再实践、再认识,这种形式,循环往复以至无穷,而实践和认识之每一循环的内容,都比较地进到了高一级的程度。

简单回忆:

基础统一响应1.0

java">/*** 基础统一响应类* @param <T>*/@Data
public class apiResult<T> {private int code;private String message;private T data;/*** 带有data返回的构造函数* @param code* @param message* @param data*/public apiResult(int code, String message, T data) {this.code = code;this.message = message;this.data = data;}/*** 不带data的构造函数* @param code* @param message*/public apiResult(int code,String message){this.code = code;this.message = message;}
}

在1.0的基础上,进行优化加工

java">/*** 统一响应类实例化工具*/public class apiResultYOUYA {//http成功状态码private static final int OK = HttpStatus.OK.value();//隔着报错状态码private static int NO = HttpStatus.INTERNAL_SERVER_ERROR.value();//基本成功响应public static <T>apiResult<T> success(T data){return new apiResult<>(OK,"操作成功",data);}//自定义信息成功响应public static <T>apiResult<T> success(String message,T data){return new apiResult<>(OK,message,data);}//基础失败响应public static <T>apiResult<T> error(){return new apiResult<>(NO,"系统错误,请联系管理员");}//自定义信息失败响应public static <T>apiResult<T> error(String message){return new apiResult<>(NO,message);}
}

在1.0,2.0的基础上进行迭代后的全局响应

java">@ControllerAdvice
public class GlobalApiResult implements ResponseBodyAdvice<Object> {/*** 此Advice是否使用于该返回类型和Converter类型(意思是可以配置多个哦)* @param returnType 返回类型(这里可以获取很多东西, 别被名字误导了)* @param converterType 自动选择的转换器类型* @return 返回true表示将会走接下来的方法(beforeBodyWrite), 否则不会*/@Overridepublic boolean supports(MethodParameter returnType,Class<? extends HttpMessageConverter<?>> converterType) {//false -> true  用于测试,正式的时需要修改return true;}/*** HttpMessageConverter转换之前进行的操作* @param body 要转换的body* @param returnType 返回类型* @param selectedContentType 根据请求头协商的ContentType* @param selectedConverterType 自动选择的转换器类型* @param request 当前请求* @param response 当前响应* @return 修改后的响应内容*/@Overridepublic Object beforeBodyWrite(Object body,MethodParameter returnType,MediaType selectedContentType,Class<? extends HttpMessageConverter<?>> selectedConverterType,ServerHttpRequest request,ServerHttpResponse response) {//第二步: 将body传入统一响应工具类中的默认成功响应return apiResultYOUYA.success(body);}
}

3.0完成全局统一响应(无论成功还是失败)

正片:

通过不断的测试,重启,从而发现真理

测试方法:不断修改变量,简称量变产生质变

测试代码

java">@ControllerAdvice
public class GlobalApiResult implements ResponseBodyAdvice<Object> {/*** 此Advice是否使用于该返回类型和Converter类型(意思是可以配置多个哦)* @param returnType 返回类型(这里可以获取很多东西, 别被名字误导了)* @param converterType 自动选择的转换器类型* @return 返回true表示将会走接下来的方法(beforeBodyWrite), 否则不会*/@Overridepublic boolean supports(MethodParameter returnType,Class<? extends HttpMessageConverter<?>> converterType) {//false -> true  用于测试,正式的时需要修改return true;}/*** HttpMessageConverter转换之前进行的操作* @param body 要转换的body* @param returnType 返回类型* @param selectedContentType 根据请求头协商的ContentType* @param selectedConverterType 自动选择的转换器类型* @param request 当前请求* @param response 当前响应* @return 修改后的响应内容*/@Overridepublic Object beforeBodyWrite(Object body,MethodParameter returnType,MediaType selectedContentType,Class<? extends HttpMessageConverter<?>> selectedConverterType,ServerHttpRequest request,ServerHttpResponse response) {//第二步: 将body传入统一响应工具类中的默认成功响应return apiResultYOUYA.success(body);}
}

第一轮测试:删除注解——@ControllerAdvice

测试结果:返回值为api接口类型

对比带有@ControllerAdvice的结果

结论:@ControllerAdvice具有覆盖默认接口类型的作用

我们还原最初的全局配置

java">@ControllerAdvice
public class GlobalApiResult implements ResponseBodyAdvice<Object> {@Overridepublic boolean supports(MethodParameter returnType,Class<? extends HttpMessageConverter<?>> converterType) {//false -> true  用于测试,正式的时需要修改return false;}@Overridepublic Object beforeBodyWrite(Object body,MethodParameter returnType,MediaType selectedContentType,Class<? extends HttpMessageConverter<?>> selectedConverterType,ServerHttpRequest request,ServerHttpResponse response) {//第二步: 将body传入统一响应工具类中的默认成功响应return null;}
}

实现接口后的最原始状态

第二轮测试:带有@ControllerAdvice的测试

与删除@ControllerAdvice的测试的无差别

结论:@ControllerAdvice不具有覆盖默认接口类型的作用

第三轮测试:将实现中的boolean support 的返回值 false改为true

java">@ControllerAdvice
public class GlobalApiResult implements ResponseBodyAdvice<Object> {@Overridepublic boolean supports(MethodParameter returnType,Class<? extends HttpMessageConverter<?>> converterType) {//false -> true  用于测试,正式的时需要修改return true;}@Overridepublic Object beforeBodyWrite(Object body,MethodParameter returnType,MediaType selectedContentType,Class<? extends HttpMessageConverter<?>> selectedConverterType,ServerHttpRequest request,ServerHttpResponse response) {//第二步: 将body传入统一响应工具类中的默认成功响应return null;}
}

测试结果:无返回值,无响应类型

结论:boolean support 符合真理

真理:当第一个函数 support 的返回值为true,运行第二个函数beforeBodyWrite,当前第二个函数的返回值为null,所以无响应

第四轮测试:保持第三轮测试代码,删除注解@ControllerAdvice

测试结果:

结论:@ControllerAdvice 很重要,没有它,下面的代码无用,@ControllerAdvice提供了对全局统一响应支持

第五轮测试:在第一个函数上打上断点

测试结果:

但是我们可以根据测试找到对应它的作用

这个方法读取了接口的基本信息

第一个参数:返回类型

第二个参数:转换器类型

第一个参数的类型如图

总体来看,返回类型是指api接口的返回类型

第二个参数:

它展示的是MappingJackson2HttpMessageConverter类的具体路径,包

结论:

boolean support的两个形参

第一个参数:returnType 为接口的基本信息

第二个参数:ConverterType为MappingJackson2HttpMessageConverter的基本信息

第六轮测试:给beforBodywrite打上断点

测试过程:

第一步:发送请求至接口

support的形成拿到两个数值

第一个参数:returnType 为api接口的基本信息

第二个参数:ConverterType为MappingJackson2HttpMessageConverter的基本信息

没变化

返回值为ture进行下一步

java">    /*** HttpMessageConverter转换之前进行的操作* @param body 要转换的body* @param returnType 返回类型* @param selectedContentType 根据请求头协商的ContentType* @param selectedConverterType 自动选择的转换器类型* @param request 当前请求* @param response 当前响应* @return 修改后的响应内容*/

默认

我们一条一条对

首先body

和我们的mapper映射后的结果一模一样,换一句话说,它的结果就是我们调用查询数据库后的返回结果,用专业术语叫响应体,不专业的叫查询业务返回值

returnType和support一模一样

selectedContentType

selectedConverterType

翻译:查询内容类型,查询转换器类型

查询转换器类型和support一模一样

也就是说support的两个参数和beforeBodyWrite的一模一样

beforeBodyWrite多了四个参数

分别是响应体,内容类型,请求,响应

第七轮测试        

将响应体作为返回值

java">@ControllerAdvice
public class GlobalApiResult implements ResponseBodyAdvice<Object> {/*** 此Advice是否使用于该返回类型和Converter类型(意思是可以配置多个哦)* @param returnType 返回类型(这里可以获取很多东西, 别被名字误导了)* @param converterType 自动选择的转换器类型* @return 返回true表示将会走接下来的方法(beforeBodyWrite), 否则不会*/@Overridepublic boolean supports(MethodParameter returnType,Class<? extends HttpMessageConverter<?>> converterType) {//false -> true  用于测试,正式的时需要修改return true;}/*** HttpMessageConverter转换之前进行的操作* @param body 业务层接口返回值* @param returnType 返回类型* @param selectedContentType 根据请求头协商的ContentType* @param selectedConverterType 自动选择的转换器类型* @param request 当前请求* @param response 当前响应* @return 修改后的响应内容*/@Overridepublic Object beforeBodyWrite(Object body,MethodParameter returnType,MediaType selectedContentType,Class<? extends HttpMessageConverter<?>> selectedConverterType,ServerHttpRequest request,ServerHttpResponse response) {//第二步: 将body传入统一响应工具类中的默认成功响应return body;}
}

测试

结论:beforBodyWrite的返回值为控制类的响应体

总结:

@ControllerAdvice提供了对全局统一响应支持

supports与beforBodyWrite相关联


http://www.ppmy.cn/devtools/163323.html

相关文章

STM32微控制器为何不适合运行Linux系统的分析

STM32微控制器不适合运行Linux系统的原因可以从多个角度进行分析。首先&#xff0c;STM32属于ARM Cortex-M系列的微控制器&#xff0c;这类微控制器主要设计用于实时操作、低功耗应用、以及成本敏感型应用场景。相比之下&#xff0c;Linux系统需要较高的计算能力和资源&#xf…

MFC案例:利用双缓冲技术绘制顶点可移动三角形

案例目标&#xff1a;在屏幕上出现一个三角形&#xff0c;同时显示各顶点坐标&#xff0c;当用鼠标选择某顶点并拖动时&#xff0c;三角形随鼠标移动而变形。具体步骤为&#xff1a; 一、在VS2022上建立一个基于对话框的MFC应用&#xff0c;项目名称&#xff1a;DrawMovableTr…

C++大整数类的设计与实现

1. 简介 我们知道现代的计算机大多数都是64位的&#xff0c;因此能处理最大整数为 2 64 − 1 2^{64}-1 264−1。那如果是超过了这个数怎么办呢&#xff0c;那就需要我们自己手动模拟数的加减乘除了。 2. 思路 我们可以用一个数组来存储大数&#xff0c;数组中的每一个位置表…

流式抽样唯一元素方案设计

在高流量、源源不断的请求接口中&#xff0c;一个用户可能会发送多个请求&#xff0c;因此如何在这种情况下抽样并记录不重复用户的信息是一个重要的设计问题。本设计考虑多种方案&#xff0c;旨在通过有效的抽样策略来减少存储负担&#xff0c;同时确保数据的代表性。 确定性…

使用 Kettle (PDI) 连接 SQL Server 数据库

使用 Kettle (PDI) 连接 SQL Server 数据库 以下是配置步骤: 1. 下载 JDBC 驱动 Microsoft 官方驱动:下载地址 解压后获取 mssql-jdbc-<version>.jar 文件(或 jtds-x.x.x.jar 若使用 JTDS) 网络不好下面网址下载 mssql:mssql驱动下载jtds:jtds驱动下载Microsoft…

【Python爬虫(96)】从0到1:打造爬虫驱动的数据分析平台

【Python爬虫】专栏简介:本专栏是 Python 爬虫领域的集大成之作,共 100 章节。从 Python 基础语法、爬虫入门知识讲起,深入探讨反爬虫、多线程、分布式等进阶技术。以大量实例为支撑,覆盖网页、图片、音频等各类数据爬取,还涉及数据处理与分析。无论是新手小白还是进阶开发…

挖src实用脚本开发(二)

文章目录 技术原理代码实现一代码实现二总结 这篇文章记录cms识别脚本。 技术原理 1.使用在线平台识别&#xff0c;比如whatcms&#xff0c;fofa等 2.自己写脚本识别&#xff0c;但是指纹库麻烦&#xff0c;需要耗费大量精力 代码实现一 这里我使用的是whatcms接口&#xff0…

51单片机-按键

1、独立按键 1.1、按键介绍 轻触开关是一种电子开关&#xff0c;使用时&#xff0c;轻轻按开关按钮就可使开关接通&#xff0c;当松开手时&#xff0c;开关断开。 1.2、独立按键原理 按键在闭合和断开时&#xff0c;触点会存在抖动现象。P2\P3\P1都是准双向IO口&#xff0c;…