@ControllerAdvice 异常处理原理分析

最新推荐文章于 2025-06-19 11:51:59 发布
最新推荐文章于 2025-06-19 11:51:59 发布
阅读量1.1k 收藏 5
点赞数 24
CC 4.0 BY-SA版权
文章标签： 后端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/sc35262/article/details/144425961

前言

“@全体成员 数据库的一切异常都不能直接暴露给前端” springboot的全局异常处理 可通过 @ControllerAdivce/@RestControllerAdvice 来实现。使用之前先看其原理。

今天就从从源码的角度分析 @ControllerAdvice 的实现全局异常捕捉的过程，帮助开发者更深入地理解其工作机制。

@ControllerAdvice 概述

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

实际开发中基本就是用来全局的异常处理。现在一般用@RestControllerAdvice实现上基本一样，只是返回结果都以json数据格式返回，符合前后端开发规范。

使用demo

实际开发中用得比较多的就是捕获全局异常，当然Controller 层也可以定义自己的异常。Controller级别的异常处理优先级高于全局异常处理。

1.定义全局异常异常处理

java

代码解读

复制代码

/** * **/ @RestControllerAdvice @Slf4j public class GlobalExceptionHandler { /** * 处理自定义异常 */ @ExceptionHandler(BizDataException.class) public ResponseVO<?> handleBizDataException(BizDataException e){ log.error(e.getMessage(), e); return ResponseVO.error(e.getMessage()); } }

  1. 定义Controller级别的异常

java

代码解读

复制代码

@RestController @RequestMapping("/admin/api") public class CommController { @GetMapping(value = "/query") public ResponseVO<?> query(@RequestParam(required = false) String name) { return ResponseVO.ok(service.query(name)); } /** * 处理自定义异常 */ @ExceptionHandler(BizDataException.class) public ResponseVO<?> handleBizDataException(BizDataException e){ log.error(e.getMessage(), e); return ResponseVO.error(e.getMessage()); } }

核心类与注解

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

  • @ControllerAdvice: 注解本身，标记类为全局控制器建议。@ExceptionHandler 标记处理异常方法
  • ExceptionHandlerExceptionResolver 遍历@ControllerAdvice 类 初始化异常处理器ExceptionHandlerMethodResolver
  • ExceptionHandlerMethodResolver: 负责从 @ControllerAdvice 注解的类中解析异常处理方法。

实现过程

实现过程主要分为两流程，异常处器的加载初始化。然后就是异常的捕捉，以及调用对应的处理器；

加载流程如下图： 

1733978460960.jpg

 异常捕获流程：

image.png

初始化异常解析器

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

2.遍历所有@ControllerAdvice标记的Bean，对每个Bean封装成ExceptionHandlerMethodResolver 放入exceptionHandlerAdviceCache Map 中。

exceptionHandlerAdviceCache 这个map非常重要，后面处理异常就会遍历该map 找到对应异常的处理方法

初始化 ExceptionHandlerMethodResolver的时候，就会去解析@ControllerAdvice标记的Bean里面的 异常处理方法封装，放到mappedMethods Map 中。

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

java

代码解读

复制代码

public void afterPropertiesSet() { // 将advice 标记类初始化成 异常处理器 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 实现

关键的代码都进行了注释，如下：

java

代码解读

复制代码

private void initExceptionHandlerAdviceCache() { if (this.getApplicationContext() != null) { // 通过上下文，找到ControllerAdviceBean List<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); } } ...................... } }

上面还有一个比较关键的代码 ExceptionHandlerMethodResolver resolver = new ExceptionHandlerMethodResolver(beanType); 具体实现如下

java

代码解读

复制代码

// 异常处理方法解析器 构造方法 public ExceptionHandlerMethodResolver(Class<?> handlerType) { // 遍历 ControllerAdvice 类的异常处理 方法 for (Method method : MethodIntrospector.selectMethods(handlerType, EXCEPTION_HANDLER_METHODS)) { for (Class<? extends Throwable> exceptionType : detectExceptionMappings(method)) { addExceptionMapping(exceptionType, method); } } } private void addExceptionMapping(Class<? extends Throwable> exceptionType, Method method) { // 将异常类型 和 对应处理异常的方法 放到HashMap 中 Method oldMethod = this.mappedMethods.put(exceptionType, method); if (oldMethod != null && !oldMethod.equals(method)) { throw new IllegalStateException("Ambiguous @ExceptionHandler method mapped for [" + exceptionType + "]: {" + oldMethod + ", " + method + "}"); } }

以上就是解析@ControllerAdvice 类，并初始化解析器 ExceptionHandlerMethodResolver的过程。

异常捕捉，反射调用

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

java

代码解读

复制代码

protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception { ........... try { ........ try { ...................... // Actually invoke the handler. mv = ha.handle(processedRequest, response, mappedHandler.getHandler()); ....................... } catch (Exception ex) { // 捕捉异常 dispatchException = ex; } catch (Throwable err) { // As of 4.3, we're processing Errors thrown from handler methods as well, // making them available for @ExceptionHandler methods and other scenarios. dispatchException = new NestedServletException("Handler dispatch failed", err); } // 处理返回结果 ，有异常就会处理异常，重新封装返回结果 processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException); } catch (Exception ex) { triggerAfterCompletion(processedRequest, response, mappedHandler, ex); } catch (Throwable err) { triggerAfterCompletion(processedRequest, response, mappedHandler, new NestedServletException("Handler processing failed", err)); } finally { .................. } }

中间步骤就省略了，看看堆栈吧截图吧，从上往下执行： 

在这里插入图片描述

 下面就主要分析如何找到对应的异常处理器

选择异常处理器

上图我们debug 到 ExceptionHandlerExceptionResolver#getExceptionHandlerMethod 这个就是找到对应异常的处理类已经处理方法

主要分为三步

  1. 查询Controller 本身是否有异常处理方法
  2. 处理代理类情况
  3. 查找全局 @ControllerAdvice 的异常处理方法 （重点落在这一步）

java

代码解读

复制代码

/** * @param handlerMethod 抛出异常的 Controller 对应的method * @param exception 捕捉到的异常 **/ protected ServletInvocableHandlerMethod getExceptionHandlerMethod( @Nullable HandlerMethod handlerMethod, Exception exception) { Class<?> handlerType = null; if (handlerMethod != null) { //1. 查询Controller 本身是否有异常处理方法 // Local exception handler methods on the controller class itself. // To be invoked through the proxy, even in case of an interface-based proxy. handlerType = handlerMethod.getBeanType(); ExceptionHandlerMethodResolver resolver = this.exceptionHandlerCache.get(handlerType); if (resolver == null) { resolver = new ExceptionHandlerMethodResolver(handlerType); this.exceptionHandlerCache.put(handlerType, resolver); } Method method = resolver.resolveMethod(exception); if (method != null) { return new ServletInvocableHandlerMethod(handlerMethod.getBean(), method, this.applicationContext); } //2. 处理代理类情况 // For advice applicability check below (involving base packages, assignable types // and annotation presence), use target class instead of interface-based proxy. if (Proxy.isProxyClass(handlerType)) { handlerType = AopUtils.getTargetClass(handlerMethod.getBean()); } } //3. 查找全局 @ControllerAdvice 的异常处理方法 （重点落在这一步） for (Map.Entry<ControllerAdviceBean, ExceptionHandlerMethodResolver> entry : this.exceptionHandlerAdviceCache.entrySet()) { ControllerAdviceBean advice = entry.getKey(); if (advice.isApplicableToBeanType(handlerType)) { // 获取到我们自定义的 @ControllerAdvice 标记类的处理器（初始化阶段完成的） ExceptionHandlerMethodResolver resolver = entry.getValue(); // 获取到 解析异常的处理类 Method method = resolver.resolveMethod(exception); if (method != null) { return new ServletInvocableHandlerMethod(advice.resolveBean(), method, this.applicationContext); } } } return null; }

// 获取到 解析异常的处理类 Method method = resolver.resolveMethod(exception); 获取异常的处理方法，核心处理逻辑如下：

java

代码解读

复制代码

private Method getMappedMethod(Class<? extends Throwable> exceptionType) { List<Class<? extends Throwable>> matches = new ArrayList<>(); // 从mapperdMethods Map 中获取对应的异常处理类，mapperdMethods 里面数据就是在初始化阶段完成的 for (Class<? extends Throwable> mappedException : this.mappedMethods.keySet()) { if (mappedException.isAssignableFrom(exceptionType)) { matches.add(mappedException); } } if (!matches.isEmpty()) { if (matches.size() > 1) { matches.sort(new ExceptionDepthComparator(exceptionType)); } return this.mappedMethods.get(matches.get(0)); } else { return NO_MATCHING_EXCEPTION_HANDLER_METHOD; } }

反射调用异常处理类

java

代码解读

复制代码

protected ModelAndView doResolveHandlerMethodException(HttpServletRequest request, HttpServletResponse response, @Nullable HandlerMethod handlerMethod, Exception exception) { // 获取到 处理异常对应的 Method，封装到ServletInvocableHandlerMethod ServletInvocableHandlerMethod exceptionHandlerMethod = getExceptionHandlerMethod(handlerMethod, exception); ................. try { ............. //反射调用 exceptionHandlerMethod.invokeAndHandle(webRequest, mavContainer, arguments); } //返回视图............. .......... } }

5. 总结

本篇文章分析了异常解析器的初始化过程（bean 初始化阶段），再到异常的捕捉，以及如何找到对应的异常处理方法，最后反射调用，返回结果。希望这篇文章对你有所帮助，欢迎各位老铁点赞收藏！！！

Java八股文
关注
SpringBoot全局异常处理-原理分析
qq_33479841的博客
04-30 1434
在日常开发中，如何快速定位异常并处理异常，体现了一个研发人员解决问题的能力，需要不断在业务发展中精进自己的业务水平，提升对原理的理解。快速解决的前提是快速定位问题，合理的异常处理能够帮助我们快速抛出问题。在SpringBoot中，全局异常处理能够有效降低异常代码数量，提供统一的异常处理模式，帮助我们从代码层面优雅地抛出异常。本文将演示SpringBoot中全局异常使用，并进行原理分析。
详细分析@InitBinder注解的使用和原理
m0_71777195的博客
03-17 783
由@InitBinder注解修饰的方法用于初始化对象，能够实现：从request获取到handler方法中由@注解或@注解修饰的参数后，假如获取到的参数类型与handler方法上的参数类型不匹配，此时可以使用初始化好的对获取到的参数进行类型处理。一个经典的例子就是handler方法上的参数类型为Date，而从request中获取到的参数类型是字符串，SpringMVC在默认情况下无法实现字符串转Date，此时可以在由@InitBinder注解修饰的方法中为对象注册，从而使得能将从request。
Spring注解@RestControllerAdvice原理解析
08-25
主要介绍了Spring注解@RestControllerAdvice原理解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
@ControllerAdvice实现优雅地处理异常
m0_37641835的博客
12-12 241
@ControllerAdvice，是Spring3.2提供的新注解,它是一个Controller增强器,可对controller中被 @RequestMapping注解的方法加一些逻辑处理。最常用的就是异常处理 统一异常处理 需要配合@ExceptionHandler使用。 当将异常抛到controller时,可以对异常进行统一处理,规定返回的json格式或是跳转到一个错误页面 //全局异常捕捉处理 @ControllerAdvice public class CustomExceptionHandler
深度解析Spring Boot中的`@RestControllerAdvice`：全局异常处理的艺术
最新发布
hi星尘的博客
06-19 590
业务异常与系统异常分离统一的API响应格式细粒度的异常处理策略良好的国际化支持定义清晰的异常层级结构保持异常处理代码简洁合理使用日志记录为不同模块定制专属处理器通过本文的深度解析和完整代码示例，开发者可以构建出健壮、可维护的全局异常处理体系，显著提升API的可靠性和开发者体验。
SpringMVC：注解@ControllerAdvice的工作原理
Java知音
02-23 1447
来源：blog.youkuaiyun.com/andy_zhang2007/article/details/100041219Spring MVC中，通过组合使用注解@ControllerAdvice...
Spring MVC : 注解@ControllerAdvice的工作原理
Details Inside Spring
08-23 1万+
Spring MVC中，通过组合使用注解@ControllerAdvice和其他一些注解，我们可以为开发人员实现的控制器类做一些全局性的定制，具体来讲，其效果如下 : 结合@ExceptionHandler使用 ==> 添加统一的异常处理控制器方法 结合@ModelAttribute使用 ==> 使用共用方法添加渲染视图的数据模型属性 结合@InitBinder使用 ==> ...
@ControllerAdvice 的实现原理
weixin_39439156的博客
12-10 889
是一个注解，用于定义全局的控制器建议。它可以用于处理所有控制器抛出的异常、进行全局数据绑定以及提供全局模型属性。在 Spring MVC 中，主要与异常处理紧密相关。是 Spring Framework 中一个重要的特性，允许开发者集中管理控制器的异常、数据绑定和模型属性。通过对其源码的分析，我们可以看到是如何通过 AOP 和反射机制实现异常处理的。这种设计使得代码更加模块化和可维护，减少了重复代码的出现。通过理解其实现原理，开发者可以更有效地使用来处理应用中的各种需求，提高代码质量和可读性。
深入理解@ExceptionHandler：Spring 异常处理的利器
xycxycooo的博客
08-16 1319
是Spring框架中的一个注解，用于标识一个方法，使其能够处理特定类型的异常。当控制器方法抛出指定类型的异常时，Spring会自动调用被注解的方法来处理该异常。这种方式使得异常处理逻辑可以集中管理，避免了在每个控制器方法中重复编写异常处理代码。在实际应用中，往往需要返回更详细的异常信息，如错误码、错误描述等。
Java异常处理深度解析：从原理到实战应用指南
weixin_43063624的博客
02-20 990
继承体系选择：业务异常继承RuntimeException异常信息标准化：包含错误码、错误描述、上下文数据保持异常链：保留原始异常信息合理的异常处理体系是构建健壮Java应用的基石。通过规范的异常设计、分层处理策略和智能监控告警系统的结合，可以有效提升系统的可维护性和可靠性。建议结合具体业务场景，持续优化异常处理策略，形成适合项目特征的异常管理体系。
Spring MVC异常统一处理教程及源码分析
标签"源码"表明了本资源可能包含对Spring MVC异常处理机制的源码解析，帮助开发者理解底层实现原理。而标签"工具"可能意味着提供一些用于辅助异常处理的工具或者框架，如日志工具、性能监控工具等。由于提供的文件...
@ControllerAdvice 注解原理
jiayoudangdang的博客
05-03 1643
@ControllerAdvice` 的工作原理在 Spring Boot 应用程序启动时涉及到多个组件和步骤；在启动过程中，`ControllerAdviceBeanPostProcessor` 会扫描带有 `@ControllerAdvice` 注解的类，`ExceptionHandlerMethodResolver` 会扫描这些类中的异常处理方法并将它们注册到全局异常处理器映射表中。
@RestControllerAdvice全局异常处理起作用的原理
weixin_36142042的博客
03-13 4060
0、首先定义一个简单的全局异常处理类 @RestControllerAdvice public class GlobalExceptionHandler { @ExceptionHandler public Object handle(Exception e) { return "error by my ExceptionHandler"; } } 现在...
Spring Boot 系列（八）@ControllerAdvice 拦截异常并统一处理
CAD201213的博客
07-18 3041
在spring 3.2中，新增了@ControllerAdvice 注解，可以用于定义@ExceptionHandler、@InitBinder、@ModelAttribute，并应用到所有@RequestMapping中。参考：@ControllerAdvice 文档 一、介绍 创建 MyControllerAdvice，并添加 @ControllerAdvice注解。 package...
精通Spring Boot---使用@ControllerAdvice处理异常
weixin_30950607的博客
02-14 257
在Spring 3.2中，新增了@ControllerAdvice、@RestControllerAdvice 注解，可以用于定义@ExceptionHandler、@InitBinder、@ModelAttribute，并应用到所有@RequestMapping、@PostMapping， @GetMapping注解中。接下来我将通过代码展示如何使用这些注解,以及处理异常。 1.注解的介绍 ...
@ControllerAdvice 拦截异常并统一处理（转载）
aiganxie2129的博客
02-07 1033
在spring 3.2中，新增了@ControllerAdvice注解，可以用于定义@ExceptionHandler、@InitBinder、@ModelAttribute，并应用到所有@RequestMapping中。 一、介绍 创建 MyControllerAdvice，并添加 @ControllerAdvice注解。 package com.sam.demo.cont...
spring注解@ControllerAdvice的原理分析和使用
热门推荐
nandao158的博客
01-16 1万+
@ControllerAdvice注解是Spring3.2中新增的注解，学名是Controller增强器，作用是给Controller控制器添加统一的操作或处理。 对于@ControllerAdvice，我们比较熟知的用法是结合@ExceptionHandler用于全局异常的处理，但其作用不止于此。ControllerAdvice拆开来就是Controller Advice，关于Advice，在Spring的AOP中，是用来封装一个切面所有属性的，包括切入点和需要织入的切面逻辑。这里ControllerA
@RestControllerAdvice作用及原理
az44yao的专栏
07-19 2858
创建MyControllerAdvice，并添加@ControllerAdvice注解。/***controller增强器*//***应用到所有@RequestMapping注解方法，在其执行之前初始化数据绑定器*//***把值绑定到Model中，使全局@RequestMapping可以获取到该值*/}/***全局异常捕捉处理*@return*/returnmap;}Model}//或者通过@ModelAttribute获取。...
@ControllerAdvice（处理全局异常）
qq_42418169的博客
08-16 2707
文章目录SpringMVC中@ControllerAdvice注解全局异常处理全局数据绑定全局数据预处理 SpringMVC中@ControllerAdvice注解 @ControllerAdvice ，很多初学者可能都没有听说过这个注解，实际上，这是一个非常有用的注解，顾名思义，这是一个增强的 Controller。使用这个 Controller ，可以实现三个方面的功能： 全局异常处理 全局数据绑定 全局数据预处理 灵活使用这三个功能，可以帮助我们简化很多工作，需要注意的是，这是 SpringMVC
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值