作者：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.1RELEASE
- 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作为回来类，然后在该方法中我们经过newResultResponse<>(result）即可。代码如下：
/**
* 不分页查询db1一切用户信息
*/
@GetMapping("/get-users1")
@ApiOperation(value = "不分页查询db1一切用户信息", notes = "不分页查询db1一切用户信息")
public ResultResponse<List<UserEntity>> getUserList1() {
return new ResultResponse<>(userService.getUsers1());
}
3.3Swagger测验
我们经过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.6Swagger测验恳求
我们拜访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【根底篇】
导读：SpringBoot 学习指南(附思维导图)
Spring Boot入门(01)：Spring Boot的斗争成长史
Spring Boot入门(02)：快速开发环境建立和项目启动
Spring Boot入门(03)： yaml、properties装备文件介绍及运用
Spring Boot入门(04)：多环境切换，实例演示
Spring Boot入门(05)：starter根底入门
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入门(27)：war包部
Spring Boot入门(28)：jar包布置
Spring Boot入门(29)：怎样完成热布置
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进阶(20)：装备Jetty容器
Spring Boot进阶(21)：装备Undertow容器
Spring Boot进阶(22)：Tomcat与Undertow容器功能比照剖析
Spring Boot进阶(23)：完成文件上传
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电子书籍、简历模板等海量材料。
