@ExceptionHandler or HandlerExceptionResolver?如何优雅处理全局异常?【享学Spring MVC】(中)

简介: @ExceptionHandler or HandlerExceptionResolver?如何优雅处理全局异常?【享学Spring MVC】(中)

ExceptionHandlerExceptionResolver(重要)


该子类实现就是用于处理标注有@ExceptionHandler注解的HandlerMethod方法的,是@ExceptionHandler功能的实现部分。


请注意命名上和ExceptionHandlerMethodResolver做区分~


// @since 3.1
public class ExceptionHandlerExceptionResolver extends AbstractHandlerMethodExceptionResolver implements ApplicationContextAware, InitializingBean {
  // 这个熟悉:用于处理方法入参的(比如支持入参里可写HttpServletRequest等等)
  @Nullable
  private List<HandlerMethodArgumentResolver> customArgumentResolvers;
  @Nullable
  private HandlerMethodArgumentResolverComposite argumentResolvers;
  // 用于处理方法返回值(ModelAndView、@ResponseBody、@ResponseStatus等)
  @Nullable
  private List<HandlerMethodReturnValueHandler> customReturnValueHandlers;
  @Nullable
  private HandlerMethodReturnValueHandlerComposite returnValueHandlers;
  // 消息处理器和内容协商管理器
  private List<HttpMessageConverter<?>> messageConverters;
  private ContentNegotiationManager contentNegotiationManager = new ContentNegotiationManager();
  // 通知(因为异常是可以做全局效果的)
  private final List<Object> responseBodyAdvice = new ArrayList<>();
  @Nullable
  private ApplicationContext applicationContext;
  // 缓存:异常类型对应的处理器
  // 它缓存着Controller本类,对应的异常处理器(多个@ExceptionHandler)~~~~
  private final Map<Class<?>, ExceptionHandlerMethodResolver> exceptionHandlerCache = new ConcurrentHashMap<>(64);
  // 它缓存ControllerAdviceBean对应的异常处理器(@ExceptionHandler)
  private final Map<ControllerAdviceBean, ExceptionHandlerMethodResolver> exceptionHandlerAdviceCache = new LinkedHashMap<>();
  // 唯一构造函数:注册上默认的消息转换器
  public ExceptionHandlerExceptionResolver() {
    StringHttpMessageConverter stringHttpMessageConverter = new StringHttpMessageConverter();
    ...
    this.messageConverters.add(new AllEncompassingFormHttpMessageConverter());
  }
  ... // 省略所有的get/set方法
  @Override
  public void afterPropertiesSet() {
    // Do this first, it may add ResponseBodyAdvice beans
    // 这一步骤同RequestMappingHandlerAdapter#initControllerAdviceCache
    // 目的是找到项目中所有的`ResponseBodyAdvice`,然后缓存起来。
    // 并且把它里面所有的标注有@ExceptionHandler的方法都解析保存起来
    // exceptionHandlerAdviceCache:每个advice切面对应哪个ExceptionHandlerMethodResolver(含多个@ExceptionHandler处理方法)
    //并且,并且若此Advice还实现了接口:ResponseBodyAdvice。那就还可干预到异常处理器的返回值处理上(基于body)
    //可见:若你想干预到异常处理器的返回值body上,可通过ResponseBodyAdvice来实现哟~~~~~~~~~ 
    // 可见ResponseBodyAdvice连异常处理方法也是生效的,但是`RequestBodyAdvice`可就木有啦。
    initExceptionHandlerAdviceCache();
    // 注册默认的参数处理器。支持到了@SessionAttribute、@RequestAttribute
    // ServletRequest/ServletResponse/RedirectAttributes/ModelMethod等等(当然你还可以自定义)
    if (this.argumentResolvers == null) {
      List<HandlerMethodArgumentResolver> resolvers = getDefaultArgumentResolvers();
      this.argumentResolvers = new HandlerMethodArgumentResolverComposite().addResolvers(resolvers);
    }
    // 支持到了:ModelAndView/Model/View/HttpEntity/ModelAttribute/RequestResponseBody
    // ViewName/Map等等这些返回值 当然还可以自定义
    if (this.returnValueHandlers == null) {
      List<HandlerMethodReturnValueHandler> handlers = getDefaultReturnValueHandlers();
      this.returnValueHandlers = new HandlerMethodReturnValueHandlerComposite().addHandlers(handlers);
    }
  }
  ...
  // 处理HandlerMethod类型的异常。它的步骤是找到标注有@ExceptionHandler匹配的方法
  // 然后执行此方法来处理所抛出的异常
  @Override
  @Nullable
  protected ModelAndView doResolveHandlerMethodException(HttpServletRequest request, HttpServletResponse response, @Nullable HandlerMethod handlerMethod, Exception exception) {
    // 这个方法是精华,是关键。它最终返回的是一个ServletInvocableHandlerMethod可执行的方法处理器
    // 也就是说标注有@ExceptionHandler的方法最终会成为它
    // 1、本类能够找到处理方法,就在本类里找,找到就返回一个ServletInvocableHandlerMethod
    // 2、本类木有,就去ControllerAdviceBean切面里找,匹配上了也是欧克的
    //   显然此处会判断:advice.isApplicableToBeanType(handlerType) 看此advice是否匹配
    // 若两者都木有找到,那就返回null。这里的核心其实是ExceptionHandlerMethodResolver这个类
    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);
    }
  }
  ...
  // 执行此方法的调用(比couse也传入进去了)
  exceptionHandlerMethod.invokeAndHandle(webRequest, mavContainer, exception, cause, handlerMethod);
  ... // 下面处理model、ModelAndView、view等等。最终返回一个ModelAndView
  // 这样异常梳理完成。
}


对它的功能,总结如下:


  1. @ExceptionHandler的处理和执行是由本类完成的,同一个Class上的所有@ExceptionHandler方法对应着同一个ExceptionHandlerExceptionResolver,不同Class上的对应着不同的~
  2. 标注有@ExceptionHandler的方法入参上可写:具体异常类型、ServletRequest/ServletResponse/RedirectAttributes/ModelMethod等等
  3. 1. 注意:入参写具体异常类型时只能够写一个类型。(若有多种异常,请写公共父类,你再用instanceof来辨别,而不能直接写多个)
  4. 返回值可写:ModelAndView/Model/View/HttpEntity/ModelAttribute/RequestResponseBody/@ResponseStatus等等
  5. @ExceptionHandler只能标注在方法上。既能标注在Controller本类内的方法上(只对本类生效),也可配合@ControllerAdvice一起使用(对全局生效)
  6. 对步骤4的两种情况,执行时的匹配顺序如下:优先匹配本类(本Controller),再匹配全局的。
  7. 有必要再强调一句:@ExceptionHandler方式并不是只能返回JSON串,步骤4也说了,它返回一个ModelAndView也是ok的


异常处理优先级


上篇文章 加上本文介绍了多种处理异常的方案,在实际生成环境中,我们的项目中一般确实也会存在多个HandlerExceptionResolver异常处理器,那么对于抛出的一个异常,它的处理顺序到底是怎样的呢?


理解了DispatcherServlet默认注册的异常处理器们和它们的执行原理后,再去解答这个问题就易如反掌了。这是DispatcherServlet默认注册的异常处理器们:

image.png


所以在我们没有自定义HandlerExceptionResolver来干扰这种顺序的情况下(绝大部分情况下我们都不会干扰它),最最最最先执行的便是@ExceptionHandler方式的异常处理器,只有匹配不上才会继续执行其它的处理器。

根据此规律,我从使用层面总结出一个结论,供现在还不想深入理解原理的小伙伴参考和记忆:


  1. @Controller + @ExceptionHandler优先级最高
  2. @ControllerAdvice + @ExceptionHandler次之
  3. HandlerExceptionResolver最后(一般是DefaultHandlerExceptionResolver)


全局异常示例


在很多Spring MVC项目中你或许都可以看到一个名字叫GlobalExceptionHandler(名字大同小异)的类,它的作用一般被标注上了@ControllerAdvice/@RestControllerAdvice用于处理全局异常。

但据我了解,大多数项目对此类的设计是相当不完善的,它只做了一个通用处理:处理Exception类型。显然这种宽泛的处理是很不优雅的,理应做细分,那么读了本文后我相信你已有能力去协助完善这一块内容,为你的团队带来改变哈。


此处我给出示例代码,抛砖引玉仅供参考:


@Slf4j
@RestControllerAdvice // 全部返回JSON格式,因为大都是REST项目
public class GlobalExceptionHandler extends ResponseEntityExceptionHandler {
    // 处理所有不可知的异常,作为全局的兜底
    @ExceptionHandler(Exception.class)
    AppResponse handleException(Exception e){
        log.error(e.getMessage(), e);
        AppResponse response = new AppResponse();
        response.setFail("未知错误,操作失败!");
        return response;
    }
    // 处理所有业务异常(一般为手动抛出)
    @ExceptionHandler(BusinessException.class)
    AppResponse handleBusinessException(BusinessException e){
        log.error(e.getMessage(), e);
        AppResponse response = new AppResponse();
        response.setFail(e.getMessage());
        return response;
    }
    // 处理所有接口参数的数据验证异常(此处特殊处理了这个异常)
    @ExceptionHandler(MethodArgumentNotValidException.class)
    AppResponse handleMethodArgumentNotValidException(MethodArgumentNotValidException e){
        log.warn(e.getMessage(), e); //此处我不建议使用error异常...
    // 关于校验的错误信息的返回,此处我知识简单处理,具体你可以加强
        AppResponse response = new AppResponse();
        response.setFail(e.getBindingResult().getAllErrors().get(0).getDefaultMessage());
        return response;
    }
    // 自己定制化处理HttpRequestMethodNotSupportedException这个异常类型喽
    @Override
    protected ResponseEntity<Object> handleHttpRequestMethodNotSupported(HttpRequestMethodNotSupportedException ex, HttpHeaders headers, HttpStatus status, WebRequest request) {
        log.warn(ex.getMessage());
        String method = ex.getMethod();
        String[] supportedMethods = ex.getSupportedMethods();
        Map<String, Object> map = new HashMap<>();
        map.put("code", status.value());
        map.put("message", "不支持的请求类型:" + method + ",支持的请求类型:" + Arrays.toString(supportedMethods));
        return super.handleExceptionInternal(ex, map, headers, status, request);
    }
}


可能有人并不清楚为何我要继承ResponseEntityExceptionHandler这个类,下面我就简单介绍一下它。


ResponseEntityExceptionHandler


它是个抽象类,可谓是Spring 3.2后对REST应用异常支持的一个暖心举动。它包装了各种Spring MVC在处理请求时可能抛出的异常的处理,处理结果都是封装成一个ResponseEntity对象。通过ResponseEntity我们可以指定需要响应的状态码、header和body等信息~


因为它是个抽象类,所以我们要使用它只需要定义一个标注有@ControllerAdvice的类继承于它便可(如上示例):

加上全局处理前(被DefaultHandlerExceptionResolver处理的结果):


image.png


加上后:


image.png


因此个人建议若你是REST应用,可以在全局异常处理类上都设计为继承自此类,做兜底使用。它能处理的异常类型如下(同DefaultHandlerExceptionResolver处理的异常类型)


ResponseEntityExceptionHandler:
  @ExceptionHandler({
      HttpRequestMethodNotSupportedException.class,
      HttpMediaTypeNotSupportedException.class,
      HttpMediaTypeNotAcceptableException.class,
      MissingPathVariableException.class,
      MissingServletRequestParameterException.class,
      ServletRequestBindingException.class,
      ConversionNotSupportedException.class,
      TypeMismatchException.class,
      HttpMessageNotReadableException.class,
      HttpMessageNotWritableException.class,
      MethodArgumentNotValidException.class,
      MissingServletRequestPartException.class,
      BindException.class,
      NoHandlerFoundException.class,
      AsyncRequestTimeoutException.class
    })
  @Nullable
  public final ResponseEntity<Object> handleException(Exception ex, WebRequest request) throws Exception { ... }


处理异常时又发生了异常怎么办呢?


这个问题你是否曾思考过呢?其实在理解了上文和本文的内容后,此问题的答案也就浮出水面了,强烈建议有兴趣的同学在本地调试出这种case,有助于你的理解~


结论:若处理器内部又抛出异常,一般就会交给tomcat处理把异常栈输出到前端,显示非常不友好的页面。因此:请务必保证你的异常处理程序中不要出现任何异常,保证健壮性。(当然最最最最为兜底的方案就是架构师统一设计一个HandlerExceptionResolver放在末位,用最简单、最不会出bug的代码来处理一切前面不能处理的异常)

相关文章
|
13天前
|
Dubbo Java 应用服务中间件
深入探讨了“dubbo+nacos+springboot3的native打包成功后运行出现异常”的原因及解决方案
本文深入探讨了“dubbo+nacos+springboot3的native打包成功后运行出现异常”的原因及解决方案。通过检查GraalVM版本兼容性、配置反射列表、使用代理类、检查配置文件、禁用不支持的功能、查看日志文件、使用GraalVM诊断工具和调整GraalVM配置等步骤,帮助开发者快速定位并解决问题,确保服务的正常运行。
28 1
|
1月前
|
JSON 前端开发 Java
SSM:SpringMVC
本文介绍了SpringMVC的依赖配置、请求参数处理、注解开发、JSON处理、拦截器、文件上传下载以及相关注意事项。首先,需要在`pom.xml`中添加必要的依赖,包括Servlet、JSTL、Spring Web MVC等。接着,在`web.xml`中配置DispatcherServlet,并设置Spring MVC的相关配置,如组件扫描、默认Servlet处理器等。然后,通过`@RequestMapping`等注解处理请求参数,使用`@ResponseBody`返回JSON数据。此外,还介绍了如何创建和配置拦截器、文件上传下载的功能,并强调了JSP文件的放置位置,避免404错误。
|
1月前
|
Java API Spring
springBoot:注解&封装类&异常类&登录实现类 (八)
本文介绍了Spring Boot项目中的一些关键代码片段,包括使用`@PathVariable`绑定路径参数、创建封装类Result和异常处理类GlobalException、定义常量接口Constants、自定义异常ServiceException以及实现用户登录功能。通过这些代码,展示了如何构建RESTful API,处理请求参数,统一返回结果格式,以及全局异常处理等核心功能。
|
1月前
|
前端开发 Java 应用服务中间件
【Spring】Spring MVC的项目准备和连接建立
【Spring】Spring MVC的项目准备和连接建立
54 2
|
1月前
|
Java 关系型数据库 数据库连接
SpringBoot项目使用yml文件链接数据库异常
【10月更文挑战第3天】Spring Boot项目中数据库连接问题可能源于配置错误或依赖缺失。YAML配置文件的格式不正确,如缩进错误,会导致解析失败;而数据库驱动不匹配、连接字符串或认证信息错误同样引发连接异常。解决方法包括检查并修正YAML格式,确认配置属性无误,以及添加正确的数据库驱动依赖。利用日志记录和异常信息分析可辅助问题排查。
184 10
|
2月前
|
缓存 前端开发 Java
【Java面试题汇总】Spring,SpringBoot,SpringMVC,Mybatis,JavaWeb篇(2023版)
Soring Boot的起步依赖、启动流程、自动装配、常用的注解、Spring MVC的执行流程、对MVC的理解、RestFull风格、为什么service层要写接口、MyBatis的缓存机制、$和#有什么区别、resultType和resultMap区别、cookie和session的区别是什么?session的工作原理
【Java面试题汇总】Spring,SpringBoot,SpringMVC,Mybatis,JavaWeb篇(2023版)
|
1月前
|
Java 关系型数据库 MySQL
SpringBoot项目使用yml文件链接数据库异常
【10月更文挑战第4天】本文分析了Spring Boot应用在连接数据库时可能遇到的问题及其解决方案。主要从四个方面探讨:配置文件格式错误、依赖缺失或版本不兼容、数据库服务问题、配置属性未正确注入。针对这些问题,提供了详细的检查方法和调试技巧,如检查YAML格式、验证依赖版本、确认数据库服务状态及用户权限,并通过日志和断点调试定位问题。
|
1月前
|
XML 前端开发 Java
Spring,SpringBoot和SpringMVC的关系以及区别 —— 超准确,可当面试题!!!也可供零基础学习
本文阐述了Spring、Spring Boot和Spring MVC的关系与区别,指出Spring是一个轻量级、一站式、模块化的应用程序开发框架,Spring MVC是Spring的一个子框架,专注于Web应用和网络接口开发,而Spring Boot则是对Spring的封装,用于简化Spring应用的开发。
116 0
Spring,SpringBoot和SpringMVC的关系以及区别 —— 超准确,可当面试题!!!也可供零基础学习
|
2月前
|
XML 缓存 前端开发
springMVC02,restful风格,请求转发和重定向
文章介绍了RESTful风格的基本概念和特点,并展示了如何使用SpringMVC实现RESTful风格的请求处理。同时,文章还讨论了SpringMVC中的请求转发和重定向的实现方式,并通过具体代码示例进行了说明。
springMVC02,restful风格,请求转发和重定向
|
3月前
|
前端开发 小程序 Java
【规范】SpringBoot接口返回结果及异常统一处理,这样封装才优雅
本文详细介绍了如何在SpringBoot项目中统一处理接口返回结果及全局异常。首先,通过封装`ResponseResult`类,实现了接口返回结果的规范化,包括状态码、状态信息、返回信息和数据等字段,提供了多种成功和失败的返回方法。其次,利用`@RestControllerAdvice`和`@ExceptionHandler`注解配置全局异常处理,捕获并友好地处理各种异常信息。
1153 0
【规范】SpringBoot接口返回结果及异常统一处理,这样封装才优雅