SpringBoot入门学习笔记-8-全局异常捕获处理

Bill老罗

已于 2023-06-19 21:58:53 修改

阅读量577

点赞数

分类专栏： SpringBoot 入门学习笔记文章标签： spring boot 学习笔记

于 2023-06-19 21:29:07 首次发布

本文链接：https://blog.csdn.net/gary_royal/article/details/131292368

版权

SpringBoot 入门学习笔记专栏收录该内容

19 篇文章 1 订阅

订阅专栏

通过ControllerAdvice + GlobalExceptionHandler 实现全局异常捕并处理。

一、为什么需要全局异常捕获。

有很多好处。

比如，我们在写controller时，调用了很多方法，有可能在未知的哪一层就出错了，因未try catch导致系统崩了。而，如果我们做了全局处理，只需要是从controller入口进入的，都可以捕获，不用再担心controller忘写try catch了。

再比如，当外部访问错误的接口地址时，会返回一个Springboot自带的错误，格式如下：

{
  "timestamp": "2023-06-19T09:35:50.724+00:00",
  "status": 404,
  "error": "Not Found",
  "message": "No message available",
  "path": "/post/results21"
}

这个格式看起来很清楚，但可能和我们定义的返回消息不统一的。比如我们正常的请求返回的是

{"code":1000,msg:"OK",9999}

因为格式不统一，会缺少字段，给调用方造成困难。比如缺少code字段,msg和message不统一。

再比如，我们代码可能有一些非编译错误，像a/0这种0不能为除数会报错等。如果不try catch那程序会报错并响应一些未知的数据返回给外部调用者。

二、@ControllerAdvice 注解声明全局Exception处理类

@ControllerAdvice
public class GlobalExceptionHandler {

    private static final Logger logger = LoggerFactory.getLogger("GlobalExceptionHandler");

    /**
     * 处理Controller层通用 BusinessException 异常
     * 可以防止Controller未处理异常的程序中止，进行全局捕获
     * @ExceptionHandler(value = Exception.class) 可以定义多个。比如BusinessExceptionHandler,ServicesExceptionHandler
     */
    @ResponseBody
    @ExceptionHandler(value = Exception.class)
    public ResultsObj exceptionHandler(Exception e) {
        logger.error("全局异常：",e);
        return ResultsObj.fail(e.getMessage());
    }

}

三、验证。

比如，我们以除数不能为0的示例，看一下未配置前的返回：

配置以后，返回如下：

同时，在控制台日志文件，会输出：四、通常，我们会定义一个业务异常类，抛出业务异常。

通过业务异常类和普通异常类的区分，来实现更加好友的响应处理。

定义业务异常，只需要在类上继承 Exception就行了，比如我们可以继承RuntimeException。

@Data
@AllArgsConstructor
@NoArgsConstructor
public class BusinessException extends RuntimeException{

    private Integer code;
    private String msg;


    // 业务异常类，可能有很多code,我们定义一个按名称去查找的方法。
    public static BusinessException byName(String name){
        MyHttpEnum httpEnum=MyHttpEnum.byName(name);
        return new BusinessException(httpEnum.getCode(), httpEnum.getMsg());
    }
}

那么，在异常处理中，我们就可以进行处理了：

   @ResponseBody
    @ExceptionHandler(value = BusinessException.class)
    public ResultsObj BizExceptionHandler(BusinessException e) {
        logger.error("全局业务异常：",e);
        return ResultsObj.fail(e.getMsg());
    }

那么，当我们需要抛出业务时，可以这样处理：

    @PostMapping("/results1")
    public ResultsObj post5(@RequestBody HashMap map){
        // @RequestParam 定义参数
        logger.info("logger info test");
        Integer i =10,J=0;
        try{
        J = i/(i -10);
        }
        catch (Exception e){

            throw BusinessException.byName(MyHttpEnum.NOTZERO.name());
        }

        return ResultsObj.success(J);
    }