ControllerAdvice 是如何起作用的

 

0. 背景

      在controller 暴露的各个接口下通常会抛出各种异常，我们希望所有的异常处理都可以收口到一处。而ControllerAdvice 这个annotation标签就是起这种作用的。那为什么只要在一个类上打上这个标签就会起作用呢。

 

1. GlobalExceptionHandler示例

 

@ControllerAdvice
public class GlobalExceptionHandler {
    
    @ResponseBody
    @ExceptionHandler(MyExceptionA.class)
    public MyResponse<Object> onMyExceptionA(HttpServletRequest req, MyExceptionA e) {
        return MyResponse.of(e.getData(), e.getResultCode(), e.getMessage());
    }

    @ResponseBody
    @ExceptionHandler(MyExceptionB.class)
    public MyResponse<Object> onMyExceptionB(HttpServletRequest req, MyExceptionB e) {
        return MyResponse.of(null, e.getErrorCode(), e.getMessage());
    }

}

 

2. 顺藤摸瓜

    我们顺着ControllerAdvice这个类的使用来自底向上挖掘它是如何发生作用的。

    首先我们看ExceptionHandler这个注解类是在哪里处理的，

 我们看到了在spring.web包下的这个类 org.springframework.web.method.annotation.ExceptionHandlerMethodResolver，进一步看下它的构造函数。

    /**
     * A constructor that finds {@link ExceptionHandler} methods in the given type.
     * @param handlerType the type to introspect
     */
    public ExceptionHandlerMethodResolver(Class<?> handlerType) {
        for (Method method : MethodIntrospector.selectMethods(handlerType, EXCEPTION_HANDLER_METHODS)) {
            for (Class<? extends Throwable> exceptionType : detectExceptionMappings(method)) {
                addExceptionMapping(exceptionType, method);
            }
        }
    }

    /**
     * A filter for selecting {@code @ExceptionHandler} methods.
     */
    public static final MethodFilter EXCEPTION_HANDLER_METHODS = new MethodFilter() {
        @Override
        public boolean matches(Method method) {
            return (AnnotationUtils.findAnnotation(method, ExceptionHandler.class) != null);
        }
    };

      从构造函数可以看出是从一个handlerType的类中取出所有被ExceptionHanlder标注的方法，存储一个<Exception, Method>的方法映射。

   

      其次我们看ExceptionHandlerMethodResolver这个类的构造函数是在哪里使用的，

      在sping.webmvc包下这个类org.springframework.web.servlet.mvc.method.annotation.ExceptionHandlerExceptionResolver的初始化动作里，我们看到ExceptionHandlerMethodResolver构造函数的入参正是ControllerAdviceBean的BeanType, 也就是前面我们提到的GlobalExceptionHandler示例。

 

    private void initExceptionHandlerAdviceCache() {
        if (getApplicationContext() == null) {
            return;
        }
        if (logger.isDebugEnabled()) {
            logger.debug("Looking for exception mappings: " + getApplicationContext());
        }

        List<ControllerAdviceBean> adviceBeans = ControllerAdviceBean.findAnnotatedBeans(getApplicationContext());
        AnnotationAwareOrderComparator.sort(adviceBeans);

        for (ControllerAdviceBean adviceBean : adviceBeans) {
            ExceptionHandlerMethodResolver resolver = new ExceptionHandlerMethodResolver(adviceBean.getBeanType());
            if (resolver.hasExceptionMappings()) {
                this.exceptionHandlerAdviceCache.put(adviceBean, resolver);
                if (logger.isInfoEnabled()) {
                    logger.info("Detected @ExceptionHandler methods in " + adviceBean);
                }
            }
            if (ResponseBodyAdvice.class.isAssignableFrom(adviceBean.getBeanType())) {
                this.responseBodyAdvice.add(adviceBean);
                if (logger.isInfoEnabled()) {
                    logger.info("Detected ResponseBodyAdvice implementation in " + adviceBean);
                }
            }
        }
    }

 

3. 完整链条

       从应用的GlobalExceptionHandler叶子节点一直向上追溯我们追查到ExceptionHandlerExceptionResolver这个类，那完成的链路是啥呢？

       从入口 DispatcherServlet#doDispatch() -> DispatcherServlet#processDispatchResult() -> DispatcherServlet#processHandlerException() -> HandlerExceptionResolver#resolveException() -> AbstractHandlerExceptionResolver#doResolveException() -> AbstractHandlerMethodExceptionResolver#doResolveHandlerMethodException() -> ExceptionHandlerExceptionResolver#doResolveHandlerMethodException()

-> ExceptionHandlerMethodResolver#getMappedMethod().invoke()

 

 

以上。