统一异常处理ControllerAdvice

首先，ControllerAdvice本质上是一个Component，因此也会被当成组件扫描，一视同仁，扫扫扫。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface ControllerAdvice {

	@AliasFor("basePackages")
	String[] value() default {};

	@AliasFor("value")
	String[] basePackages() default {};

	Class<?>[] basePackageClasses() default {};

	Class<?>[] assignableTypes() default {};

	Class<? extends Annotation>[] annotations() default {};

}

在Spring里，我们可以使用@ControllerAdvice来声明一些全局性的东西，其用法主要有以下三点：

1、@ExceptionHandler注解标注的方法：用于捕获Controller中抛出的不同类型的异常，从而达到异常全局处理的目的；
2、@ModelAttribute注解标注的方法：表示此方法会在执行目标Controller方法之前执行；
3、@InitBinder注解标注的方法：用于请求中注册自定义参数的解析，从而达到自定义请求参数格式的目的；

ControllerAdvice 提供了多种指定Advice规则的定义方式，默认什么都不写，则是Advice所有Controller，当然你也可以通过下列的方式指定规则：

1. 比如对于 String[] value() default {} , 写成@ControllerAdvice(“org.my.pkg”) 或者 @ControllerAdvice(basePackages=“org.my.pkg”), 则匹配org.my.pkg包及其子包下的所有Controller
2. 当然也可以用数组的形式指定，如：@ControllerAdvice(basePackages={“org.my.pkg”, “org.my.other.pkg”})
3. 也可以通过指定注解来匹配，比如我自定了一个 @CustomAnnotation 注解，我想匹配所有被这个注解修饰的 Controller, 可以这么写：@ControllerAdvice（annotations={CustomAnnotation.class})

在我们日常的开发过程中，通常会根据业务定义属于自己的异常，所以通过定制自己的异常处理器，来处理项目中大大小小、各种各样的异常。目前最常用的方式应该是使用@ControllerAdvice+@ExceptionHandler的组合来实现。

@ControllerAdvice
@Slf4j
@Order(Ordered.HIGHEST_PRECEDENCE) //控制bean的优先级，Order值越小，优先级越高！    
public class GlobalExceptionHandler {

    // 业务异常处理
    @ExceptionHandler({CommonException.class})
    @ResponseBody
    public HttpResult<String> commonExceptionHandler(CommonException e) {
        log.warn("CommonException occurs...", e);
        return HttpResult.fail(e.getErrMsg());
    }

    // 参数校验异常处理，如 NotNull NotBlank
    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseBody
    public HttpResult<String> methodArgumentNotValidExceptionHandler(MethodArgumentNotValidException e) {
        log.warn("MethodArgumentNotValidException occurs...", e);
        if (e.getBindingResult().getFieldError() == null) {
            return HttpResult.fail(ReturnCode.FAILED);
        }
        return HttpResult.fail(ReturnCode.FAILED, e.getBindingResult().getFieldError().getDefaultMessage());
    }

	// 普通异常处理，如果异常匹配不到CommonException或者MethodArgumentNotValidException异常，则会进入这里面
    @ResponseBody
    @ExceptionHandler(value = Exception.class)
    public HttpResult<String> exceptionHandler(HttpServletRequest req, Exception e) {
        log.error("uncaught exception " + req.getRequestURI(), e);
        return HttpResult.fail(ReturnCode.INTERNAL_SERVER_ERROR);
    }
}

@RestController
@RequestMapping("/user")
public class TestController {
 
 	/**
 	 * 获取用户列表，直接返回异常
 	 */
    @GetMapping("/getList")
    public void getList() {
        throw new BusinessException("获取用户列表异常");
    }
}

BusinessException继承自CommonException，业务逻辑中抛出异常，最终会走到ExceptionControllerAdvice中的commonExceptionHandler方法中，最终封装成HttpResult对象返回给前台。