# SpringBoot全局异常处理 **Repository Path**: zhang_shaojie/exception ## Basic Information - **Project Name**: SpringBoot全局异常处理 - **Description**: SpringBoot全局异常处理 - **Primary Language**: Java - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 5 - **Created**: 2022-11-03 - **Last Updated**: 2022-11-03 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # 全局异常处理 ### 情境引入 针对Web项目来说,我们都知道,一般都是一个团队进行开发,而不会是一个人单打独斗,并且开发团队还有前后端的人员,那么有一定的规范就是必不可少的。 我们可能都遇到过一个问题,就是开发环境和正式上线的环境是有很大的差别的。开发环境是针对我们开发人员,而正式环境是一种以用户的角度来审视我们的整个系统。想想一个问题,如果遇到了我们在开发中没有碰到的异常,而用户却发现了,用户体验是不是会非常不好,而且这是我们的一个大忌。 既然如此,我们也知道,开发过程中,有如此多的异常可能会出现,那么里面就包含着我们已经考虑到了的,然而还有一些隐藏的异常却是我们可能忽视的,所以,为了能够将那些潜在的异常不被用户直接发现,而影响用户体验,这异常统一处理,就必不可少! ### 异常统一处理 定义:简单点说,就是针对我们系统中的异常,给予一定规范的处理结果。(比如,默认的情况,就是将异常堆栈信息直接打印到页面,然而这种是极其丑陋的) ### 开发环境 - windows 10 - IDEA + SpringBoot ### 开发步骤 #### 创建自定义异常 分析:在系统中,存在着系统异常和我们人为的自定义异常,所以,为了能够有效的针对不同异常进行处理,那么拥有我们自定义的异常类是非常有必要的。 ```java package cn.jian.exception.exception; import ResultEnum; import lombok.Data; /** * 自定义异常,为了区分系统异常和更方便系统的特定一些处理 * 在系统中,存在着系统异常和我们人为的自定义异常, * 所以,为了能够有效的针对不同异常进行处理,那么拥有我们自定义的异常类是非常有必要的。 * @author: wujian * @time: 2019/11/9 */ @Data public class MyException extends RuntimeException { /** * 错误码 */ private Integer code; public MyException(String message){ super(message); } /** * 构造器重载,主要是自己考虑某些异常自定义一些返回码 * @param code * @param message */ public MyException(Integer code, String message){ super(message); this.code = code; } /** * 构造器重载 * @param resultEnum */ public MyException(ResultEnum resultEnum){ super(resultEnum.getMsg()); this.code = resultEnum.getCode(); } } ``` #### 创建消息返回的包装实体 分析:对于后台返回给前端的数据来说,我们很多情况都是返回的JSON格式的数据(当然,并不是局限于这一种),那么JSON是一种格式化的形式,所以,我们应该有效的针对这样的形式来给予一定的返回规范,这样也方便前端对于我们返回数据的解析。 比如:很多情况一般是如下的格式: ```json { "code": 200, //通过状态码可以得到消息是否返回正常,然后再决定是否去解析data域的内容 "data": { //返回的数据内容 } "msg": success //返回的提示内容 } ``` 所以,我们可以定义如下的类: ```java package cn.jian.exception.entity; import lombok.Data; /** * 异常处理实体包装类 * @author: wujian * @time: 2019/11/9 */ @Data public class Result { /** * 返回码 */ private Integer code; /** * 返回消息 */ private String msg; /** * 返回数据 */ private T data; } ``` #### 定义一系列的枚举返回信息 分析:在系统中,我们应该有统一的某些编码对应某些内容,这样能够方便开发人员进行及时的处理。 ```java package cn.jian.exception.enums; /** * 自定义一些返回状态码,便于本系统的使用,自己先定义如下的,有需要就后续补充 * 在系统中,我们应该有统一的某些编码对应某些内容,这样能够方便开发人员进行及时的处理。 * @author: wujian * @time: 2019/11/9 */ public enum ResultEnum { /** * 成功.: 200 (因为http中的状态码200一般都是表示成功) */ SUCCESS(200, "成功"), /** * 系统异常. ErrorCode : -1 */ SystemException(-1, "系统异常"), /** * 未知异常. ErrorCode : 01 */ UnknownException(01, "未知异常"), /** * 服务异常. ErrorCode : 02 */ ServiceException(02, "服务异常"), /** * 业务错误. ErrorCode : 03 */ MyException(03, "业务错误"), /** * 提示级错误. ErrorCode : 04 */ InfoException(04, "提示级错误"), /** * 数据库操作异常. ErrorCode : 05 */ DBException(05, "数据库操作异常"), /** * 参数验证错误. ErrorCode : 06 */ ParamException(06, "参数验证错误"); private Integer code; private String msg; ResultEnum(Integer code, String msg){ this.code = code; this.msg = msg; } public Integer getCode(){ return code; } public String getMsg(){ return msg; } } ``` #### 定义消息返回工具类 分析:对于消息的返回,这是一个非常普通的工作,所以,我们可以将其封装一个工具类,能够进行有效代码的封装,减少多余的代码。 ```java package cn.jian.exception.utils; import Result; /** * 返回消息处理的工具类,主要是处理操作成功和失败的一些内容 * 对于消息的返回,这是一个非常普通的工作, * 所以,我们可以将其封装一个工具类,能够进行有效代码的封装,减少多余的代码。 * @author: wujian * @time: 2019/11/9 */ public class ResultUtil { /** * 操作成功的处理流程 * @param object * @return */ public static Result getSuccess(Object object){ Result result = new Result(); result.setCode(200); result.setMsg("成功"); result.setData(object); return result; } /** * 重载返回成功的方法,因为有时候我们不需要任何的消息数据被返回 * @return */ public static Result getSuccess(){ return getSuccess(null); } /** * 操作失败的处理流程 * @param code 错误码 * @param msg 错误消息 * @param o 错误数据(其实这个一般都不需要的,因为都已经返回失败了,数据都没必要返回) * @return */ public static Result getError(Integer code, String msg, Object o){ Result result = new Result(); result.setCode(code); result.setMsg(msg); result.setData(o); return result; } /** * 重载,操作失败的方法(因为操作失败一般都不需要返回数据内容) * @param code * @param msg * @return */ public static Result getError(Integer code, String msg){ return getError(code, msg, null); } } ``` ### 定义异常统一处理类(重点) 分析:这是如何实现异常统一处理的关键地方,而且我也将不同的处理情形,进行了分开注释,所以,大家一定可以认真的看代码,我相信你一定能够明白。 ```java package cn.jian.exception.handler; import Result; import ResultEnum; import MyException; import ResultUtil; import org.springframework.web.bind.annotation.ExceptionHandler; import org.springframework.web.bind.annotation.RestControllerAdvice; /** * 异常统一处理类,方便用户可以更加友好的看到错误信息 * @author: wujian * @time: 2019/11/9 */ @RestControllerAdvice public class GlobalExceptionHandler { /** * 处理系统内部异常 * @param e * @return */ @ExceptionHandler(Exception.class) public Result handleException(Exception e){ return ResultUtil.getError(ResultEnum.SystemException.getCode(), ResultEnum.ServiceException.getMsg()); } /** * 处理自定义异常 * @param e * @return */ @ExceptionHandler(MyException.class) public Result handleMyException(MyException e){ return ResultUtil.getError(e.getCode(), e.getMessage()); } } ``` #### 定义异常处理页面 分析:这个的话,其实主要是在正式环境才有,因为我们在测试环境的时候,一般都还是会将错误以JSON或者堆栈的格式显示在页面,而当上线的时候,那么就一定要有一个统一的错误页面,这样就能够让用户发现不了是系统出现了哪些问题。 ### 总结 异常统一处理,或许我们看起来实现非常简单,然而,其他它包含的思想却是一种大局思想,这是我们开发人员在开发过程中都应该关注的点,我们并不是只需要关注我们每个人开发的那点任务,而要以一种全局的角度去审视整个项目,这样也能够提升我们开问题的高度。 异常统一处理,是每个项目都存在的,只是可能实现的方式不一样而已,或者显示的效果不一样而已,这些都不是关键的地方。 异常统一处理这个问题,并不是很难,但是这个可以帮助我们延伸到其他的一些相关的开发层面的知识,比如: - 登录拦截 - 权限管理 - 日志管理 - 事务处理 - 数据控制和过滤 - 。。。 所以,我们应该学会从一个问题,发散的看到相关类似的问题,这样,我们的系统才会更加健壮,高效和可扩展性强。 > 源码地址:https://gitee.com/jianml/exception