Spring Boot 如何返回统一结果包装？项管说这你必须得会！
👨🎓作者：bug菌 ✏️博客：CSDN、掘金、infoQ、51CTO等 🎉简介：CSDN|阿里云|华为云|51CTO等社区博客专家，历届博客之星Top30，掘金年度人气作者Top40，51CTO年度博主Top12，掘金 | InfoQ | 51CTO等社区优质创作者，全网粉丝合计15w+ ；硬核微信公众号「猿圈奇妙屋」，欢迎你的加入！免费白嫖最新BAT互联网公司面试题、4000G pdf电子书籍、简历模板等海量资料 ... ✍️温馨提醒：本文字数：1999字, 阅读完需：约 5 分钟
🏆本文收录于《Spring Boot从入门到精通》，专门攻坚指数提升。
本专栏致力打造最硬核 Spring Boot 从零基础到进阶系列学习内容，🚀均为全网独家首发，打造精品专栏，专栏持续更新中…欢迎大家订阅持续学习。
环境说明：Windows10 + Idea2021.3.2 + Jdk1.8 + SpringBoot 2.3.1.RELEASE
1. 前言🔥
现如今是前后端分离的时代，如果没有统一的返回格式，给前端的结果各式各样，估计前端小伙伴就要骂街了。我们想对自定义异常抛出指定的状态码排查错误，对系统的不可预知的异常抛出友好一点的异常信息。我们想让接口统一返回一些额外的数据，例如接口执行的时间等等。
所以嘛，不管是日常和前端小伙伴对接，还是和其他部门进行接口对接，都应该返回固定的格式。本文给出一个简单通用的返回格式，小伙伴们有需求，可以基于此版本根据自己的业务需求丰富返回格式。
统一结果的返回数据格式如下 ，有兴趣的小伙伴们可以继续往下看SpringBoot是怎么来实现的。演示如下：
{
"code": 200,
"msg": "成功",
"serverTime": 1686726816292,
"data": [
{
"id": 1,
"name": "刘亦菲",
"age": 70,
"sex": "女",
"address": "上海闵行",
"describes": "这是db1的用户",
"image": "bug菌.jpg"
}
],
"success": true
}
那么，具体如何封装包装呢？这将又会是干货满满的一期，全程无尿点不废话只抓重点教，具有非常好的学习效果，拿好小板凳准备就坐！希望学习的过程中大家认真听好好学，学习的途中有任何不清楚或疑问的地方皆可评论区留言或私信，bug菌将第一时间给予解惑，那么废话不多说，直接开整！Fighting！！
2. 环境说明🔥
本地的开发环境：
- 开发工具：IDEA 2021.3
- JDK版本： JDK 1.8
- Spring Boot版本：2.3.1 RELEASE
- Maven版本：3.8.2
3. 正文🔥
看了如下格式演示，想必有的小伙伴就很好奇，这到底是如何实现的？很简单，接下来我就带着大家手把手教学。
3.1 定义统一返回格式类
首先我们先定义好一个统一的返回格式类，代码如下：
/**
* 接口返回结果，不带对象的
*/
@ApiModel(value = "基础返回信息", description = "基础返回信息")
public class BaseResponse implements Serializable {
private static final long serialVersionUID = -7671756385477179547L;
/**
* api返回码
*/
@ApiModelProperty("返回编码")
protected Integer code = ResultEnum.SUCCESS.getKey();
/**
* api返回消息
*/
@ApiModelProperty("返回信息")
protected String msg = ResultEnum.SUCCESS.getValue();
/**
* 服务器时间
*/
@ApiModelProperty("系统时间")
protected long serverTime = System.currentTimeMillis();
public BaseResponse() {
}
public BaseResponse(IEnum iEnum) {
this.code = iEnum.getKey();
this.msg = iEnum.getValue();
}
public BaseResponse(String msg) {
this.msg = msg;
}
public Integer getCode() {
return code;
}
public void setCode(Integer code) {
this.code = code;
}
public String getMsg() {
return msg;
}
public void setMsg(String msg) {
this.msg = msg;
}
public long getServerTime() {
return serverTime;
}
public void setServerTime(long serverTime) {
this.serverTime = serverTime;
}
/**
* 是否成功
*/
@ApiModelProperty("是否成功")
public boolean isSuccess() {
return ResultEnum.SUCCESS.getKey().equals(code);
}
}
如上我们是定义了一个不带对象返回的同一类，如果我们要返回具体的数据对象呢？那我们再创建一个带对象返回的类即可。代码如下：
/**
* 接口返回结果，带对象
*/
@ApiModel(value = "带内容的返回信息",description = "带内容的返回信息")
public class ResultResponse<T> extends BaseResponse {
@ApiModelProperty("返回内容")
private T data;
public T getData() {
return data;
}
public void setData(T data) {
this.data = data;
}
public ResultResponse() {
}
public ResultResponse(T data) {
this.data = data;
}
public ResultResponse(IEnum iEnum) {
super(iEnum);
}
}
3.2 定义一个Controller
接下来我们来演示下如何使用它。我们其实只需要将ResultResponse作为返回类，然后在该方法中我们通过new ResultResponse<>(result）即可。代码如下：
/**
* 不分页查询db1所有用户信息
*/
@GetMapping("/get-users1")
@ApiOperation(value = "不分页查询db1所有用户信息", notes = "不分页查询db1所有用户信息")
public ResultResponse<List<UserEntity>> getUserList1() {
return new ResultResponse<>(userService.getUsers1());
}
3.3 Swagger测试
我们通过Swagger来请求一下，我们可以看到。
这样我们就生成了统一的返回包装，是不是看起来就优雅多了。
我们再来测试一下，如果返回报错，又该是如何？
我们还是定义一个请求，我们直接通过抛出异常试试。
@GetMapping("/get-users1")
public ResultResponse<List<UserEntity>> getUserList1() {
return new ResultResponse<>(ErrorCodeEnum.SYSTEM_ERROR);
}
我们请求Swagger来查阅下结果。
结果依旧如此，未曾有改变，证明无论是正常返回还是异常抛出，皆不会影响。
但是，你们有没有发现，这样的代码入侵性强，所有的返回结果都要处理。那有没有办法能一劳永逸的，每次的请求都会自动将其包装类修饰后返回呢？答案肯定是有的，spring拥有各种切面的支持，让我们看看如何代码无侵入的实现这个功能。
3.4 切面处理，代码无侵入
我们来创建一个配置类，添加@RestControllerAdvice注解，代码如下：
import com.alibaba.fastjson.JSON;
import com.example.demo.vo.ResultResponse;
import lombok.extern.slf4j.Slf4j;
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;
import javax.validation.constraints.NotNull;
@Slf4j
@RestControllerAdvice
public class RestResponseAdvice implements ResponseBodyAdvice<Object> {
@Override
public boolean supports(@NotNull MethodParameter returnType,
@NotNull Class<? extends HttpMessageConverter<?>> converterType) {
return true;
}
/**
* 返回结果包装统一返回格式
*
* @return 包装后的返回结果
*/
@Override
public Object beforeBodyWrite(Object body,
@NotNull MethodParameter returnType,
@NotNull MediaType selectedContentType,
@NotNull Class<? extends HttpMessageConverter<?>> selectedConverterType,
@NotNull ServerHttpRequest request,
ServerHttpResponse response) {
// 指定返回的结果为application/json格式
// 不指定，String类型转json后返回Content-Type是text/plain;charset=UTF-8
response.getHeaders().setContentType(MediaType.APPLICATION_JSON);
ResultResponse result = new ResultResponse(body);
// 若返回类型是ResultJson，则不进行修改
if (body == null) {
if (returnType.getParameterType().isAssignableFrom(String.class)) {
return JSON.toJSONString(result);
}
} else if (body instanceof ResultResponse) {
return body;
} else if (body instanceof String) {
return JSON.toJSONString(result);
}
return result;
}
}
接下来，我们来测试一下，直接定义一个不带ResultResponse类包装的请求。
3.5 定义一个不带返回格式的Controller
Controller代码如下：
/**
* 根据id查询区分性别返回不同结构体内容
*/
@GetMapping("/get-user-for-id")
@ApiOperation(value = "根据id查询区分性别返回不同结构体内容", notes = "根据id查询区分性别返回不同结构体内容")
public List<UserEntity> getUserInfo(@RequestParam Integer id) {
return userMapper.getUserByIdFor(id);
}
如上明显我是直接返回了，不带 ResultResponse类包装，我们来期待一下，切面是否生效。
3.6 Swagger测试请求
我们访问Swagger地址：http://localhost:8080/doc.html，找到我们定义的请求。
很明显，切面完全是设置上了，被统一返回体封装。这样统一返回格式就完成了，对代码没有的侵入，原来的代码该怎么写还是怎么写，是不是很nice很棒呢。
3.7 @RestControllerAdvice
使用@RestControllerAdvice，常做的两个功能的实现有如下。
- 返回统一格式的结果。
- 异常统一处理。
如上场景功能我上期也做了定义GlobalExceptionHandler全局异常处理器，同样是使用了@RestControllerAdvice注解进行功能点实现，这里我就不详细介绍了，有想法的小伙伴可以前去观摩一下。
3.8 小结
好啦，本文就到就要接近尾声啦，我们来简单的做个总结，主要介绍了以下内容：
- 为什么要返回统一的结果信息？
- 手动封装统一的返回信息结构
- 使用@RestControllerAdvice自动封装返回信息
- 简单介绍@RestControllerAdvice注解
... ...
ok，以上就是我这期的全部内容啦，如果还想学习更多，你可以看看如下的往期热文推荐哦，每天积累一个奇淫小知识，日积月累下去，你一定能成为令人敬仰的大佬。
「赠人玫瑰，手留余香」，咱们下期拜拜~~
4. 热文推荐💭
为了便于同学快速定位文章学习，熬夜几天终于整理出了【基础篇】及【进阶篇】专栏的文章及有效地址，同学们敬请吩咐bug菌吧。
目前基础篇已完结75篇+，进阶篇已完结45篇+，两专栏都在持续更新中；生命不息，更新不止，加油卷起来吧，同学们。部分文章总结如下：
4.1 Spring Boot【基础篇】
Spring Boot入门(01)：Spring Boot的奋斗成长史
Spring Boot入门(02)：快速开发环境搭建和项目启动
Spring Boot入门(03)： yaml、properties配置文件介绍及使用
Spring Boot入门(06)：Spring Boot常用注解大全
Spring Boot入门(07)：整合 MySQL 和 Druid数据源(两万字教学)
Spring Boot入门(08)：整合Mybatis访问MySQL实现增删改查
Spring Boot入门(09)：使用MyBatis的XML配置方式访问MySQL实现增删改查
Spring Boot入门(10)： mybatis之xml映射文件＞、＜=等特殊符号写法
Spring Boot入门(11)：Spring Boot 整合 JPA
Spring Boot入门(12)：整合Mybatis-Plus mybatis-plus实现接口增删改查
Spring Boot入门(13)： Mybatis-Plus之条件构造器使用手册
Spring Boot入门(14)： mybatis-plus之如何自定义sql
Spring Boot入门(15)：Spring Boot 整合 MyBatis-Plus AutoGenerator 自动生成项目骨架代码
Spring Boot入门(16)：Spring Boot整合Swagger-UI实现在线API文档
Spring Boot入门(17)：Spring Boot整合Knife4j，美化强化丑陋的Swagger
Spring Boot入门(18)：Spring Boot静态资源映射
Spring Boot入门(19)：Spring Boot 整合 Thymeleaf 模板引擎，开发Web页面
Spring Boot入门(20)：实现多数据源配置，开箱即用
Spring Boot入门(21)：整合Log4j2以及配置详解
Spring Boot入门(22)：整合LogBack 实现日志文件本地保存
Spring Boot入门(23)：Spring Boot基于AOP拦截日志
Spring Boot入门(24)：Spring Boot事务
Spring Boot入门(25)：过滤器、拦截器、监听器对比及使用场景
Spring Boot入门(26)：实现邮件发送简单邮件、附件邮件、嵌入资源(图片)邮件、模板邮件等
Spring Boot入门(30)：Windows安装Redis客户端？你玩过么
4.2 Spring Boot【进阶篇】
Spring Boot进阶(01)：Spring Boot 集成 Redis，实现缓存自由
Spring Boot进阶(02)：使用Validation进行参数校验
Spring Boot进阶(03)：如何使用MyBatis-Plus实现字段的自动填充
Spring Boot进阶(04)：如何使用MyBatis-Plus快速实现自定义sql分页
Spring Boot进阶(05)：Spring Boot 整合RabbitMq，实现消息队列服务
Spring Boot进阶(06)：Windows10系统搭建 RabbitMq Server 服务端
Spring Boot进阶(07)：集成EasyPoi，实现Excel/Word的导入导出
Spring Boot进阶(08)：集成EasyPoi，实现Excel/Word携带图片导出
Spring Boot进阶(09)：集成EasyPoi，实现Excel文件多sheet导入导出
Spring Boot进阶(10)：集成EasyPoi，实现Excel模板导出成PDF文件
Spring Boot进阶(11)：Spring Boot 如何实现纯文本转成.csv格式文件？
Spring Boot进阶(12)：Spring Boot 如何获取Excel sheet页的数量？
Spring Boot进阶(13)：Spring Boot 如何获取@ApiModelProperty(value = “序列号“, name = “uuid“)中的value值name值？
Spring Boot进阶(14)：Spring Boot 如何手动连接库并获取指定表结构？一文教会你
Spring Boot进阶(15)：根据数据库连接信息指定分页查询表结构信息
Spring Boot进阶(16)：Spring Boot 如何通过Redis实现手机号验证码功能？
Spring Boot进阶(17)：Spring Boot如何在swagger2中配置header请求头等参数信息
Spring Boot进阶(18)：SpringBoot如何使用@Scheduled创建定时任务？
Spring Boot进阶(19)：Spring Boot 整合ElasticSearch
Spring Boot进阶(21)：配置Undertow容器
Spring Boot进阶(22)：Tomcat与Undertow容器性能对比分析
Spring Boot进阶(24)：如何快速实现多文件上传？
Spring Boot进阶(25)：文件上传的单元测试怎么写?
Spring Boot进阶(26)：Mybatis 中 resultType、resultMap详解及实战教学
Spring Boot进阶(27)：Spring Boot 整合 kafka(环境搭建+演示)
Spring Boot进阶(28)：Jar包Linux后台启动部署及滚动日志查看，日志输出至实体文件保存
Spring Boot进阶(29)：如何正确使用@PathVariable，@RequestParam、@RequestBody等注解？不会我教你，结合Postman演示
Spring Boot进阶(30)：@RestController和@Controller 注解使用区别，实战演示
...
若想学习更多，可以参考这篇专栏总结《2023最新首发，全网最全 Spring Boot 学习宝典(附思维导图)》，本专栏致力打造最硬核 Spring Boot 进阶系列学习内容，🚀均为全网独家首发，打造精品专栏，专栏持续更新中。欢迎大家订阅持续学习。
在入门及进阶之途，我必助你一臂之力，系统性学习，从入门到精通，带你不走弯路，直奔终点；投资自己，永远性价比最高，都这么说了，你还不赶紧来学？？
本文涉及所有源代码，均已上传至github开源，供同学们一对一参考，github.com/luoyong0603… ，同时，原创开源不易，欢迎给个star🌟，想体验下被加Star的感jio，非常感谢 ❗
5. 文末💭
我是bug菌，CSDN | 阿里云 | 华为云 | 51CTO 等社区博客专家，历届博客之星Top30，掘金年度人气作者Top40，51CTO年度博主Top12，掘金 | InfoQ | 51CTO等社区优质创作者，全网粉丝合计15w+ ；硬核微信公众号「猿圈奇妙屋」，欢迎你的加入！免费白嫖最新BAT互联网公司面试题、4000G pdf电子书籍、简历模板等海量资料。
