SpringBoot 异常处理详解

傷城~ 2022-01-18 22:29 383阅读 0赞

总体来讲，SpringBoot 处理异常有下面几个。

### 一、利用 SpringBoot 的默认配置，我们自定义覆盖默认的错误页面： ###

**  1、SpringBoot 默认错误处理机制**

SpringBoot 为我们做了一堆的默认配置工作整合，也包含异常处理的配置

如果没有进行处理出现错误，如果是浏览器访问，它会返回一张 html 的错误页面，如果是其他客户端访问出现异常，它会直接返回json格式的异常数据。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70][]  ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 1][]

**1）在ErrorMvcAutoConfiguration中，重点看一下这三个**：[SpringBoot 错误处理机制源码跟踪][SpringBoot]

（1）查看 BasicErrorController 类，默认处理/error请求的。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 2][]

其中有两个方法处理错误请求：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 3][]

返回的异常信息可以在 DefaultErrorAttributes 类中查询

![20190611113809768.png][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 4][]

（2）DefaultErrorAttributes 封装了默认错误数据

![20201021095109260.png][]

（3）DefaultErrorViewResolver 默认错误视图解析器

![20201021095133585.png][]

**结论：**

1. 有模板引擎的情况下

error/状态码 \-- 将错误页面命名为 错误状态码.html 放在模板引擎文件夹里面的error文件夹下（/templates/error/xxx.html），发生此状态码的错误就会来到 对应的页面。使用4xx和5xx作为错误页面的文件名来匹配这种类型的所有错误，精确状态码优先。

2. 没有模板引擎（模板引擎找不到这个错误页面）

SpringBoot会去静态资源目录（static/error/状态码.html）下面找错误代码命名的页面。

3. 完整的错误页面查找方式应该是：比如发生了500错误

查找500.html 页面（模板引擎）–>查找静态 500.html –> 查找 5xx.html（模板引擎）–>查找静态 5xx.html。

以上都没有错误页面，就是默认来到SpringBoot默认的错误提示页面。

**2、自定义错误页面覆盖默认的：4xx 客户端错误，5xx 服务端错误**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 5][]

![20190611115600326.png][]    ![20190611115728575.png][]![2019061111554261.png][]

**3、自定义异常数据**

默认情况下异常数据会展示出5条数据（具体在DefaultErrorAttributes 类的 getErrorAttributes 方法中定义的）。

如果开发者没有自己提供一个 ErrorAttributes 的实例的话，那么 Spring Boot 将自动提供一个ErrorAttributes 的实例，也就是 DefaultErrorAttributes 。开发者自定义 ErrorAttributes 有两种方式 ：

*  直接实现 ErrorAttributes 接口（不推荐）
 *  继承 DefaultErrorAttributes类（推荐），因为 DefaultErrorAttributes 中对异常数据的处理已经完成，开发者可以直接使用。

这里创建一个类继承 DefaultErrorAttributes类自定义异常数据：

@Component
    public class MyErrorAttributes extends DefaultErrorAttributes {
        @Override
        public Map<String, Object> getErrorAttributes(WebRequest webRequest, ErrorAttributeOptions options) {
            Map<String, Object> map = super.getErrorAttributes(webRequest, options);
            if((Integer) map.get("status") == 500){
                map.put("myMessage", "500-服务器内部错误!");
            }
            return map;
        }
    }

![20201021103558861.png][]  ![20201021104510461.png][]

**4、自定义异常视图**

异常视图默认就是前面所说的静态或者动态页面（在BasicErrorController 类的 errorHtml 方法中处理的，如果是 ajax 请求，则是在error方法处理）。

这也是可以自定义的：开发者提供了自己的 ErrorViewResolver 实例，重新定义一个 ModelAndView 即可。

注意：参数中的 model 类型为 UnmodifiableMap，即不可以直接修改，它里面是封装的错误数据。在这里自定义一个map，遍历model数据拷贝过去并修改到map中，也是可以实现数据自定义的。

@Component
    public class MyErrorViewResolver extends DefaultErrorViewResolver {
        public MyErrorViewResolver(ApplicationContext applicationContext, ResourceProperties resourceProperties) {
            super(applicationContext, resourceProperties);
        }
    
        @Override
        public ModelAndView resolveErrorView(HttpServletRequest request, HttpStatus status, Map<String, Object> model) {
            ModelAndView modelAndView = new ModelAndView("/diy/1234", model);
            return modelAndView;
        }
    }

![20201021105510983.png][]

### 二、某个异常单独处理 @ExceptionHandler注解 ###

某个异常处理主要用到 @ExceptionHandler 注解，此注解加到类的方法上，当此注解里定义的异常抛出时，该方法会被执行。

**    如果 @ExceptionHandler 所在的类是 @Controller 注解，则此方法只作用在此controller类中。**

**如果 @ExceptionHandler 所在的类是 @ControllerAdvice 注解，则此方法会作用在全局。**

**1、某个controller处理： @Controller + @ExceptionHandler**

@Controller
    public class UserController {
        @GetMapping("/userList")
        public  String userList(Model model){
            int i = 1/0;
            List<User> userList = userService.getAllUser();
            model.addAttribute("userList", userList);
            return "userList";
        }
    
        //局部异常处理 - 页面
        @ExceptionHandler(value = {java.lang.ArithmeticException.class})
        public ModelAndView exHandler(Exception ex){
            ModelAndView modelAndView = new ModelAndView();
            modelAndView.addObject("err", ex.getMessage()); //更加自由显示处理异常
            modelAndView.setViewName("/myError");
            return modelAndView;
        }
    
      /*  //局部异常处理 - JSON格式
        @ExceptionHandler(value = {java.lang.Exception.class})
        @ResponseBody
        public String exHandler(Exception e){
            // 判断发生异常的类型是除0异常则做出响应
            if(e instanceof ArithmeticException){
                return "发生了除0异常";
            }
            // 未知的异常做出响应
            return "发生了未知异常";
        }*/
    
    }

**2、全局异常处理：@ControllerAdvice + @ExceptionHandler**

在spring 3.2中，新增了 @ControllerAdvice 注解，可以用于定义 @ExceptionHandler、@InitBinder、@ModelAttribute，并应用到所有@RequestMapping中。

简单的说，进入Controller层的错误才会由 @ControllerAdvice 处理，拦截器抛出的错误以及访问错误地址的情况 @ControllerAdvice 处理不了，由SpringBoot默认的异常处理机制处理。

@ControllerAdvice
    public class DoAllErrotController {
        //全局异常处理 - 视图
        @ExceptionHandler(value = {java.lang.ArithmeticException.class})
        public ModelAndView exHandler(Exception ex){
            ModelAndView modelAndView = new ModelAndView();
            modelAndView.addObject("err", ex.getMessage()); //更加自由显示处理异常
            modelAndView.setViewName("/myError");
            return modelAndView;
        }
    
        //全局异常处理 - JSON格式
       /*  
        @ExceptionHandler(value = {RuntimeException.class})
        @ResponseBody
        public Map<String, Object> errorJson(){        
            Map<String, Object> errorMap = new HashMap<>();
            errorMap.put("errorCode", "500");
            errorMap.put("errorMessage", "发送异常啦！");
            return errorMap;
        }
        */
    }

某个controller处理和全局异常处理同时处理时， 先某个，某个处理没有回再全局处理。

**3、使用@ControllerAdvice定义全局数据**

如果有个需求，想在所有的Controller类中获取某个或者多个全局的数据，可以使用@ControllerAdvice定义全局数据。

@ControllerAdvice
    public class MyGlobalData {
    
        // 自定义kv。key - globalKey1，v - Map。 
        @ModelAttribute(value = "globalKey1")
        public Map<String, Object> globalData(){
            Map<String, Object> map = new HashMap<>();
            map.put("aaa","vvv1");
            map.put("bbb","vvv2");
            return map;
        }
    }

@Controller
    public class ErrorController {
    
        @GetMapping("/get")
        @ResponseBody
        public String get(Model model){
            Map<String, Object> map = model.asMap();
            map.forEach((k,v) -> {
                System.out.println(k);
                System.out.println(v);
            });
            return "success";
        }
    }

![2020102111425818.png][]

### 三、全局异常处理：注入SimpleMappingExceptionResolver ###

在@Configuration注解的配置类中，注入SimpleMappingExceptionResolver，bean配置来处理做全局异常处理，**但是这种方法不能返回异常的具体信息。**

@Configuration
    public class MyErrorConfig {
    
        @Bean
        public SimpleMappingExceptionResolver simpleMappingExceptionResolver(){
            SimpleMappingExceptionResolver simpleMappingExceptionResolver = new SimpleMappingExceptionResolver();
            Properties properties = new Properties();
            properties.put("java.lang.NullPointerException","myError"); //参数：异常类型，视图名称
            properties.put("java.lang.ArithmeticException","myError");
            simpleMappingExceptionResolver.setExceptionMappings(properties); //设置异常与视图映射信息的，默认通过${exception} 获取，可修改
            simpleMappingExceptionResolver.setExceptionAttribute("err"); //
            return simpleMappingExceptionResolver;
        }
    }

注入bean的配置和@ControllerAdvice方式同时使用时，优先是@ControllerAdvice方式处理。

之前SpringMVC 的配置：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 6][]

### 四、自定义 HandlerExceptionResolver 类处理异常（不常用） ###

需 要 再 全 局 异 常 处 理 类 中 实 现 HandlerExceptionResolver 接口，并添加@Configuration注解。

@Configuration
    public class MyErrorConfig5  implements HandlerExceptionResolver {
        @Override
        public ModelAndView resolveException(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) {
            ModelAndView modelAndView = new ModelAndView();
            if(e instanceof ArithmeticException){
                modelAndView.setViewName("myError");
            }
            if(e instanceof NullPointerException){
                modelAndView.setViewName("error");
            }
            modelAndView.addObject("err",e);
            return modelAndView;
        }
    }

项目中根据情况，合理选择上面的处理方式。

ends~

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20190611105726119.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 1]: /images/20220119/7dea55fe95cb4c68876c3aa92fa1670a.png
[SpringBoot]: https://www.jb51.net/article/151311.htm
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 2]: /images/20220119/99f8999778a44c3597b93f57b71bef76.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 3]: /images/20220119/3c6eb92394724db5b87556d3784335b8.png
[20190611113809768.png]: /images/20220119/0511e000f8654489a883ccd2248c1b4d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 4]: /images/20220119/7382bca828a541eb87537409b7b81ebb.png
[20201021095109260.png]: /images/20220119/226f42e147c649da8e08c885c5a5ab03.png
[20201021095133585.png]: /images/20220119/1d2034cf0cdb4386b44181701f3c1648.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 5]: /images/20220119/c8170a0f52bf48809b0b70c9b43c1efb.png
[20190611115600326.png]: https://img-blog.csdnimg.cn/20190611115600326.png
[20190611115728575.png]: https://img-blog.csdnimg.cn/20190611115728575.png
[2019061111554261.png]: /images/20220119/1c10e0b583cd46c8a98910abd38f4e81.png
[20201021103558861.png]: https://img-blog.csdnimg.cn/20201021103558861.png
[20201021104510461.png]: /images/20220119/d8c8d96aa78b4ff193b3107e6d5cc8a8.png
[20201021105510983.png]: /images/20220119/9fd135361e334996af8ebf9438aa0e4a.png
[2020102111425818.png]: /images/20220119/89339db520b247b0a56fadceedfe8e2a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 6]: /images/20220119/804fcabed5c248538375072c8e9bce84.png