SpringBoot全局异常处理源码

SpringBoot全局异常处理源码

  • 一、SpringMVC执行流程
  • 二、SpringBoot源码跟踪
  • 三、自定义优雅的全局异常处理脚手架starter
    • 自定义异常
    • 国际化引入
    • 封装基础异常
    • 封装基础异常扫描器，并注册到ExceptionHandler中
    • 项目分享以及改进点

一、SpringMVC执行流程

今天这里叙述的全局异常处理是SpringBoot在Servlet场景下的处理机制，重点是Servlet模式，当然WEBFLUX今天不做过多描述，SpringBoot2.2.x以后引入的一种响应式web开发，在SpringBoot启动类中可以看到：

SpringApplication.java=> new SpringApplication(ResourceLoader resourceLoader, Class<?>... primarySources) => WebApplicationType.deduceFromClasspath();

deduceFromClasspath方法：
在这里插入图片描述既然是SringBoot的webServlet场景，自然不可以放过的就是DispatchServlet一整个执行流程，那就从面试书籍中cp一张
在这里插入图片描述当然小编也有历史文档可以参考下：SpringMVC执行流程
在这里插入图片描述今天的异常处理，用草图画了下，就是红框框这里：
在这里插入图片描述这里SpringBoot究竟如何设计了异常处理呢，走进源码，探索真相！

二、SpringBoot源码跟踪

说到DispatchServlet的请求处理，那就直接找到核心方法：doDispatch(HttpServletRequest request, HttpServletResponse response) ；点进源码，不难发现寻找Handler和执行Handler这整整一大块，用了复合try–catch进行包裹：

			try {processedRequest = checkMultipart(request);multipartRequestParsed = (processedRequest != request);mappedHandler = getHandler(processedRequest);if (mappedHandler == null) {noHandlerFound(processedRequest, response);return;}HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());......mv = ha.handle(processedRequest, response, mappedHandler.getHandler());......applyDefaultViewName(processedRequest, mv);mappedHandler.applyPostHandle(processedRequest, response, mv);}catch (Exception ex) {dispatchException = ex;}catch (Throwable err) {dispatchException = new NestedServletException("Handler dispatch failed", err);}processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);

在try的结束处，我们可以看到，小异常到大异常，源码中并没有打印堆栈，而是封装成dispatchException ，最后交给processDispatchResult方法去处理请求分发的结果
而processDispatchResult方法内部，则是对异常进行了解析，也叫resolveException：

		if (exception != null) {if (exception instanceof ModelAndViewDefiningException) {logger.debug("ModelAndViewDefiningException encountered", exception);mv = ((ModelAndViewDefiningException) exception).getModelAndView();}else {Object handler = (mappedHandler != null ? mappedHandler.getHandler() : null);mv = processHandlerException(request, response, handler, exception);errorView = (mv != null);}}

再次进入非视图异常的处理方法processHandlerException中，我们看到了多个异常处理器去循环处理异常，直到循环结束，如果返回值不为NULL，说明该异常能够被解析并且处理完毕返回ModelAndView

		if (this.handlerExceptionResolvers != null) {for (HandlerExceptionResolver resolver : this.handlerExceptionResolvers) {exMv = resolver.resolveException(request, response, handler, ex);if (exMv != null) {break;}}}

DispatchServlet类初始化时从容器中获取handlerExceptionResolvers ，该类的接口表示Spring容器中处理异常的处理器类，根据debug可以看到，Spring容器中含有两个解析器类，一个是默认的兜底的异常解析器类，另一个是HandlerExceptionResolverComposite，内部维护着spring容器的异常解析器列表
在这里插入图片描述那么HandlerExceptionResolverComposite处理器类是从哪里来的，接着我们跳转到WebMvcConfigurationSupport类,观察其诞生之地

	@Beanpublic HandlerExceptionResolver handlerExceptionResolver(@Qualifier("mvcContentNegotiationManager") ContentNegotiationManager contentNegotiationManager) {List<HandlerExceptionResolver> exceptionResolvers = new ArrayList<>();configureHandlerExceptionResolvers(exceptionResolvers);if (exceptionResolvers.isEmpty()) {addDefaultHandlerExceptionResolvers(exceptionResolvers, contentNegotiationManager);}extendHandlerExceptionResolvers(exceptionResolvers);HandlerExceptionResolverComposite composite = new HandlerExceptionResolverComposite();composite.setOrder(0);composite.setExceptionResolvers(exceptionResolvers);return composite;}

这里有两个地方需要关注，首先是addDefaultHandlerExceptionResolvers，就是spring会默认添加三个异常解析器，一个是ExceptionHandlerExceptionResolver，这个处理的是程序中注解了@ExceptionHandler的，第二个DefaultHandlerExceptionResolver，这个是处理一些通常的异常，具体可查看官方文档。第三个是较少用的ResponseStatusExceptionResolver
另一个要关注的是extendHandlerExceptionResolvers方法，这个是留给子类重写，扩展使用的。
此时我们大概知道HandlerExceptionResolverComposite类的resolveException方法可以解析异常，那么我们打个断点，放行程序到此处，再观察：
在这里插入图片描述那么一切就变的似乎很合理了，HandlerExceptionResolverComposite内部维护着异常解析器列表，循环去解析，解析成功就返回，并且还看到了列表清单的第一个解析器就是ExceptionHandlerExceptionResolver，于是到ExceptionHandlerExceptionResolver类中打上断点观察

protected ModelAndView doResolveHandlerMethodException(HttpServletRequest request,HttpServletResponse response, @Nullable HandlerMethod handlerMethod, Exception exception) {ServletInvocableHandlerMethod exceptionHandlerMethod = getExceptionHandlerMethod(handlerMethod, exception);if (exceptionHandlerMethod == null) {return null;}if (this.argumentResolvers != null) {exceptionHandlerMethod.setHandlerMethodArgumentResolvers(this.argumentResolvers);}if (this.returnValueHandlers != null) {exceptionHandlerMethod.setHandlerMethodReturnValueHandlers(this.returnValueHandlers);}ServletWebRequest webRequest = new ServletWebRequest(request, response);ModelAndViewContainer mavContainer = new ModelAndViewContainer();ArrayList<Throwable> exceptions = new ArrayList<>();try {if (logger.isDebugEnabled()) {logger.debug("Using @ExceptionHandler " + exceptionHandlerMethod);}// Expose causes as provided arguments as wellThrowable exToExpose = exception;while (exToExpose != null) {exceptions.add(exToExpose);Throwable cause = exToExpose.getCause();exToExpose = (cause != exToExpose ? cause : null);}Object[] arguments = new Object[exceptions.size() + 1];exceptions.toArray(arguments);  // efficient arraycopy call in ArrayListarguments[arguments.length - 1] = handlerMethod;exceptionHandlerMethod.invokeAndHandle(webRequest, mavContainer, arguments);}catch (Throwable invocationEx) {// Any other than the original exception (or a cause) is unintended here,// probably an accident (e.g. failed assertion or the like).if (!exceptions.contains(invocationEx) && logger.isWarnEnabled()) {logger.warn("Failure in @ExceptionHandler " + exceptionHandlerMethod, invocationEx);}// Continue with default processing of the original exception...return null;}if (mavContainer.isRequestHandled()) {return new ModelAndView();}

观察这一句

exceptionHandlerMethod.setHandlerMethodReturnValueHandlers(this.returnValueHandlers);

顾名思义，设置了返回值的处理器
那我们看看ExceptionHandlerExceptionResolver初始化经历了些啥，首先实现了InitializingBean，那么就直接先看afterProperties方法（Bean生命周期执行的钩子函数）
在这里插入图片描述initExceptionHandlerAdviceCache方法：
在这里插入图片描述言简意赅就是获取所有标有@ControllerAdvice注解的类，并封装成ControllerAdviceBean，随后又去根据这些类创建ExceptionHandlerMethodResolver类，点击进去ExceptionHandlerMethodResolver的构造函数
在这里插入图片描述addMapping方法：
在这里插入图片描述

现在真相几乎大告于天下，这里先引入SpringBoot的异常处理机制@ControllerAdvice+@ExceptionHandler；用起来很简单，在处理类上添加ControllerAdvice注解、在类中方法上添加ExceptionHandler注解并标注捕获的类，那么SpringBoot整个webServlet执行过程中产生的异常都会被这个异常捕获并且返回对应方法的返回值；

所以，我们后续处理无非就是从mapCache中寻找异常对应的方法，因为addMapping方法已经将异常全部封装成exception-Method的map集合形式；再一层层返回给dispatchServlet。

三、自定义优雅的全局异常处理脚手架starter

上述的源码跟踪下来，@ControllerAdvice+@ExceptionHandler模式是不是有一些鸡肋？完全可以定义一个全局的ExceptionHandler类，内部封装自定义异常，再配合EnableAutoConfiguration，达到脚手架starter封装的效果；这里我大概叙述一下思路

自定义异常

定义一个类实现RuntimeException类，同时考虑到国际化的问题，这里加入了枚举类BaseError，并且框架常见异常和业务异常进行分类注册
在这里插入图片描述
在这里插入图片描述

国际化引入

枚举异常基类默认实现I18n接口，并返回resources文件中定义异常文件的文件名
[外链图片转存失败,源站可能有防盗在这里插入!链机制,建描述](https://img-blog议将存csdnimg下cn/d84acd6585a248f29c1d52d1084bbfdf.png在这里插入图片描述在这里插入图片描述

封装基础异常

既然作为脚手架使用，那么系统中常见的异常我们可以封装一下了，我们封装到国际化的Bundle中
在这里插入图片描述然后定义枚举专门去getClass
在这里插入图片描述

封装基础异常扫描器，并注册到ExceptionHandler中

这里用了reflections.getSubTypesOf方法返回类路径基础异常SysBaseEnum类及其子类实现，封装成集合遍历并抽取其中的枚举类，最终枚举集合将注册到exceptionHandler方法中进行捕获
在这里插入图片描述

在这里插入图片描述## 自定义全局异常处理注解以及异常解析器

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
@ResponseBody
public @interface SangExceptionAdvice {}

这里模仿ExceptionHandlerResolver去继承它：

public class SangExceptionHandlerExceptionResolver extends ExceptionHandlerExceptionResolver implements ApplicationContextAware, InitializingBean

核心代码：封装自定义注解@SangExceptionAdvice成为SangExceptionAdviceBean，并重写doResolveHandlerMethodException方法
在这里插入图片描述

项目分享以及改进点

SangExceptionAdviceBean类封装时可以根据设定加入Predicate断言器，配合ConfigurationProperties实现路径匹配捕获异常、全路径异常捕获等等功能在这里插入图片描述改进点：reflections.getSubTypesOf方法反射获取异常基类时有些许不合理，后期慢慢调整，也欢迎大家指教

代码半成品框架开源地址：gitee地址，欢迎大家fork！多沟通，一起学习，一起进步！
如果喜欢本篇文章，点个赞吧！

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/87813.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

华为OD机考算法题：分积木

华为OD机考算法题：分积木

目录 题目部分 解读与分析 代码实现 题目部分 题目分积木难度难题目说明Solo和koko是两兄弟&#xff0c;妈妈给了他们一大堆积木&#xff0c;每块积木上都有自己的重量。现在他们想要将这些积木分成两堆。哥哥Solo负责分配&#xff0c;弟弟koko要求两个人获得的积木总重量“…
阅读更多...
ROS2 从头开始：第 08/8回 - 使用 ROS2 生命周期节点简化机器人软件组件管理

ROS2 从头开始：第 08/8回 - 使用 ROS2 生命周期节点简化机器人软件组件管理

一、说明 欢迎来到我在 ROS2 上的系列的第八部分。对于那些可能不熟悉该系列的人，我已经涵盖了一系列主题，包括 ROS2 简介、如何创建发布者和订阅者、自定义消息和服务创建、
阅读更多...
LLM - Make Causal Mask 构造因果关系掩码

LLM - Make Causal Mask 构造因果关系掩码

目录 一.引言 二.make_causal_mask 1.完整代码 2.Torch.full 3.torch.view 4.torch.masked_fill_ 5.past_key_values_length 6.Test Main 三.总结 一.引言 Causal Mask 主要用于限定模型的可视范围&#xff0c;防止模型看到未来的数据。在具体应用中&#xff0c;Caus…
阅读更多...
Unity之Hololens开发如何实现UI交互

Unity之Hololens开发如何实现UI交互

一.前言 什么是Hololens? Hololens是由微软开发的一款混合现实头戴式设备，它将虚拟内容与现实世界相结合，为用户提供了沉浸式的AR体验。Hololens通过内置的传感器和摄像头，能够感知用户的环境，并在用户的视野中显示虚拟对象。这使得用户可以与虚拟内容进行互动，将数字信…
阅读更多...
内存对齐--面试常问问题和笔试常考问题

内存对齐--面试常问问题和笔试常考问题

1.内存对齐的意义 C 内存对齐的主要意义可以简练概括为以下几点&#xff1a; 提高访问效率&#xff1a;内存对齐可以使数据在内存中以更加紧凑的方式存储&#xff0c;从而提高了数据的访问效率。处理器通常能够更快地访问内存中对齐的数据&#xff0c;而不需要额外的字节偏移计…
阅读更多...
Learn Prompt- Midjourney 图片生成:Image Prompts

Learn Prompt- Midjourney 图片生成:Image Prompts

Prompt 自动生成 前不久&#xff0c;Midjourney 宣布支持图片转 prompt 功能。 原始图片​ blueprint holographic design of futuristic Midlibrary --v 5Prompt 生成​ 直接输入 /describe 指令通过弹出窗口上传图像并发送&#xff0c;Midjourney 会根据该图像生成四种可…
阅读更多...
完成“重大项目”引进签约，美创科技正式落户中国（南京）软件谷

完成“重大项目”引进签约，美创科技正式落户中国（南京）软件谷

近日&#xff0c;美创科技正式入驻中国&#xff08;南京&#xff09;软件谷&#xff0c;并受邀出席中国南京“金洽会"之“雨花台区数字经济创新发展大会”。美创科技副总裁罗亮亮作为代表&#xff0c;在活动现场完成“重大项目”引进签约。 作为国家重要的软件产业与信息服…
阅读更多...
关于ubuntu设置sh文件开机自启动python3和sudo python3问题

关于ubuntu设置sh文件开机自启动python3和sudo python3问题

关于ubuntu设置sh文件开机自启动python3和sudo python3问题 说明系统为 ubuntu22.04python是python3.10.12ros系统为ros2 humble 背景解决方法补充 说明 系统为 ubuntu22.04 python是python3.10.12 ros系统为ros2 humble 背景 将一个py文件设置为开机自启动&#xff0c;服…
阅读更多...
贪心算法总结归类（图文解析）

贪心算法总结归类（图文解析）

贪心算法实际上并没有什么套路可言&#xff0c;贪心的关键就在于它的思想&#xff1a; 如何求出局部最优解&#xff0c;通过局部最优解从而推导出全局最优解 常见的贪心算法题目 455. 分发饼干 这题的解法很符合“贪心”二字 如果使用暴力的解法&#xff0c;那么本题是通过…
阅读更多...
Windows--Python永久换下载源

Windows--Python永久换下载源

1.新建pip文件夹&#xff0c;注意路径 2.在上述文件中&#xff0c;新建文件pip.ini 3.pip.ini记事本打开&#xff0c;输入内容&#xff0c;保存完事。 [global] index-url https://pypi.douban.com/simple
阅读更多...
【记录文】Android自定义Dialog实现圆角对话框

【记录文】Android自定义Dialog实现圆角对话框

圆角的dialog还是蛮常用的&#xff0c;demo中正好用上了 自定义Dialog&#xff0c;代码中可以设置指定大小与位置 /*** author : jiangxue* date : 2023/9/25 13:21* description :圆角的矩形*/internal class RoundCornerView(context: Context,view: Int, StyleRes theme…
阅读更多...
开机自启动Linux and windows

开机自启动Linux and windows

1、背景 服务器由于更新等原因重启&#xff0c;部署到该服务上的响应的应用需要自启动 2、Linux 2.1 方式一 编写启动应用的sh脚本授权该脚本权限 chmod 777 xxx.sh 修改rc.loacl 位置&#xff1a;/etc/rc.local 脚本&#xff1a;sh /home/xxxx.sh & 授权rc.local …
阅读更多...
Elasticsearch—(MacOs)

Elasticsearch—(MacOs)

1⃣️环境准备 准备 Java 环境&#xff1a;终端输入 java -version 命令来确认版本是否符合 Elasticsearch 要求下载并解压 Elasticsearch&#xff1a;前往&#xff08;https://www.elastic.co/downloads/elasticsearch&#xff09;选择适合你的 Mac 系统的 Elasticsearch 版本…
阅读更多...
python使用蓝牙库选择

python使用蓝牙库选择

蓝牙库选择 pybluez 项目地址&#xff1a;https://github.com/pybluez/pybluez 文档地址&#xff1a;https://pybluez.readthedocs.io/en/latest/index.html 蓝牙支持&#xff1a;经典蓝牙 / BLE蓝牙【仅Linux】 平台支持&#xff1a; LinuxRaspberry PimacOSWindows✔️✔️…
阅读更多...
分享40个Python源代码总有一个是你想要的

分享40个Python源代码总有一个是你想要的

分享40个Python源代码总有一个是你想要的 源码下载链接&#xff1a;https://pan.baidu.com/s/1PNR3_RqVWLPzSBUVAo2rnA?pwd8888 提取码&#xff1a;8888 下面是文件的名字。 dailyfresh-天天生鲜 Django-Quick-Start freenom-自动续期域名的脚本 Full Stack Python简体中…
阅读更多...
ADC数模转化器

ADC数模转化器

简介 • ADC &#xff08; Analog-Digital Converter &#xff09;模拟 - 数字转换器 • ADC 可以将引脚上连续变化的模拟电压转换为内存中存储的数字变量&#xff0c;建立模拟电路到数字电路的桥梁 • 12 位逐次逼近型 ADC &#xff0c; 1us 转换时间 &#xff08;12位:分辨率…
阅读更多...
02 MIT线性代数-矩阵消元 Elimination with matrices

02 MIT线性代数-矩阵消元 Elimination with matrices

一, 消元法 Method of Elimination 消元法是计算机软件求解线形方程组所用的最常见的方法。任何情况下&#xff0c;只要是矩阵A可逆&#xff0c;均可以通过消元法求得Axb的解 eg: 我们将矩阵左上角的1称之为“主元一”&#xff08;the first pivot&#xff09;&#xff0c;第…
阅读更多...
MySQL库表操作

MySQL库表操作

开始之前分享一个数据库远程连接工具&#xff1a; Navicat Premium 15 可以远程连接数据库&#xff0c;并且查看表的结构等&#xff0c;非常好用。 SQL语句基础 SQL&#xff1a;结构化查询语言(Structured Query Language)&#xff0c;在关系型数据库上执行数据操作、数据检索…
阅读更多...
景联文数据标注：AI大模型产生幻觉该如何应对？

景联文数据标注：AI大模型产生幻觉该如何应对？

大语言模型在诸多下游任务中展现出令人瞩目的能力&#xff0c;然而在运用过程中仍然存在一些问题。幻觉现象是目前阻碍大模型成功应用的关键问题之一。 什么是大模型幻觉问题&#xff1f; 大模型幻觉问题是指一些人工智能模型在面对某些输入时&#xff0c;会生成不准确、不完整…
阅读更多...
Visual Studio Cpp CLR C# 替换

Visual Studio Cpp CLR C# 替换

1、首先将文件中所有都替换 你需要的名字 替换为整个解决方案 2、新建工程取名 Laserbeam_upper 3、把原工程下的cpp放进来&#xff0c;并改名Laserbeam_upper 4、在这里逐步添加 属性表配置opencv 5、cpp需要修改的两个地方 6、CLR新建和添加 选类库新建、然后直接粘贴进来…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023