Spring Boot如何实现统一数据返回
统一数据返回
一. 概念
其实统一数据返回是运用了AOP（对某一类事情的集中处理）的思维，简单概括就是在我们进行前后端数据交互的时候，能够让后端的数据进行统一的打包封装，返回给前端，便于前后端的数据处理。
二.实现统一数据返回
其实统一数据返回非常简单，在实现时要加入类注解@ControllerAdvice(这是一个表示控制通知的注解，在接下来的统一异常处理也要运用到)，在添加类注解后还要在实现ResponseBodyAdvice接口，然后重写接口的responseAdvice接口和beforeBodyWriter方法即可实现。
- 添加类注解@ControllerAdvice，实现接口ResponseBodyAdvice
- 重写responseAdvice方法
- 重写beforeBodyWriter方法
- 特殊数据类型特殊处理（String）
2.1 重写responseAdvice方法
responseAdvice方法如下：
@Override
public boolean supports(MethodParameter returnType, Class converterType) {
return true;
}可以看到，重写该方法主要返回的是Boolean数据类型，返回false表示不执行统一返回，返回true表示对于所有的数据类型都进行数据统一返回。
supports方法:判断是否要执行beforeBodyWrite方法.true为执行,false不执行.通过该方法可以
选择哪些类或哪些方法的response要进行处理,其他的不进行处理
2.2 重写beforeBodyWriter方法
beforeBodyWriter方法如下：
beforeBodyWrite方法:对response方法进行具体操作处理
其中的参数body最为重要，如果想要对统一后的数据进行格式的转换，直接转换body的格式就行，因为这里的body代指了所有的数据格式。
三. 特殊类型-String的处理
在经过多次不同的数据类型测试后发现，其它类型就可以顺利返回，而String类型却返回不正确。
对于String的数据类型如果想要返回，我们要先引入ObjectMapper，通过调用ObjeceMapper的writeValueAsString()方法来把body的数据格式给转换成Json格式，然后再次进行统一返回即可。
进行数据转换的代码如下：
private static ObjectMapper mapper = new ObjectMapper();
@Override
public Object beforeBodyWrite(Object body, MethodParameter returnType,MediaType selectedContentType, Class selectedConverterType,
ServerHttpRequestrequest, ServerHttpResponse response) {
//如果返回结果为String类型, 使⽤SpringBoot内置提供的Jackson来实现信息的序列化
if (body instanceof String){
return mapper.writeValueAsString(Result.success(body));
}
}四. 全部代码
import com.example.demo.model.Result;
import com.fasterxml.jackson.databind.ObjectMapper;
import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
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;
@Slf4j
@ControllerAdvice
public class ResponseAdvice implements ResponseBodyAdvice {
private static ObjectMapper mapper = new 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) {
//返回结果更加灵活
if (body instanceof Result){
return body;
}
//如果返回结果为String类型, 使⽤SpringBoot内置提供的Jackson来实现信息的序列化
if (body instanceof String){
return mapper.writeValueAsString(Result.success(body));
}
return Result.success(body);
}
}- 方便前端程序员更好的接收和解析后端数据接口返回的数据
- 降低前端程序员和后端程序员的沟通成本,按照某个格式实现就可以了,因为所有接口都是这样返回
的. - 有利于项目统⼀数据的维护和修改.
- 有利于后端技术部门的统⼀规范的标准制定,不会出现稀奇古怪的返回内容.
相关文章
SpringMVC中的ConversionServiceExposingInterceptor工具类解析
这篇文章主要介绍了SpringMVC中的ConversionServiceExposingInterceptor工具类解析,ConversionServiceExposingInterceptor是Spring MVC的一个HandlerInterceptor,用于向请求添加一个属性,需要的朋友可以参考下2023-12-12
这篇文章主要为大家介绍了java开发使用StringUtils.split避坑详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪2022-11-11
这篇文章主要介绍了mybatis-plus的添加与修改方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2022-06-06
springboot2 jackson实现动态返回类字段方式
这篇文章主要介绍了springboot2 jackson实现动态返回类字段方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教2024-08-08
今天小编就为大家分享一篇关于Java注解与反射原理说明，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧2019-03-03
解决mybatis plus 分页查询有条数,total和pages都是零的问题
这篇文章主要介绍了解决mybatis plus 分页查询有条数,total和pages都是零的问题，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2020-11-11
spring+hibernate 两种整合方式配置文件的方法
本篇文章主要介绍了spring+hibernate 两种整合方式配置文件的方法，主要有两种方式 1、注解方式 2、xml方式实现，有兴趣的可以了解一下。2017-04-04
并查集是一种用来管理元素分组情况的数据结构。并查集可以高效地进行如下操作。本文将通过Java实现并查集，感兴趣的小伙伴可以了解一下2022-01-01
这篇文章主要介绍了springboot文件上传保存路径的问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2021-09-09
单点登录是一种统一认证和授权机制，指在多个应用系统中，用户只需要登录一次就可以访问所有相互信任的系统，不需要重新登录验证，这篇文章主要介绍了SpringBoot+JWT实现单点登录解决方案,需要的朋友可以参考下2023-07-07
最新评论