统一异常处理

rainbowhx

已于 2023-02-19 13:47:58 修改

阅读量131

点赞数

文章标签： java spring spring boot

于 2023-02-19 13:45:42 首次发布

本文链接：https://blog.csdn.net/rainbowhx/article/details/129109787

版权

统一异常处理的作用

让异常结果显示为统一的返回结果对象，并且统一处理系统的异常信息

创建统一异常处理器

@Slf4j
@Component //Spring容易自动管理
@RestControllerAdvice
//在controller层添加通知。如果使用@ControllerAdvice，则方法上需要添加@ResponseBody
public class UnifiedExceptionHandler {

    /**
     * 未定义异常
     */
    @ExceptionHandler(value = Exception.class) //当controller中抛出Exception，则捕获
    public R handleException(Exception e) {
        log.error(e.getMessage(), e);
        return R.error();
    }
}

处理特定异常

如果不想显示统一的“服务器内部错误”，需要自定义错误信息，需要对特定异常处理

/**
* 特定异常
*/
@ExceptionHandler(BadSqlGrammarException.class)
public R handleBadSqlGrammarException(BadSqlGrammarException e){
    log.error(e.getMessage(), e);
    return R.setResult(ResponseEnum.BAD_SQL_GRAMMAR_ERROR);
}

自定义异常处理

使用一个或较少的异常类，来捕获和显示所有的异常信息

创建一个自定义的异常类，并在程序中抛出这个自定义异常，并在统一异常处理器中捕获自定义异常对象

@Data
@NoArgsConstructor
public class BusinessException extends RuntimeException {

    //状态码
    private Integer code;

    //错误消息
    private String message;

}



/**
* 自定义异常
*/
@ExceptionHandler(BusinessException.class)
public R handleBusinessException(BusinessException e){
    log.error(e.getMessage(), e);
    return R.error().message(e.getMessage()).code(e.getCode());
}

异常处理优化

可以使用断言的方式，校验业务的异常情况并抛出，消除if else的使用

自定义断言


@Slf4j
public abstract class Assert {

    /**
     * 断言对象不为空
     * 如果对象obj为空，则抛出异常
     * @param obj 待判断对象
     */
    public static void notNull(Object obj, ResponseEnum responseEnum) {
        if (obj == null) {
            log.info("obj is null...............");
            throw new BusinessException(responseEnum);
        }
    }
}

Controller上层异常处理

异常的分类

按照异常发生的阶段可以分为：进入Controller前的业务异常和业务层异常（controller和service）

处理Controller上层异常

/**
     * Controller上一层相关异常
     */
@ExceptionHandler({
    NoHandlerFoundException.class,
    HttpRequestMethodNotSupportedException.class,
    HttpMediaTypeNotSupportedException.class,
    MissingPathVariableException.class,
    MissingServletRequestParameterException.class,
    TypeMismatchException.class,
    HttpMessageNotReadableException.class,
    HttpMessageNotWritableException.class,
    MethodArgumentNotValidException.class,
    HttpMediaTypeNotAcceptableException.class,
    ServletRequestBindingException.class,
    ConversionNotSupportedException.class,
    MissingServletRequestPartException.class,
    AsyncRequestTimeoutException.class
        })
public R handleServletException(Exception e) {
    log.error(e.getMessage(), e);
    //SERVLET_ERROR(-102, "servlet请求异常"),
    return R.error().message(ResponseEnum.SERVLET_ERROR.getMessage()).code(ResponseEnum.SERVLET_ERROR.getCode());
}