SpringBoot——全局异常捕获和自定义异常

时间:2022-07-25
本文章向大家介绍SpringBoot——全局异常捕获和自定义异常,主要内容包括其使用实例、应用技巧、基本知识点总结和需要注意事项,具有一定的参考价值,需要的朋友可以参考一下。

一、概述

介绍: 在我们开发项目的时候,有时候发生的异常是我们没有预料到的,则异常显示就会是Springboot的自定义显示。这样在使用来说很不友好,因此我们需要一个全局异常的捕获,进行一个格式化的输出,或者也可以预先定义我们自己的异常。以此实现对异常的优雅处理。(我此处只展示前后端分离的情况,返回json数据)

二、自定义异常

介绍: 自定义异常需要继承Exception或者RuntimeException,然后在异常处理器中进行执行异常的处理。代码如下:

/**
 * 自定义异常:业务异常
 *
 * @Author: xjf
 * @Date: 2019/12/1 22:20
 */
public class BusinessException extends RuntimeException {
    /**
     * 存放具体的异常信息
     */
    private String message;

    public BusinessException(String message) {

        this.message = message;
    }

    @Override
    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }
}

三、统一异常处理

**介绍:**此处需要一个全局异常的捕获处理,同时可以加入指定异常的自定义处理。

/**
 * 自定义异常处理
 *
 * @Author: xjf
 * @Date: 2019/12/1 22:14
 */
@RestControllerAdvice
public class CustomExceptionHandler {
    private Logger log = LoggerFactory.getLogger(CustomExceptionHandler.class);

    /**
     * 捕获全局异常,处理所有不可知的异常
     * @param e
     * @return
     */
    @ExceptionHandler(Exception.class)
    public ReturnResult handleGlobalException(Exception e){
        log.error("出现全局异常错误:{}", e.getMessage());

        e.printStackTrace();

        return ReturnResult.error(e.getMessage(), ReturnMsg.EXCEPTION1.getCode(),ReturnMsg.EXCEPTION1.getMsg());
    }

    /**
     * 捕获自定义异常
     * @param e
     * @return
     */
    @ExceptionHandler(BusinessException.class)
    public ReturnResult handleMyException(BusinessException e){
        log.error("出现自定义异常错误:{}", e.getMessage());

        e.printStackTrace();

        return ReturnResult.error(e.getMessage(), ReturnMsg.EXCEPTION5.getCode(), ReturnMsg.EXCEPTION5.getMsg());
    }
}