当前位置：首页 > news >正文

@ControllerAdvice 的实现原理

news 来源：原创 2025/7/6 2:58:07

从源码角度分析 Spring Boot 中 @ControllerAdvice 的实现原理

在 Spring Boot 开发中，@ControllerAdvice 是一个非常强大的特性，允许开发者集中处理控制器中的异常、全局数据绑定和模型属性。本文将从源码的角度探讨 @ControllerAdvice 的实现原理，帮助开发者更深入地理解其工作机制。

1. @ControllerAdvice 概述

@ControllerAdvice 是一个注解，用于定义全局的控制器建议。它可以用于处理所有控制器抛出的异常、进行全局数据绑定以及提供全局模型属性。在 Spring MVC 中，@ControllerAdvice 主要与异常处理紧密相关。

2. 核心类与注解

在 Spring 的实现中，几个关键类和注解共同构成了 @ControllerAdvice 的功能：

@ControllerAdvice: 注解本身，标记类为全局控制器建议。
ExceptionHandlerMethodResolver: 负责从 @ControllerAdvice 注解的类中解析异常处理方法。
HandlerExceptionResolver: 定义如何处理请求中的异常。
ModelAndView: 表示模型和视图的对象，用于返回视图名称和模型数据。

3. 实现过程

3.1 注解处理

当 Spring 容器启动时，它会扫描所有带有 @ControllerAdvice 注解的类。具体而言，AnnotationConfigServletWebServerApplicationContext 会通过 ClassPathBeanDefinitionScanner 扫描类路径，以发现这些注解。

处理入口就是ExceptionHandlerExceptionResolver类，这个类实现了InitializingBean#afterPropertiesSet接口

    public void afterPropertiesSet() {// 解析@ControllerAdvice类this.initExceptionHandlerAdviceCache();List handlers;if (this.argumentResolvers == null) {handlers = this.getDefaultArgumentResolvers();this.argumentResolvers = (new HandlerMethodArgumentResolverComposite()).addResolvers(handlers);}if (this.returnValueHandlers == null) {handlers = this.getDefaultReturnValueHandlers();this.returnValueHandlers = (new HandlerMethodReturnValueHandlerComposite()).addHandlers(handlers);}}

initExceptionHandlerAdviceCache 实现

    private void initExceptionHandlerAdviceCache() {if (this.getApplicationContext() != null) {// 通过上下文，找到ControllerAdviceBeanList<ControllerAdviceBean> adviceBeans = ControllerAdviceBean.findAnnotatedBeans(this.getApplicationContext());Iterator var2 = adviceBeans.iterator();while(var2.hasNext()) {ControllerAdviceBean adviceBean = (ControllerAdviceBean)var2.next();Class<?> beanType = adviceBean.getBeanType();if (beanType == null) {throw new IllegalStateException("Unresolvable type for ControllerAdviceBean: " + adviceBean);}// 将一全局 处理异常的bean 封装成 resovler；并且会把bean 中 方法 和 方法对应的异常进行映射。ExceptionHandlerMethodResolver resolver = new ExceptionHandlerMethodResolver(beanType);if (resolver.hasExceptionMappings()) {// 将 adviceBean 和对应的解析器 放到map中this.exceptionHandlerAdviceCache.put(adviceBean, resolver);}if (ResponseBodyAdvice.class.isAssignableFrom(beanType)) {// 放进list中this.responseBodyAdvice.add(adviceBean);}}if (this.logger.isDebugEnabled()) {int handlerSize = this.exceptionHandlerAdviceCache.size();int adviceSize = this.responseBodyAdvice.size();if (handlerSize == 0 && adviceSize == 0) {this.logger.debug("ControllerAdvice beans: none");} else {this.logger.debug("ControllerAdvice beans: " + handlerSize + " @ExceptionHandler, " + adviceSize + " ResponseBodyAdvice");}}}}

3.2 方法解析

在找到 @ControllerAdvice 类后，Spring 会使用 ExceptionHandlerMethodResolver 类来解析其中的异常处理方法。该类的核心逻辑如下：

public class ExceptionHandlerMethodResolver {// 解析异常处理的方法public Method resolveMethod(Exception ex, Class<?> handlerType) {// 根据异常类型查找合适的方法}
}

通过反射，ExceptionHandlerMethodResolver 会找到带有 @ExceptionHandler 注解的方法，并将其与异常类型关联。

3.3 异常处理

当控制器抛出异常时，DispatcherServlet 会捕捉到这些异常。在 Spring MVC 中，DispatcherServlet 实现了 HandlerExceptionResolver 接口，负责将异常传递给合适的异常处理方法。

public class DispatcherServlet extends FrameworkServlet {protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {try {// 处理请求} catch (Exception ex) {// 捕捉到异常，调用处理方法handleException(ex, request, response);}}
}

3.4 选择异常处理器

在 handleException 方法中，Spring 会根据异常的类型和处理器的类型，查找合适的 @ExceptionHandler 方法。如果找到匹配的方法，就会调用该方法，并将异常作为参数传入。

protected void handleException(Exception ex, HttpServletRequest request, HttpServletResponse response) {// 查找合适的异常处理方法Method method = exceptionHandlerMethodResolver.resolveMethod(ex, handlerType);// 如果找到，调用处理方法method.invoke(handler, ex);
}

4. 数据绑定与模型属性

除了异常处理，@ControllerAdvice 还可以用于全局数据绑定和定义全局模型属性。通过 @InitBinder 和 @ModelAttribute 注解，开发者可以在 @ControllerAdvice 中定义全局的属性编辑器和共享的模型属性。

4.1 数据绑定示例

@ControllerAdvice
public class GlobalBindingInitializer {@InitBinderpublic void initBinder(WebDataBinder binder) {binder.setDisallowedFields("id");}
}

4.2 模型属性示例

@ControllerAdvice
public class GlobalModelAttributes {@ModelAttribute("globalAttribute")public String getGlobalAttribute() {return "This is a global attribute";}
}

5. 总结

@ControllerAdvice 是 Spring Framework 中一个重要的特性，允许开发者集中管理控制器的异常、数据绑定和模型属性。通过对其源码的分析，我们可以看到 @ControllerAdvice 是如何通过 AOP 和反射机制实现异常处理的。这种设计使得代码更加模块化和可维护，减少了重复代码的出现。

通过理解其实现原理，开发者可以更有效地使用 @ControllerAdvice 来处理应用中的各种需求，提高代码质量和可读性。