关于如何创建一个可配置的 SpringBoot Web 项目的全局异常处理

前情概要

这个问题其实困扰了我一周时间,一周都在 Google 上旅游,我要如何动态的设置 @RestControllerAdvice 里面的 basePackages 以及 baseClasses 的值呢?经过一周的时间寻求无果之后打算决定放弃的我终于找到了一些关键的线索。
当然在此也感激这篇文章:@ControllerAdvice的用法和原理探究
其实我们只要有调试源码的习惯,也能够发现这些东西,可能有时候就是差那么一点动力吧,比如我,就想直接看现成的解析,没有那么主动去调试源码,哈哈哈。

发现了关键问题之后

其实从上面这篇文章里我提取到的关键信息如下:

@Bean
public 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;
}

PS:😓 后来我才发现这里面的 configureHandlerExceptionResolversaddDefaultHandlerExceptionResolvers extendHandlerExceptionResolvers 这三个方法是源码里面的,我还一直在找这个博主有关这两个方法的实现。

OK 回来,这里面的关键就是我需要往 Spring IOC 里面添加一个 HandlerExceptionResolverComposite ,并且设置它的处理器列表就好了。
于是我就顺着这个思路开始捣鼓,OK,下面是第一个版本的代码:

版本一

Starter 配置类(关键代码)

@Bean
public HandlerExceptionResolver handlerExceptionResolver() {final HandlerExceptionResolverComposite composite = new HandlerExceptionResolverComposite();final List<HandlerExceptionResolver> resolves =Collections.singletonList(new RestGlobalExceptionHandler(starterProperties));composite.setOrder(0);composite.setExceptionResolvers(resolves);return composite;
}

Handler 处理器类(关键代码)

public final class RestGlobalExceptionHandler extends DefaultHandlerExceptionResolver implementsHandlerExceptionResolver {@Overridepublic ModelAndView resolveException(final HttpServletRequest request,final HttpServletResponse response,final Object handler,final Exception ex) {ModelAndView view = new ModelAndView();if (ex instanceof BusinessException) {printToResponse(response, handlerError(request, (BusinessException) ex));} else if (ex instanceof MethodArgumentNotValidException) {printToResponse(response, handlerError(request, (MethodArgumentNotValidException) ex));} else {// use default exception handlerview = super.doResolveException(request, response, handler, ex);}if (Objects.isNull(view)) {// use finally exception handlerview = new ModelAndView();printToResponse(response, handlerError(request, ex));}return view;}// handlerError 以及 printToResponse 方法省略
}

这里说下为什么就要继承 DefaultHandlerExceptionResolver以及实现HandlerExceptionResolver接口:
实现接口:因为 HandlerExceptionResolverComposite类的 resolves 列表就是一个List<HandlerExceptionResolver>, 所以我们自定义的 Handler 需要实现这个接口。
继承 DefaultHandlerExceptionResolver类:因为可以看到我重写了 resolveException这个方法

但是这还存在问题:

// 这个是 DefaultHandlerExceptionResolver 的 doResolveException 方法,你们实践第一版的时候会发现,有一些异常信息被这方法处理了,但是我发现如果使用 @RestControllerAdvice 结合 @ExceptionHandler 的话,优先是考虑我们自定义的异常处理的,于是有了下面的版本二。
@Nullableprotected ModelAndView doResolveException(HttpServletRequest request, HttpServletResponse response, @Nullable Object handler, Exception ex) {try {if (ex instanceof HttpRequestMethodNotSupportedException) {return this.handleHttpRequestMethodNotSupported((HttpRequestMethodNotSupportedException)ex, request, response, handler);}if (ex instanceof HttpMediaTypeNotSupportedException) {return this.handleHttpMediaTypeNotSupported((HttpMediaTypeNotSupportedException)ex, request, response, handler);}if (ex instanceof HttpMediaTypeNotAcceptableException) {return this.handleHttpMediaTypeNotAcceptable((HttpMediaTypeNotAcceptableException)ex, request, response, handler);}if (ex instanceof MissingPathVariableException) {return this.handleMissingPathVariable((MissingPathVariableException)ex, request, response, handler);}if (ex instanceof MissingServletRequestParameterException) {return this.handleMissingServletRequestParameter((MissingServletRequestParameterException)ex, request, response, handler);}if (ex instanceof ServletRequestBindingException) {return this.handleServletRequestBindingException((ServletRequestBindingException)ex, request, response, handler);}if (ex instanceof ConversionNotSupportedException) {return this.handleConversionNotSupported((ConversionNotSupportedException)ex, request, response, handler);}if (ex instanceof TypeMismatchException) {return this.handleTypeMismatch((TypeMismatchException)ex, request, response, handler);}if (ex instanceof HttpMessageNotReadableException) {return this.handleHttpMessageNotReadable((HttpMessageNotReadableException)ex, request, response, handler);}if (ex instanceof HttpMessageNotWritableException) {return this.handleHttpMessageNotWritable((HttpMessageNotWritableException)ex, request, response, handler);}if (ex instanceof MethodArgumentNotValidException) {return this.handleMethodArgumentNotValidException((MethodArgumentNotValidException)ex, request, response, handler);}if (ex instanceof MissingServletRequestPartException) {return this.handleMissingServletRequestPartException((MissingServletRequestPartException)ex, request, response, handler);}if (ex instanceof BindException) {return this.handleBindException((BindException)ex, request, response, handler);}if (ex instanceof NoHandlerFoundException) {return this.handleNoHandlerFoundException((NoHandlerFoundException)ex, request, response, handler);}if (ex instanceof AsyncRequestTimeoutException) {return this.handleAsyncRequestTimeoutException((AsyncRequestTimeoutException)ex, request, response, handler);}} catch (Exception var6) {Exception handlerEx = var6;if (this.logger.isWarnEnabled()) {this.logger.warn("Failure while trying to resolve exception [" + ex.getClass().getName() + "]", handlerEx);}}return null;}

版本二

这里主要解决的是,有一些自定义的异常处理提前被 DefaultHandlerExceptionResolver 类的 doResolveException 的方法处理了,了解 Spring IOC 容器的小伙伴应该都知道,这很容易让我们联想起,Bean 的顺序问题,那么我们哪里设置了我们自定义 Bean 的顺序呢,也就是使用 @Order 或者代码里面设置了,没错,就是这里:

@Bean
public HandlerExceptionResolver handlerExceptionResolver() {final HandlerExceptionResolverComposite composite = new HandlerExceptionResolverComposite();final List<HandlerExceptionResolver> resolves =Collections.singletonList(new RestGlobalExceptionHandler(starterProperties));// 这里,这里,这里composite.setOrder(0);composite.setExceptionResolvers(resolves);return composite;
}

但是我们要怎么知道我们具体要设置的值是什么呢?大家都知道在使用 Spring 的时候设置 Bean 的 Order 值越小那么它的优先级越高,所以我尝试着把 0 换成 -1,试试,结果还真成功了,我们自定义的优先执行了,但是作为一个搞技术的人,还是想摸清楚它的原理吧,为啥设置成 -1 就可以了呢?
一开始没有啥头绪,不知道怎么去查找 Spring 配置异常处理这块( 主要还是源码不熟 -_-! ),但后面想一想,把目标换一下不就好了,是因为 DefaultHandlerExceptionResolver 这个 Bean 的原因,那我就找 Spring 是哪里把他放进 Spring IOC 容器的不就好了。因为我使用的框架是 SpringBoot,所以相关的配置肯定在 XXXAutoConfiguration 类里面,于是就找找找…

  • WebMvcAutoConfiguration 没有…
  • DispatcherServletAutoConfiguration 没有…

好吧最后还是借助 IntelliJ 这个工具,因为我们自定义的是一个 HandlerExceptionResolverComposite Bean,所以我们进入这个类:
在这里插入图片描述
发现它实现了 HandlerExceptionResolver 这个接口,一般 Spring 都会使用接口作为一个接收实现的变量,然后 return 回去交给 Spring IOC 容器,所以我们再进入这个接口:
在这里插入图片描述
利用 IntelliJ 的工具,找到哪里注入了这个 Bean:
在这里插入图片描述
在这里插入图片描述
进去之后发现了跟我们类似的代码:
在这里插入图片描述
看到 618 行的 this.addDefaultHandlerExceptionResolvers(exceptionResolvers, contentNegotiationManager); 吗?这个就是添加 DefaultHandlerExceptionResolver 的地方,并且设置的 Order 是 0,如果 Debug 的话你会发现这个方法除了加入 DefaultHandlerExceptionResolver 之外,还会加入自定义使用注解的异常处理器,但是它在 List 中的顺序比 DefaultHandlerExceptionResolver 靠前,所以它会优先使用自定义的处理器处理,但是使用注解是 Spring 自己处理的,然后加入这个 List 中,我们没办法去修改这个 List,但是我们知道了可以自定义 HandlerExceptionResolverComposite 并且把它的 Order 设置成比 0 小就好了,所以这就是为什么我们设置成 -1 就可以覆盖 DefaultHandlerExceptionResolver 的行为的原因。

所有的代码已经放在我的代码仓库:码云,欢迎来访以及给我小⭐⭐

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

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

相关文章

html5 笔记01

01 表单类型和属性 input的type属性 单行文本框: typetext 电子邮箱 : typeemail 地址路径 : type url 定义用于输入数字的字段: typenumber 手机号码: typetel 搜索框 : typesearch 定义颜色选择器 : typecolor 滑块控件 : typerange 定义日期 :typedate 定义输入时间的控件…

CR80清洁卡都能用在什么地方?

CR80清洁卡&#xff08;也被称为ISO 7810 ID-1清洁卡&#xff09;的规格确实使其在各种需要读取磁条或接触式智能卡的设备中都有广泛的用途。这些设备包括但不限于&#xff1a; ATM自动终端机&#xff1a;当ATM机的磁条读卡器出现故障或读卡不灵敏时&#xff0c;可以使用CR80清…

第三期【数据库主题文档上传激励活动】已开启!快来上传文档赢奖励

2023年9月、11月&#xff0c;墨天轮社区相继举办了第一期与第二期【数据库主题文档上传激励活动】&#xff0c;众多用户积极参与、上传了大量优质的数据库主题干货文档&#xff0c;在记录经验的同时也为其他从业者带来了参考帮助&#xff0c;这正实现了“乐知乐享、共同成长”的…

以及Spring中为什么会出现IOC容器?@Autowired和@Resource注解?

以及Spring中为什么会出现IOC容器&#xff1f;Autowired和Resource注解&#xff1f; IOC容器发展史 没有IOC容器之前 首先说一下在Spring之前&#xff0c;我们的程序里面是没有IOC容器的&#xff0c;这个时候我们如果想要得到一个事先已经定义的对象该怎么得到呢&#xff1f;…

STM32自己从零开始实操02:输入部分原理图

一、触摸按键 1.1指路 项目需求&#xff1a; 4个触摸按键&#xff0c;主控芯片 TTP224N-BSBN&#xff08;嘉立创&#xff0c;封装 TSSOP-16&#xff09;&#xff0c;接入到 STM32 的 PE0&#xff0c;PE1&#xff0c;PE2&#xff0c;PE3。 1.2走路 1.2.1数据手册重要信息提…

AI--构建检索增强生成 (RAG) 应用程序

LLM 所实现的最强大的应用之一是复杂的问答 (Q&A) 聊天机器人。这些应用程序可以回答有关特定源信息的问题。这些应用程序使用一种称为检索增强生成 (RAG) 的技术。 典型的 RAG 应用程序有两个主要组件 索引&#xff1a;从源中提取数据并对其进行索引的管道。这通常在线下…

CTFshow之文件上传web入门151关-161关解密。包教包会!!!!

这段时间一直在搞文件上传相关的知识&#xff0c;正好把ctf的题目做做写写给自字做个总结&#xff01; 不过有一个确定就是所有的测试全部是黑盒测试&#xff0c;无法从代码层面和大家解释&#xff0c;我找个时间把upload-labs靶场做一做给大家讲讲白盒的代码审计 一、实验准…

保研笔试复习——nju

文章目录 一、单选计算机网络计算机组成原理数字逻辑电路数据结构操作系统微机系统 多选题计算机网络计算机系统结构操作系统 免责声明&#xff1a;题目源自于网络&#xff0c;侵删。 就在今天2024-5-18&#xff0c;考的题下面的只有一道AVL的原题&#xff0c;其他都不是原题&a…

【C++初阶】--- C++入门(上)

目录 一、C的背景及简要介绍1.1 什么是C1.2 C发展史1.3 C的重要性 二、C关键字三、命名空间2.1 命名空间定义2.2 命名空间使用 四、C输入 & 输出 一、C的背景及简要介绍 1.1 什么是C C语言是结构化和模块化的语言&#xff0c;适合处理较小规模的程序。对于复杂的问题&…

Docker Hub注册及上传自定义镜像

说明&#xff1a;本文介绍如何注册Docker Hub&#xff0c;及将自己自定义镜像上传到Docker Hub上&#xff1b; 注册Docker Hub 浏览器输入&#xff1a;http://hub.docker.com/&#xff0c;进入Docker Hub官网 注&#xff1a;如果无法访问&#xff0c;可在GitHub上下载一个Ste…

全面掌握深度学习:从基础到前沿

引言&#xff1a;深入探索深度学习的世界 在人工智能&#xff08;AI&#xff09;的广阔领域中&#xff0c;深度学习已经成为最令人瞩目的技术之一。它不仅推动了科技的许多突破性进展&#xff0c;也正在改变我们的工作和生活方式。本博客旨在全面总结深度学习的关键知识点&…

分类和品牌关联

文章目录 1.数据库表设计1.多表关联设计2.创建表 2.使用renren-generator生成CRUD1.基本配置检查1.generator.properties2.application.yml 2.生成代码1.进入localhost:81生成代码2.将main目录覆盖sunliving-commodity模块的main目录 3.代码检查1.注释掉CategoryBrandRelationC…

Map遍历、反射、GC

map的遍历 用foreach遍历 HashMap<Character,Integer> map new HashMap<>();map.put(A,2);map.put(B,3);map.put(C,3);for (Map.Entry<Character,Integer> entry: map.entrySet()) {char key entry.getKey();int value entry.getValue();System.out.prin…

HTML | 在IDEA中配置Tomcat时遇到的一些问题的解决办法

目录 IDEA中没有web文件夹目录 Tomcat在哪里配置服务器 IDEA中没有web文件夹目录 首先说在IDEA中没有web这个文件夹的解决办法 在菜单栏中帮助中点击查找操作搜索添加框架支持&#xff08;因为我的IDEA会出现无法点击这个操作&#xff0c;所以我对该操作添加了快捷键&#xf…

防火墙技术基础篇:解析防火墙的网络隔离机制

防火墙技术基础篇&#xff1a;解析防火墙的网络隔离机制 网络安全在现代社会中扮演着重要的角色&#xff0c;保护网络系统、用户和数据免受未经授权的访问、破坏和窃取。个人、企业和国家都需要加强网络安全意识&#xff0c;采取有效措施保护自身的网络安全。随着网络攻击手段…

如何提交网站到谷歌网站收录?

其实就那么几个步骤&#xff0c;要做谷歌那肯定是需要一个谷歌账号的&#xff0c;然后找到Google Search Console这个谷歌的官方平台&#xff0c;这是最权威的可以统计来自谷歌流量的平台了&#xff0c;毕竟是谷歌自家的&#xff0c;肯定也不可能作假&#xff0c;然后就是跟着平…

【详细讲解】二叉树的层序遍历

广度优先搜索 总结一下&#xff0c;思路就是&#xff1a; 加入元素&#xff0c;记录size&#xff0c;size就是当前这一层的元素个数。不断弹出元素&#xff0c;size - 1&#xff0c; 同时加入弹出元素的左右孩子&#xff0c;直到size0&#xff0c;说明当前层已经完全遍历完&am…

【设计模式深度剖析】【A】【创建型】【对比】| 工厂模式重点理解产品族的概念

回 顾&#xff1a;创建型设计模式 1.单例模式&#x1f448;️ 2.工厂方法模式&#x1f448;️ 3.抽象工厂模式&#x1f448;️ 4.建造者模式&#x1f448;️ 5.原型模式&#x1f448;️ &#x1f448;️上一篇:原型模式 | &#x1f449;️下一篇:代理模式 目录…

Vue3中为Ant Design Vue中table的checkbox加tooltip、popover

问题的产生 Vue版本&#xff1a;3.3.13 ant-design-vue 版本&#xff1a;3.x.x 在工作时遇到一个场景&#xff0c;需要在 ant-table 的 checkbox 被禁用的时候提示原因&#xff0c;但是在 ant-design-vue 文档中并没有发现有相关介绍。 首先我去看了issue中是否有提到相关问题…

Oracle Graph 入门 - RDF 知识图谱

Oracle Graph 入门 - RDF 知识图谱 0. 引言1. 查看 RDF Semantic Graph 安装情况2. 创建一个语义网络4. 创建一个模型5. 加载 RDF 文件6. 配置 W3C 标准的 SPARQL 端点 0. 引言 Oracle Graph 的中文资料太少了&#xff0c;只能自己参考英文资料整理一篇吧。 Oracle 数据库包括…