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

news/2024/6/16 19:25:32

前情概要

这个问题其实困扰了我一周时间,一周都在 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.mrgr.cn/p/37456052

相关文章

华为设备WLAN基础配置

WLAN基础配置之AP上线 配置WLAN无线网络的第一阶段&#xff0c;AP上线技术&#xff1a; 实验目标&#xff1a;使得AP能够获得来自AC的DHCP地址服务的地址&#xff0c;且是该网段地址池中的IP。 实验步骤&#xff1a; 1.把AC当作三层交换机配置虚拟网关 sys Enter system view…

mingw 编译生成的dll 如何在vs中使用

1.mingw编译生成dll gcc -shared -o libtest.dll -Wl,--output-def,libtest.def,--out-implib,dlltest.a xxx.o xxx.o有2个文件是我们需要的 2.vs 使用lib.exe将XXX.def文件(函数定义文件)生成为.lib导入库 (1)打开VS 工具-》命令行-》powershell (想自己去VS安装目录下…

P6【知识点】【数据结构】【树tree】C++版

树是由一个集合以及在该集合上定义的一种关系构成的&#xff0c;集合中的元素称为树的结点&#xff0c;所定义的关系称为父子关系。父子关系在树的结点之间建立了一个层次结构&#xff0c;在这种层次结构中有一个结点具有特殊的地位&#xff0c;这个结点称为该树的根结点。 二叉…

MySQL-10.索引优化与查询优化

C-10.索引优化与查询优化 都有那些维度可以进行数据库调优?简言之:索引失效,没有充分利用到索引 -- 索引建立 关联查询太多JOIN(设计缺陷或不得已的需求) -- SQL优化 服务器调优及各个参数设置(缓冲,线程数等) -- 调整my.cnf 数据过多 -- 分库分表关于数据库调优的知识点非…

C++ TCP发送Socket数据

DEVC需要加入ws2_32库 #include <iostream> #include <winsock2.h>#pragma comment(lib, "ws2_32.lib")void sendData(const char* ip, int port, const char* data) {WSADATA wsaData;SOCKET sockfd;struct sockaddr_in server_addr;// 初始化Winsock…

jiebaNET中文分词器

最近我接手了一个有趣的需求&#xff0c;需要对用户评价进行分词&#xff0c;进行词频统计和情绪分析&#xff0c;并且根据词频权重制成词云图以供后台数据统计&#xff0c;于是我便引入了jieba分词器,但是我发现网上关于jiebaNET相关文档实在太少了&#xff0c;甚至连配置文件…

宇宙“超级地球”系列,你知道几个?

在宇宙中&#xff0c;可能存在着类地行星&#xff0c;这样的行星可能同样也拥有适宜生命存在的条件。银河系大约有60亿颗类地行星。 开普勒442b 这是脱离太阳系以后&#xff0c;人类发现的第二颗离地球最近的类地行星。开普勒442b这颗类地行星位于天鹅座&#xff0c;离地球约有…

关于动态库

windows下常用: 1.静态链接lib库 2.导入库.lib和动态链接库dll 配合使用 动态库和静态库内容查看 vs studio提供dumpbin.exe 使用: 1.打开vs命令行工具 2.输入指令 程序|指令|输出路径指令+相对路径(或者绝对路径,相对路径“./”表示当前路径,不要忘记写)|要进行导出的文…

Android 逆向学习【1】——版本/体系结构/代码学习

#Android 历史版本 参考链接&#xff1a;一篇文章让你了解Android各个版本的历程 - 知乎 (zhihu.com) 三个部分&#xff1a;api等级、版本号、代号&#xff08;这三个东西都是指的同一个系统&#xff09; API等级&#xff1a;在APP开发的时候写在清单列表里面的 版本号&…

Centos7.9安装卸载Docker

目录1、官网安装1.1、卸载旧版本Docker1.2、通过rpm仓库安装1.2.1、设置仓库1.2.2、安装Docker Engine1.2.3、启动Docker1.2.4、验证安装1.3、通过rpm软件包安装1.4、通过便捷脚本安装2、yum安装2.1、安装docker-ce以及客户端2.2、启动docker2.3、配置镜像加速3、卸载Docker3.1…

必应崩了?

目录 今天使用必应发现出现了不能搜索&#xff0c;弹出乱码的情况。 搜了一下&#xff0c;发现其他人也出现了同样的问题。 使用Edge浏览器的话&#xff0c;可以试着改一下DNS&#xff0c;有可能会恢复正常&#xff08;等官方修复了记得改回来&#xff09; 使用谷歌浏览器打开…

文本信息的二维码怎么做?在线制作文本二维码的3个步骤

现在通过二维码来展示文本信息是很常见的一种方式&#xff0c;可以将信息编辑好排版后生成二维码&#xff0c;其他人可以通过扫描生成的二维码来获取文本信息。这种方式传递起来更加的简单快捷&#xff0c;而且二维码可以长期提供内容展示效果降低了推广成本&#xff0c;在很多…

多线程讲解(详解)

目录 什么是多线程&#xff1f; 为什么要使用多线程&#xff1f; 线程的创建 使用Thread实现 从以上代码我们梳理一下多线程创建步骤&#xff1a; 注意&#xff1a; 小示例 首先&#xff0c;引入依赖 然后&#xff0c;按照我们刚刚说的构建多线程的步骤进行构建&#…

算法练习第23天|131.分割回文串、93.复原IP地址

131.分割回文串 131. 分割回文串 - 力扣&#xff08;LeetCode&#xff09;https://leetcode.cn/problems/palindrome-partitioning/description/ 题目描述&#xff1a; 给你一个字符串 s&#xff0c;请你将 s 分割成一些子串&#xff0c;使每个子串都是 回文串 。返回 s 所有…

【C++】位图/布隆过滤器+海量数据处理

目录 一、位图 1.1 位图的概念 1.2 位图的实现 1.3 位图的应用&#xff08;面试题&#xff09; 二、布隆过滤器 2.1 布隆过滤器的引入 2.2 布隆过滤器概念 2.3 布隆过滤器的插入和查找 2.4 布隆过滤器的实现 2.5 布隆过滤器的优点和缺陷 2.6 布隆过滤器的应用&#…

Django自定义命令

Django自定义命令 我们知道&#xff0c;Django内部内置了很多命令&#xff0c;例如 python manage.py runserver python manage.py makemigrations python manage.py migrate我们可以在python控制台中查看所有命令 我们也可以自定义命令&#xff0c;让python manage.py执行…

GPT‑4o普通账户也可以免费用

网址 https://chatgpt.com/ 试了一下&#xff0c;免费的确实显示GPT‑4o的模型&#xff0c;问了一下可以联网&#xff0c;不知道能不能通过插件出图 有兴趣的可以试试

React中显示数据

SX 会让你把标签放到 JavaScript 中。而大括号会让你 “回到” JavaScript 中&#xff0c;这样你就可以从你的代码中嵌入一些变量并展示给用户。例如&#xff0c;这将显示 user.name&#xff1a; return (<h1>{user.name}</h1> ); 你还可以将 JSX 属性 “转义到 …

使用xsd验证xml格式的正确性

1.1 基础知识介绍 XML简介&#xff1a;XML是可扩展标记语言&#xff08;eXtensible Markup Language&#xff09;的缩写&#xff0c;它是一种数据表示格式&#xff0c;可以描述非常复杂的数据结构&#xff0c;常用于传输和存储数据。xml文件、xml消息。XSD简介&#xff1a;是X…

G2303高一上照片

![image](https://img20 ![image](https://img20![image](https://img20