Spring的三种异常处理方式

快来打我* 2024-03-23 22:59 89阅读 0赞

### 1.SpringMVC 异常的处理流程 ###

异常分为编译时异常和运行时异常，编译时异常我们 try-cache 进行捕获，捕获后自行处理，而运行时异常是不 可预期的，就需要规范编码来避免，在SpringMVC 中，不管是编译异常还是运行时异常，都可以最终由 SpringMVC提供的异常处理器进行统一处理，这样就避免了随时随地捕获处理的繁琐性。

SpringMVC 处理异常的思路是，一路向上抛，都抛给前端控制器 DispatcherServlet ，DispatcherServlet 在调 用异常处理器ExceptionResolver进行处理，如下图：

![d3f029a011a84939aa55a4859d88fd58.png][]

### 2.SpringMVC 的异常处理方式 ###

SpringMVC 提供了以下三种处理异常的方式：

*  简单异常处理器：使用SpringMVC 内置的异常处理器处理SimpleMappingExceptionResolver；
 *  自定义异常处理器：实现HandlerExceptionResolver接口，自定义异常进行处理；
 *  注解方式：使用@ControllerAdvice + @ExceptionHandler 来处理

**1.使用SimpleMappingExceptionResolver处理一些简单异常**，配置开启SimpleMappingExceptionResolver， 并指定异常捕获后的处理动作，当发生了异常后，会被 SimpleMappingExceptionResolver 处理，跳转到我们 配置的错误页面error.html给用户进行友好展示

>   
> <bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">  
>   
> <property name="defaultErrorView" value="/error.html"/>  
> </bean

可以在配置SimpleMappingExceptionResolver时，指定一些参数，例如：异常的类型

> <bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">  
> <property name="defaultErrorView" value="/error.html"/>  
> <property name="exceptionMappings">  
> <props>  
>   
> <prop key="java.lang.RuntimeException">/error.html</prop>  
> <prop key="java.io.FileNotFoundException">/io.html</prop>  
> </props>  
> </property>  
> </bean>

注解方式配置简单映射异常处理器

@Bean
    public SimpleMappingExceptionResolver simpleMappingExceptionResolver(){
         //创建SimpleMappingExceptionResolver
         SimpleMappingExceptionResolver resolver = new SimpleMappingExceptionResolver();
         //设置默认错误展示视图
         resolver.setDefaultErrorView("/error.html");
         //定义Properties设置特殊异常对应的映射视图
         Properties properties = new Properties();
         properties.setProperty("java.lang.RuntimeException","/error.html");
         properties.setProperty("java.io.FileNotFoundException","/io.html");
         resolver.setExceptionMappings(properties);
         return resolver;
    }

**2.自定义异常处理器**，实现HandlerExceptionResolver接口自定义异常处理器，可以完成异常逻辑的处理

public class MyHandlerExceptionResolver implements HandlerExceptionResolver {
         @Override
         //参数Object是当前目标方法处理器对象HandlerMethod
         public ModelAndView resolveException(HttpServletRequest httpServletRequest, 
             HttpServletResponse httpServletResponse, Object o, Exception e) {
             ModelAndView modelAndView = new ModelAndView();
             modelAndView.setViewName("/error.html");
             return modelAndView;
         }
    }

交给Spring管理异常处理器

> <bean class="com.fly.exception.MyHandlerExceptionResolver"></bean>

自定义异常处理器，返回Json格式字符串信息

@Component
    public class MyHandlerExceptionResolver implements HandlerExceptionResolver {
         @Override
         public ModelAndView resolveException(HttpServletRequest httpServletRequest, 
            HttpServletResponse httpServletResponse, Object o, Exception e) {
             //编写要返回的json格式的字符串
             String jsonStr = "{\"code\":0,\"message\":\"error\",\"data\":\"\"}";
             try {
                 httpServletResponse.getWriter().write(jsonStr);
             } catch (IOException e1) {
                 e1.printStackTrace();
             }
             return null;
         }
    }

**3.使用注解 @ControllerAdvice + @ExceptionHandler 配置异常**，@ControllerAdvice 注解本质是一个 @Component，也会被扫描到，与此同时，具备AOP功能，默认情况下对所有的Controller都进行拦截操作， 拦截后干什么呢？就需要在结合@ExceptionHandler、@InitBinder、@ModelAttribute 注解一起使用了，此 处我们讲解的是异常，所以是@ControllerAdvice + @ExceptionHandler的组合形式

编写全局异常处理器类，使用@ControllerAdvice标注，且@ExceptionHandler指定异常类型

@ControllerAdvice
    public class GlobalExceptionHandler {
         @ExceptionHandler(RuntimeException.class)
         public ModelAndView runtimeHandleException(RuntimeException e){
             System.out.println("全局异常处理器执行...."+e);
             ModelAndView modelAndView = new ModelAndView("/error.html");
             return modelAndView;
         }
         @ExceptionHandler(IOException.class)
         @ResponseBody
         public ResultInfo ioHandleException(IOException e){
             //模拟一个ResultInfo
             ResultInfo resultInfo = new ResultInfo(0,"IOException",null);
             return resultInfo;
         }
    }

如果全局异常处理器响应的数据都是Json格式的字符串的话，可以使用@RestControllerAdvice替代 @ControllerAdvice 和 @ResponseBody

@RestControllerAdvice
    public class GlobalExceptionHandler {
         @ExceptionHandler(RuntimeException.class)
         public ResultInfo runtimeHandleException(RuntimeException e){
             //模拟一个ResultInfo
             ResultInfo resultInfo = new ResultInfo(0,"RuntimeException",null);
             return resultInfo;
         }
         @ExceptionHandler(IOException.class)
         public ResultInfo ioHandleException(IOException e){
             //模拟一个ResultInfo
             ResultInfo resultInfo = new ResultInfo(0,"IOException",null);
             return resultInfo;
         }
    }

### 3.SpringMVC 常用的异常解析器 ###

<table style="width:700px;"> 
 <tbody> 
  <tr> 
   <td style="width:329px;"><strong>接口/类</strong></td> 
   <td style="width:369px;"><strong>说明</strong></td> 
  </tr> 
  <tr> 
   <td style="width:329px;">HandlerExceptionResolver</td> 
   <td style="width:369px;">异常处理器类的顶级接口，实现了该接口的类都会作为异常处理器类</td> 
  </tr> 
  <tr> 
   <td style="width:329px;">MyHandlerExceptionResolver</td> 
   <td style="width:369px;">自定义的处理器类，实现了HandlerExceptionResolver接口</td> 
  </tr> 
  <tr> 
   <td style="width:329px;">HandlerExceptionResolverComposite</td> 
   <td style="width:369px;">异常解析器混合器，内部存在集合存储多种异常解析器</td> 
  </tr> 
  <tr> 
   <td style="width:329px;">SimpleMappingExceptionResolver</td> 
   <td style="width:369px;">简单映射异常处理器，可以配置异常与对应的错误视图</td> 
  </tr> 
  <tr> 
   <td style="width:329px;">ExceptionHandlerExceptionResolver</td> 
   <td style="width:369px;">异常处理器异常解析器，默认会被注册到Spring容器中，@ExceptionHandler方式 异常处理就是该解析器解析的</td> 
  </tr> 
  <tr> 
   <td style="width:329px;">DefaultHandlerExceptionResolver</td> 
   <td style="width:369px;">默认处理器异常解析器，所有异常处理器都不匹配时，最后执行的异常处理器</td> 
  </tr> 
  <tr> 
   <td style="width:329px;">ResponseStatusExceptionResolver</td> 
   <td style="width:369px;">响应状态异常解析器，结合使用@ResponseStatus标注的异常使用</td> 
  </tr> 
 </tbody> 
</table>

[d3f029a011a84939aa55a4859d88fd58.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/799fcfb7147b49c088b931441997fc76.png