常见的SpringMVC故障排查及解决方案是什么

本篇文章给大家分享的是有关常见的SpringMVC故障排查及解决方案是什么,小编觉得挺实用的,因此分享给大家学习,希望大家阅读完这篇文章后可以有所收获,话不多说,跟着小编一起来看看吧。

一、前言

相信我们每个人在SpringMVC开发中,都遇到这样的问题:当我们的代码正常运行时,返回的数据是我们预期格式,比如json或xml形式,但是一旦出现了异常(比如:NPE或者数组越界等等),返回的内容确实服务端的异常堆栈信息,从而导致返回的数据不能使客户端正常解析; 很显然,这些并不是我们希望的结果。

我们知道,一个较为常见的系统,会涉及控制层,服务(业务)层、缓存层、存储层以及接口调用等,其中每一个环节都不可避免的会遇到各种不可预知的异常需要处理。如果每个步骤都单独try..catch会使系统显的很杂乱,可读性差,维护成本高;常见的方式就是,实现统一的异常处理,从而将各类异常从各个模块中解耦出来;

二、常见全局异常处理

在Spring中常见的全局异常处理,主要有三种:

(1)注解ExceptionHandler

(2)继承HandlerExceptionResolver接口

(3)注解ControllerAdvice

在后面的讲解中,主要以HTTP错误码:400(请求无效)和500(内部服务器错误)为例,先看一下测试代码以及没有任何处理的返回结果,如下:

常见的SpringMVC故障排查及解决方案是什么

(图1:测试代码)

常见的SpringMVC故障排查及解决方案是什么

(图2:没有异常的错误返回)

2.1 注解ExceptionHandler

注解ExceptionHandler作用对象为方法,最简单的使用方法就是放在controller文件中,详细的注解定义不再介绍。如果项目中有多个controller文件,通常可以在baseController中实现ExceptionHandler的异常处理,而各个contoller继承basecontroller从而达到统一异常处理的目的。因为比较常见,简单代码如下:

常见的SpringMVC故障排查及解决方案是什么

(图3:Controller中的ExceptionHandler使用)

在返回异常时,添加了所属的类名,便于大家记忆理解。运行看一下结果:

常见的SpringMVC故障排查及解决方案是什么

(图4:添加ExceptionHandler之后的结果) 

  • 优点:ExceptionHandler简单易懂,并且对于异常处理没有限定方法格式;

  • 缺点:由于ExceptionHandler仅作用于方法,对于多个controller的情况,仅为了一个方法,所有需要异常处理的controller都继承这个类,明明不相关的东西,强行关联,不太好。

2.2 注解ControllerAdvice

这里虽说是ControllerAdvice注解,其实是其与ExceptionHandler的组合使用。在上文中可以看到,单独使用@ExceptionHandler时,其必须在一个Controller中,然而当其与ControllerAdvice组合使用时就完全没有了这个限制。换句话说,二者的组合达到的全局的异常捕获处理。

常见的SpringMVC故障排查及解决方案是什么

(图5:注解ControllerAdvice异常处理代码)

在运行之前,需将之前Controller中的ExceptionHandler注释掉,测试结果如下:

常见的SpringMVC故障排查及解决方案是什么

(图6:注解ControllerAdvice异常处理结果) 

通过上面结果可以看到,异常处理确实已经变更为ExceptionHandlerAdvice类。这种方法将所有的异常处理整合到一处,去除了Controller中的继承关系,并且达到了全局捕获的效果,推荐使用此类方式;

2.3 实现HandlerExceptionResolver接口

HandlerExceptionResolver本身SpringMVC内部的接口,其内部只有resolveException一个方法,通过实现该接口我们可以达到全局异常处理的目的。

常见的SpringMVC故障排查及解决方案是什么

(图7:实现HandlerExceptionResolver接口)

同样在执行之前,将上述两个方法的异常处理都注释掉,运行结果如下:

常见的SpringMVC故障排查及解决方案是什么

(图8:实现HandlerExceptionResolver接口运行结果) 

可以看到500的异常处理已经生效了,但是400的异常处理却没有生效,并且根没有异常前的返回结果一样。这是怎么回事呢?不是说可以做到全局异常处理的么?没办法要想知道问题的原因,我们只能刨根问底,往Spring的祖坟上刨,下面我们结合Spring的源码调试,去需要原因。

三、Spring中异常处理源码分析

大家都知道,在Spring中第一个收到请求的类就是DispatcherServlet,而该类中核心的方法就是doDispatch,我们可以在该类中打断点,进而一步步跟进异常处理。

3.1 HandlerExceptionResolver实现类处理流程

参照如下的跟进步骤,在processHandlerException中断点,跟踪的结果如下图:

常见的SpringMVC故障排查及解决方案是什么

常见的SpringMVC故障排查及解决方案是什么

(图9:processHandlerException断点) 

可以看到在图中箭头【1】处,在遍历 handlerExceptionResolvers 进而来处理异常,而在箭头【2】处,看到handlerExceptionResolvers 中一共有4个元素,其中最后一个就是2.3方法定义的异常处理类

当前的请求query请求,根据上述现象可以推测出,该异常处理应该是在前3个异常处理中被处理了,从而跳过我们自定义的异常;带着这样的猜测,我们F8继续跟进,可以跟踪到该异常是被第三个,即DefaultHandlerExceptionResolver所处理。

  • DefaultHandlerExceptionResolver :SpringMVC默认装配了DefaultHandlerExceptionResolver,该类的doResolveException方法中主要对一些特殊的异常进行处理,并将这类异常转换为相应的响应状态码。而query请求触发的异常为MissingServletRequestParameterException,其恰好也是被DefaultHandlerExceptionResolver所针对的异常,故会在该类中被异常捕获。

到此真相大白了,可以看到我们的自定义类MyHandlerExceptionResolver确实可以做到全局处理异常,只不过对于query请求的异常,中间被DefaultHandlerExceptionResolver插了一脚,所以就跳过了MyHandlerExceptionResolver类的处理,从而出现400的返回结果。而对于calc请求,中间没有阻拦,所以就达到了预期效果。

3.2 三类异常的处理顺序

到此我们一共介绍了3类全局异常处理,按照上面的分析可以看出,实现HandlerExceptionResolver接口的方式是排在最后处理,那么@ExceptionHandler和@ControllerAdvice这两个的顺序谁先谁后呢? 将三类异常处理全部打开(之前注释掉了),运行一下看看效果:

常见的SpringMVC故障排查及解决方案是什么

(图10:异常处理全放开运行结果) 

通过现象可以看到,Controller中单独@ExceptionHandle异常处理排在了首位,@ControllerAdvice排在了第二位。严谨的童鞋可以写个Controller02,将query和calc复制过去,异常处理就不要了,这样请求c02的方法时,异常捕获的所属类名就都是@ControllerAdvice所在类了。

以上都是我们根据现象得到的结论,下面去Spring源码去找“证据”。在图9中,handlerExceptionResolvers中有4类处理器,而@ExceptionHandler和@ControllerAdvice的处理就在第一个ExceptionHandlerExceptionResolver中(之前断点跟进即可获知)。继续跟进直到进入ExceptionHandlerExceptionResolver类的doResolveHandlerMethodException方法,这里的HandlerMethod就是Spring将HTTP请求映射到指定Controller中的方法,而Exception就是需要被捕获的异常;继续跟进,看看使用这两个参数到底干了什么事儿。

常见的SpringMVC故障排查及解决方案是什么

(图11:doResolveHandlerMethodException断点) 

继续跟进getExceptionHandlerMethod方法,发现有两个变量可能就是问题的关键:exceptionHandlerCache和exceptionHandlerAdviceCache。首先,两者的变量名很值得怀疑;其次,前者在代码中看,明显是通过类作为key,从而得到一个处理器(resolver),这恰好Controller中@ExceptionHandler处理规则相吻合;最后,这两个Cache的处理顺序,也符合之前的得到的结论。正如之前猜测的那样,Spring中确实是优先根据Controller类名去查找对应的ExceptionHandler,没有找到的话,再进行@ControllerAdvice异常处理。

常见的SpringMVC故障排查及解决方案是什么

(图12:两个异常处理Cache )

如有兴趣可继续深入挖掘Spring的源码,这里针对 ExceptionHandlerExceptionResolver 简单做个总结:

  • exceptionHandlerCache中包含Controller中的ExceptionHandler异常处理,处理时通过HandlerMethod得到Controller,进而再找到异常处理方法,需要注意的是,其是在异常处理过程中put值的;

  • exceptionHandlerAdviceCache则是在项目启动时初始化的,大概思路是找到带有@ControllerAdvice注解的bean,从而缓存bean中的ExceptionHandler,在异常处理时需要对齐遍历查找处理,进而达到全局处理的目的。

3.3 解决方案

介绍了这么多,简单画张图总结一下。蓝色的部分是Spring默认添加的3类异常处理器,黄色部分是我们添加的异常处理以及其所被调用的位置和顺序。看看哪里还有不太清楚的,往回翻翻看(ResponseStatusExceptionResolver是针对@ResponseStatus注解,这里不再详述)。

常见的SpringMVC故障排查及解决方案是什么

(图13:异常总结)

如果有需要将MyHandlerExceptionResolver提前处理,甚至排在ExceptionHandlerExceptionResolver之前,能做到么?答案是肯定的,在Spring中如果想将MyHandlerExceptionResolver异常处理提前,需要再实现一个Ordered接口,实现里面的getOrder方法即可,这里返回-1,将其放在最上面,这次咸鱼终于可以翻身了。

常见的SpringMVC故障排查及解决方案是什么

(图14:实现Ordered接口)

运行看一下结果是不是符合预期,提醒一下,我们三个异常处理都是生效的,如下图: 

常见的SpringMVC故障排查及解决方案是什么

(图15:实现Ordered接口运行结果)

以上就是常见的SpringMVC故障排查及解决方案是什么,小编相信有部分知识点可能是我们日常工作会见到或用到的。希望你能通过这篇文章学到更多知识。更多详情敬请关注编程之家行业资讯频道。

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐


这篇文章主要介绍了spring的事务传播属性REQUIRED_NESTED的原理介绍,具有一定借鉴价值,需要的朋友可以参考下。下面就和我一起来看看吧。传统事务中回滚点的使...
今天小编给大家分享的是一文解析spring中事务的传播机制,相信很多人都不太了解,为了让大家更加了解,所以给大家总结了以下内容,一起往下看吧。一定会有所收获...
这篇文章主要介绍了SpringCloudAlibaba和SpringCloud有什么区别,具有一定借鉴价值,需要的朋友可以参考下。下面就和我一起来看看吧。Spring Cloud Netfli...
本篇文章和大家了解一下SpringCloud整合XXL-Job的几个步骤。有一定的参考价值,有需要的朋友可以参考一下,希望对大家有所帮助。第一步:整合pom文件,在S...
本篇文章和大家了解一下Spring延迟初始化会遇到什么问题。有一定的参考价值,有需要的朋友可以参考一下,希望对大家有所帮助。List 坑列表 = new ArrayList(2);...
这篇文章主要介绍了怎么使用Spring提供的不同缓存注解实现缓存的相关知识,内容详细易懂,操作简单快捷,具有一定借鉴价值,相信大家阅读完这篇...
本篇内容主要讲解“Spring中的@Autowired和@Resource注解怎么使用”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学...
今天小编给大家分享一下SpringSecurity怎么定义多个过滤器链的相关知识点,内容详细,逻辑清晰,相信大部分人都还太了解这方面的知识,所以分享这篇文章给大家
这篇文章主要介绍“Spring的@Conditional注解怎么使用”的相关知识,小编通过实际案例向大家展示操作过程,操作方法简单快捷,实用性强,希望这篇“Spring的@Con...
这篇文章主要介绍了SpringCloudGateway的熔断限流怎么配置的相关知识,内容详细易懂,操作简单快捷,具有一定借鉴价值,相信大家阅读完这篇SpringCloud&nb...
今天小编给大家分享一下怎么使用Spring解决循环依赖问题的相关知识点,内容详细,逻辑清晰,相信大部分人都还太了解这方面的知识,所以分享这篇文章给大家参考
这篇文章主要介绍“Spring事务及传播机制的原理及应用方法是什么”的相关知识,小编通过实际案例向大家展示操作过程,操作方法简单快捷,实用性强,希望这篇“Sp...
这篇“SpringCloudAlibaba框架实例应用分析”文章的知识点大部分人都不太理解,所以小编给大家总结了以下内容,内容详细,步骤清晰,具有一定的借鉴价
本篇内容主要讲解“SpringBoot中怎么使用SpringMVC”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习...
这篇文章主要介绍“SpringMVC适配器模式作用范围是什么”的相关知识,小编通过实际案例向大家展示操作过程,操作方法简单快捷,实用性强,希望这篇“SpringMVC
这篇“导入SpringCloud依赖失败如何解决”文章的知识点大部分人都不太理解,所以小编给大家总结了以下内容,内容详细,步骤清晰,具有一定的借鉴价值,希望大家...
这篇文章主要讲解了“SpringMVC核心DispatcherServlet处理流程是什么”,文中的讲解内容简单清晰,易于学习与理解,下面请大家跟着小编的思路慢慢深入,一起来
今天小编给大家分享一下SpringMVCHttpMessageConverter消息转换器怎么使用的相关知识点,内容详细,逻辑清晰,相信大部分人都还太了解这方面的知识,所以...
这篇文章主要介绍“Spring框架实现依赖注入的原理是什么”的相关知识,小编通过实际案例向大家展示操作过程,操作方法简单快捷,实用性强,希望这篇“Spring框架...
本篇内容介绍了“Spring单元测试控制Bean注入的方法是什么”的有关知识,在实际案例的操作过程中,不少人都会遇到这样的困境,接下来就让小编带领大家学习一下