SpringBoot -- @RestControllerAdvice 注解

前言

在 SpringBoot 中，通常使用注解 @RestControllerAdvice 来做全局统一异常处理。

@RestControllerAdvice 用在类上，对 Controller 进行增强的，可以全局捕获 spring mvc 抛的异常。

@ExceptionHandler(value = Exception.class)

@ExceptionHandler 用在方法上，作用是用来捕获指定的异常。

源码分析

@RestControllerAdvice = @ControllerAdvice + @ResponseBody

@RestControllerAdvice 的源码如下：

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@ControllerAdvice
@ResponseBody
public @interface RestControllerAdvice {
    @AliasFor(
        annotation = ControllerAdvice.class
    )
    String[] value() default {};

    @AliasFor(
        annotation = ControllerAdvice.class
    )
    String[] basePackages() default {};

    @AliasFor(
        annotation = ControllerAdvice.class
    )
    Class<?>[] basePackageClasses() default {};

    @AliasFor(
        annotation = ControllerAdvice.class
    )
    Class<?>[] assignableTypes() default {};

    @AliasFor(
        annotation = ControllerAdvice.class
    )
    Class<? extends Annotation>[] annotations() default {};
}

如果在运行时发现了异常，希望将异常统一返回,这里就需要用到 @RestControllerAdvice。

示例

新建一个全局异常处理类：GlobalExceptionHandler

@RestControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(SQLException.class)
    public RespBean sqlException(SQLException e){
        if (e instanceof SQLIntegrityConstraintViolationException){
            return RespBean.error("该数据有关联数据，操作失败！");
        }
        return RespBean.error("数据库异常！");
    }
}