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. 前言🔥
今天和大家讨论的是Spring Boot如何统一处理异常。这里先说一下我们为什么需要全局统一处理异常？其实理由很简单，因为程序在运行的过程中，不可避免会产生各种各样的错误。比如说用户传过来的参数不正确，无法连接上数据库，或者在计算某个任务的时候超时等。所以我们一般需要合理的抛出各种异常信息。这些异常信息，一旦不处理，前端就会得到一个500的服务器内部错误，直接展示非常的不友好不优雅，所以我们需要将这些异常捕获，并告知前端，到底错在了哪里。另一个问题是，我们不可能直接将完整的异常信息返回，因为可能涉及到一些内部的重要信息，不能随意泄露，所以我们还需要对异常信息进行过滤和转换，值给前端返回可读的，简洁的，准确的说明信息。
这就是为什么我们需要全局异常处理。
这将又会是干货满满的一期，全程无尿点不废话只抓重点教，具有非常好的学习效果，拿好小板凳准备就坐！希望学习的过程中大家认真听好好学，学习的途中有任何不清楚或疑问的地方皆可评论区留言或私信，bug菌将第一时间给予解惑，那么废话不多说，直接开整！Fighting！！
2. 环境说明🔥
本地的开发环境：
- 开发工具：IDEA 2021.3
- JDK版本： JDK 1.8
- Spring Boot版本：2.3.1 RELEASE
- Maven版本：3.8.2
3. 正文🔥
这里bug菌提供的一种思路是使用全局异常处理器。全局异常处理器不仅能够捕获默认的异常，还能够捕获各种自定义异常。一个简单的全局异常处理器代码如下：
3.1 定义全局异常处理器
GlobalExceptionHandler.java
@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {
private Map<String, Object> getResult(ErrorCodeEnum e, boolean status) {
Map<String, Object> map = new HashMap<>();
map.put("success", status);
map.put("code", e.getKey());
map.put("msg", e.getValue());
return map;
}
/**
* 参数校验不通过
*
* @param e 异常信息
* @param request 请求信息
*/
@ExceptionHandler(value = ParamsException.class)
@ResponseStatus(HttpStatus.OK)
public Map<String, Object> handleObjectExistException(ParamsException e,
HttpServletRequest request) {
return getResult(ErrorCodeEnum.PARAM_EXIST_EXCEPTION, false);
}
/**
* 用户校验不通过
*
* @param e 异常信息
* @param request 请求信息
*/
@ResponseStatus(HttpStatus.OK)
@ExceptionHandler(value = TokenExpireException.class)
public Map<String, Object> handle(TokenExpireException e, HttpServletRequest request) {
return getResult(ErrorCodeEnum.USER_NOT_LOGIN, false);
}
/**
* 全局异常处理
*
* @param e 异常信息
* @param request 请求信息
*/
@ResponseStatus()
@ExceptionHandler(value = Throwable.class)
public Map<String, Object> handle(Exception e, HttpServletRequest request) {
return getResult(ErrorCodeEnum.SYSTEM_ERROR, false);
}
}
这里我对所有的异常信息返回结果都做了统一的处理，只返回success，code，msg三个字段。在内部封装了一个getResult私有方法，便于统一处理，然后分别使用不同的方法处理不同的异常信息，比如ParamsException，TokenExpireException，SystemRunningException等
以上的这仨皆属于自定义异常，代码如下：
3.2 定义参数异常ParamsException类
这里先定义参数异常的信息扑捉，思路也比较简单，就是除了msg之外，不需要接收code，只便于更加灵活的实现返回值数据。
public class ParamsException extends RuntimeException {
private static final long serialVersionUID = 1L;
private String message;
public ParamsException() {
}
public ParamsException(String msg) {
this.message = msg;
}
public ParamsException(ErrorCodeEnum e) {
this.message = e.getValue();
}
@Override
public String getMessage() {
return message;
}
public void setMessage(String message) {
this.message = message;
}
}
3.3 定义异常TokenExpireException类
这里我们再来定义一个扑捉token用户登陆信息过期的异常类，目的是更直接用于相关token异常信息的捕捉。由于我们直接也是定义了默认的token Error错误码枚举，顾我们也是只需要定义msg信息的接收即可，但如果你都想自定义，那你就把对应的code、success、msg都定义赋值也行，具体代码如下：
package com.example.demo.exception;
import com.example.demo.enums.ErrorCodeEnum;
/**
* 用户登陆信息过期异常
*/
public class TokenExpireException extends RuntimeException {
private static final long serialVersionUID = 1L;
private String message;
public TokenExpireException() {
}
public TokenExpireException(String msg) {
this.message = msg;
}
public TokenExpireException(ErrorCodeEnum e) {
this.message = e.getValue();
}
@Override
public String getMessage() {
return message;
}
public void setMessage(String message) {
this.message = message;
}
}
3.4 定义一个ExceptionController测试
这里我们写两个接口直接模拟异常返回，查阅具体的异常信息是否被正常捕捉，然后其他的测试你们就自己玩啦，这里给大家举个例子。
3.4.1 测试参数异常
我们直接定义一个Get请求，然后设置一个参数，我们在传值的过程中，我们直接传空，我们即可验证是否能捕获参数异常的全局信息返回。
@RestController
@RequestMapping("/exception")
@Api(tags = "全局异常测试模块", description = "全局异常测试模块")
public class ExceptionController {
@Autowired
private UserService userService;
/**
* 根据用户id查询用户信息
*/
@GetMapping("/find-user-by-id")
@ApiOperation(value = "根据用户id查询用户信息", notes = "根据用户id查询用户信息")
public ResultResponse<UserEntity> saveUser(@RequestParam("userId") String userId) throws ParamsException {
if (StringUtils.isBlank(userId)) {
throw new ParamsException(PARAM_EXIST_EXCEPTION);
}
return new ResultResponse<>(userService.getById(userId));
}
}
3.4.2 Swagger请求校验
重启项目，我们将userId参数传空格，我们直接请求，可以看看接口返回体具体是啥内容？
可以看到，正是我们展示的PARAM_EXIST_EXCEPTION(101001, "参数异常")这句，我们也可以自定义，也可以采用默认的提示，成功的并统一处理了返回结果。
3.4.3 测试token异常
测试代码如下，仅供参考：
@GetMapping("/login")
@ApiOperation(value = "登录", notes = "登录")
public ResultResponse<Boolean> login(@RequestParam("token") String token) throws TokenExpireException {
throw new TokenExpireException();
}
3.4.4 Swagger请求校验
重启项目后请求一遍，可以看下接口的返回值如下：
可以发现，我们成功的捕获到了默认的Exception异常和自定义的TokenExpireException
异常，并统一处理了返回结果。
两轮测试结果比较令人满意，希望能帮助到大家，剩下的测试或者自定义异常，你们可以大胆发挥，这里我就不一一赘述啦。
3.5 附上接口返回错误码枚举类
具体代码如下，仅供参考：
/**
* 接口返回错误码枚举
*/
public enum ErrorCodeEnum implements IEnum {
/* 系统异常 */
SYSTEM_RUNNING(100000, "系统运行异常"),
SYSTEM_ERROR(101000, "系统未知异常"),
PARAM_EXIST_EXCEPTION(101001, "参数异常"),
/* token相关 */
TOKEN_IS_EMPTY(102001, "该请求没有携带token！请先获取token"),
TOKEN_IS_INVALID(102002, "token失效，请重新登录！"),
TOKEN_IS_ERROR(102003, "非法token！请重新登录！"),
USER_NOT_LOGIN(103006, "请先登录"),
;
private Integer key;
private String value;
ErrorCodeEnum(Integer key, String value) {
this.key = key;
this.value = value;
}
@Override
public Integer getKey() {
return this.key;
}
@Override
public String getValue() {
return this.value;
}
}
... ...
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电子书籍、简历模板等海量资料。
