Spring Boot处理全局统一异常的两种方法与区别

实现方式

• 第一种：使用@ControllerAdvice和@ExceptionHandler注解
• 第二种: 使用ErrorController类来实现。

第一种：使用@ControllerAdvice和@ExceptionHandler注解

注解@ControllerAdvice表示这是一个控制器增强类，当控制器发生异常且符合类中定义的拦截异常类，将会被拦截。

@Slf4j
@ControllerAdvice
public class ExceptionHandle {

    /**
     * 全局异常捕捉处理
     * 判断错误是否是已定义的已知错误，不是则由未知错误代替，同时记录在log中
     *
     * @param e Exception
     * @return
     */
    @ExceptionHandler(value = Exception.class)
    @ResponseBody
    public static Result exceptionGet(Exception e) {
        // 异常处理逻辑
        if (e instanceof DescribeException) {
            DescribeException MyException = (DescribeException) e;
            return ResultUtil.error(MyException.getCode(), MyException.getMessage());
        } else if (e instanceof BusinessExceptions) {
            return ResultUtil.error(((BusinessExceptions) e).getCode(), e.getMessage());
        }

        log.error("系统异常:", e);
        return ResultUtil.error(ExceptionEnum.UNKNOW_ERROR);
    }
}

/**
 * @description : 异常处理类
 */
@Data
public class DescribeException extends RuntimeException {
    private Integer code;

    /**
     * 继承exception，加入错误状态值
     *
     * @param exceptionEnum
     */
    public DescribeException(ExceptionEnum exceptionEnum) {
        super(exceptionEnum.getMsg());
        this.code = exceptionEnum.getCode();
    }

    /**
     * 自定义错误信息
     *
     * @param message
     * @param code
     */
    public DescribeException(String message, Integer code) {
        super(message);
        this.code = code;
    }

/**
 * @description : 异常处理
 * @modified :
 */
public class BusinessExceptions extends RuntimeException {
    private int code = 200;

    public static BusinessExceptions build(String msg){
        return new BusinessExceptions(msg);
    }

    public BusinessExceptions(String msg) {
        super(msg);
    }

    public int getCode() {
        return code;
    }
}

第二种: 使用ErrorController类来实现。

系统默认的错误处理类为BasicErrorController

这里编写一个自己的错误处理类，上面默认的处理类将不会起作用。

getErrorPath()返回的路径服务器将会重定向到该路径对应的处理类，本例中为error方法。

@Slf4j
@RestController
public class HttpErrorController implements ErrorController {
    private final static String ERROR_PATH = "/error";

    @ResponseBody
    @RequestMapping(ERROR_PATH)
    public Result error(HttpServletRequest request, HttpServletResponse response) {
        log.info("访问/error" + " 错误代码：" + response.getStatus());
        return ResultUtil.error(response.getStatus(), "HttpErrorController error:" + response.getStatus());
    }
}

 Result和ResultUtil

public class ResultUtil {
    /**
     * 返回成功，传入返回体具体出參
     *
     * @param object
     * @return
     */
    public static Result success(Object object) {
        Result result = new Result();
        result.setStatus(0);
        result.setMsg("success");
        result.setData(object);
        return result;
    }

    /**
     * 提供给部分不需要出參的接口
     *
     * @return
     */
    public static Result success() {
        return success(null);
    }

    /**
     * 自定义错误信息
     *
     * @param code
     * @param msg
     * @return
     */
    public static Result error(Integer code, String msg) {
        Result result = new Result();
        result.setStatus(code);
        result.setMsg(msg);
        result.setData(null);
        return result;
    }

    /**
     * 返回异常信息，在已知的范围内
     *
     * @param exceptionEnum
     * @return
     */
    public static Result error(ExceptionEnum exceptionEnum) {
        Result result = new Result();
        result.setStatus(exceptionEnum.getCode());
        result.setMsg(exceptionEnum.getMsg());
        result.setData(null);
        return result;
    }
}

 

public class ResultUtil {
    /**
     * 返回成功，传入返回体具体出參
     *
     * @param object
     * @return
     */
    public static Result success(Object object) {
        Result result = new Result();
        result.setStatus(0);
        result.setMsg("success");
        result.setData(object);
        return result;
    }

    /**
     * 提供给部分不需要出參的接口
     *
     * @return
     */
    public static Result success() {
        return success(null);
    }

    /**
     * 自定义错误信息
     *
     * @param code
     * @param msg
     * @return
     */
    public static Result error(Integer code, String msg) {
        Result result = new Result();
        result.setStatus(code);
        result.setMsg(msg);
        result.setData(null);
        return result;
    }

    /**
     * 返回异常信息，在已知的范围内
     *
     * @param exceptionEnum
     * @return
     */
    public static Result error(ExceptionEnum exceptionEnum) {
        Result result = new Result();
        result.setStatus(exceptionEnum.getCode());
        result.setMsg(exceptionEnum.getMsg());
        result.setData(null);
        return result;
    }
}

区别

1.注解@ControllerAdvice方式只能处理控制器抛出的异常。此时请求已经进入控制器中。

2.类ErrorController方式可以处理所有的异常，包括未进入控制器的错误，比如404,401等错误

3.如果应用中两者共同存在，则@ControllerAdvice方式处理控制器抛出的异常，类ErrorController方式未进入控制器的异常。

4.@ControllerAdvice方式可以定义多个拦截方法，拦截不同的异常类，并且可以获取抛出的异常信息，自由度更大。