SpringMVC之异常处理解读

2023-03-21 11:03:28 异常 解读 SpringMvc

背景

我们的代码中,总是会抛出各种异常,例如HttpRequestMethodNotSupportedException、HttpMediaTypeNotSupportedException,或者是自己定义的BusinessException。

这些异常,如果我们不将它们try catch进行处理,就会导致http的状态码变成非20x,并返回springMVC默认的异常信息格式。

场景1:业务部门对返回值进行了统一的规定,例如:{"code":200,  "message": "success", "data": {}},当发生异常的时候,并不希望http状态码变成非20x,而是保持200,通过code来表达调用是否成功,通过message来返回失败的原因。

场景2:业务部门希望发生异常的时候,返回异常信息使用的不是springmvc默认的格式,而是自定义自己的格式,返回更多辅助排查问题的信息。

这两种场景,都需要对未捕获的异常进行处理,这就需要利用上SpringMvc的异常处理拓展点。

接下来基于spring-WEBmvc-5.3.8来分析一下异常处理~

源码分析

DispatcherServlet

DispatcherServlet是SpringMvc的入口,所有请求都经过DispatcherServlet,再进入我们定义的@Controller接口中,进行处理。

接口发生异常时,也由DispatcherServlet的handlerExceptionResolvers属性所持有的HandlerExceptionResolver来处理。

在DispatcherServlet.initHandlerExceptionResolvers中,对handlerExceptionResolers进行初始化:

  • 如果DispatcherServlet.detectAllHandlerExceptionResolvers属性为true,则会获取Spring容器中所有类型为HandlerExceptionResolver的bean
  • 如果DispatcherServlet.detectAllHandlerExceptionResolvers属性为false,则会尝试获取beanName为HANDLER_EXCEPTION_RESOLVER_BEAN_NAME的HandlerExceptionResolver的bean
  • 最后,如果从Spring容器中,找不到HandlerExceptionResolver,则会采用默认策略,生成默认的异常处理

默认情况下,detectAllHandlerExceptionResolvers为true,而Spring容器里也会有三个HandlerExceptionResolver:

  • ExceptionHandlerExceptionResolver,使用用户加了@EcxceptionHandler注解的方法来处理异常。
  • ResponseStatusExceptionHandler,如果异常类型是ResponseStatusException,则根据异常中的status和reason,利用httpservletResponse.sendError来返回异常信息。
  • DefaultHandlerExceptionResolver,当前两个解析器没有成功处理,则该处理器会处理一些指定的异常类型,例如HttpRequestMethodNotSupportedException、HttpMediaTypeNotSupportedException、HttpMediaTypeNotAcceptableException等等;通过HttpServletResponse.sendError来返回异常信息。

ExceptionHandlerExceptionResolver

异常处理器的的处理能力来自于持有的ExceptionHandlerMethodResolver对象,有两个属性持有该类型的对象:

  • Map<Class<?>, ExceptionHandlerMethodResolver> exceptionHandlerCache缓存来自加了@Controller注解的bean中加了@ExceptionHanlder的方法,所以key是加了@Controller注解的类,value就是对应方法的ExceptionHandlerMethodResolver封装。优先于exceptionHandlerAdviceCache
  • Map<ControllerAdviceBean, ExceptionHandlerMethodResolver> exceptionHandlerAdviceCache,则是缓存了@ControllerAdvice注解的类中的异常处理,key是@ControllerAdvice的对象,value是加了@ExceptionHandler的方法对应的ExceptionHandlerMethodResolver封装。

在处理异常的方法doResolveHandlerMethodException中,会调用getExceptionHandlerMethod方法,从exceptionHandlerCache和exceptionHandlerAdviceCache获得ServletInvocableHandlerMethod。如果ServletInvocableHandlerMethod不为空,则用ServletInvocableHandlerMethod.invokeAndHandle处理异常。

所以重点就是在这两个属性的内容来源!!!

exceptionHandlerCache的内容,是在解析异常的时候才被逐步初始化,类似懒加载:

handlerMethod是抛异常的@Controller注解类的方法,handlerType就是@Controller注解的类。

注意!!!由于handlerType就是@Controller注解的类,所以new出来的ExceptionHandlerMethodResolver只会处理倒该@Controller注解的类抛出的异常(exceptionHandlerCache的key是handlerType)。

exceptionHandlerAdviceCache属性的的初始在,是在afterPropertiesSet中调用initExceptionHandlerAdviceCache,会获取Spring容器中所有加了@ControllerAdvice注解的bean,如果这些bean中有加了@ExceptionHandler注解的方法,则会被放到exceptionHandlerAdviceCache中。

 

ExceptionHandlerMethodResolver

再分析一下ExceptionHandlerMethodResolver的能力~

在构造函数中,会根据handlerType,通过反射的方式,选择类中加了@ExceptionHandler注解的方法,将@ExceptionHandler中的异常类型作为key,方法本身作为value,设置到mappedMethods中。

而excptionLookupCache则作为根据Throwable类型→method处理方法的缓存:

  • 如果能在excptionLookupCache缓存中找到,则直接返回
  • 如果找不到,则尝试从mappedMethods中查找
  • 如果mappedMethods中也没有找到,则会返回NO_MATCHING_EXEPTION_HANDLER_METHOD,该值也会被缓存在excptionLookupCache,这样就能避免缓存击穿!!

自定义异常处理

自定义异常处理的方式有三种:

1、自定义HandlerExceptionResolver类,注册到Spring容器上下文中,这样就会被DispatcherServlet检测到,放到handlerExceptionResolvers属性中,只要优先级高于SpringMvc默认的HandlerExceptionResolver,就可以优先处理异常。

2、在@Controller的类中,添加@ExceptionHandler注解的方法。这样,该方法就会处理其所在controller类抛出的异常。

3、在@ControllerAdvice类中增加@ExceptionHandler注解的方法。@ControllerAdvice类有几个选择属性,basePackages、basePackageClasses、assignableTypes和annotations;如果设置了这几个属性,则只有匹配这些属性规则的@Controller类的异常才会被处理。默认都为空,所有类的异常都会被处理。

拓展研究

1、@ExceptionHandler注解的方法返回值可以有多种类型,研究ServletInvocableHandlerMethod是怎么处理各种返回值类型的。

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持。

相关文章