SpringBoot---错误处理机制

Posted 2021-08-30 大忽悠爱忽悠

SpringBoot---Web开发第三部分

• SpringBoot默认的错误处理机制
• • 浏览器访问，默认返回一个错误页面
  • PostManHttp请求模拟工具，软件下载链接如下
  • • 如果是其他客户端，默认响应一个JSON数据
    • 原理-----SpirngMVC错误处理的自动配置
  • 如何定制错误响应
  • • 1.定制错误响应页面
    • 1.如何定制错误的json数据
    • • 出现自适应效果:转发到error请求，让BasicErrorController来处理该请求
      • 传入我们自己的错误状态码 4xx 5xx，否则就不会进入定制错误页面的解析流程
      • 将我们定制数据携带出去
      • • • 出现错误以后，会来到/error请求，会被BasicErrorController处理，响应出去可以获取的数据是由getErrorAttributes得到的（是AbstractErrorController（ErrorController）规定的方法)
      • **​ 容器中DefaultErrorAttributes.getErrorAttributes()；默认进行数据处理的；**
    • 如果我们在request域中放入了错误消息如下:
    • 继承DefaultErrorAttributes类并重写其获取错误属性的方法中，获取request域中的数据

SpringBoot默认的错误处理机制

浏览器访问，默认返回一个错误页面

---

PostManHttp请求模拟工具，软件下载链接如下

PostMan下载链接

---

如果是其他客户端，默认响应一个JSON数据

---

原理-----SpirngMVC错误处理的自动配置

可以参照ErrorMvcAutoConfiguration；错误处理的自动配置；

给容器中添加了以下组件:

1、DefaultErrorAttributes：

2、BasicErrorController：处理默认/error请求

3、ErrorPageCustomizer：错误页面定制

4、DefaultErrorViewResolver：

步骤：

一但系统出现4xx或者5xx之类的错误；ErrorPageCustomizer就会生效（定制错误的响应规则）；就会来到/error

请求: 就会被BasicErrorController处理；

响应页面: 去哪个页面是由DefaultErrorViewResolver解析得到的；

---

如何定制错误响应

1.定制错误响应页面

---

1.如何定制错误的json数据

自定义异常:

public class UserNotFoundException extends RuntimeException
{
    public UserNotFoundException()
    {
        super("用户不存在");//错误显示
    }
}

如何定制错误的JSON数据

@ControllerAdvice//处理全局异常的类
public class exception
{
//浏览器客户端返回的都是JSON数据
    @ResponseBody
    @ExceptionHandler(Exception.class)
    public Map<String,Object> handleException(Exception e){
        Map<String,Object> map = new HashMap<>();
        map.put("code","user.notexist");
        map.put("message",e.getMessage());
        return map;
    }
}

上面的写法没有自适应效果，即浏览器访问返回一个错误页面，其他客户端访问，返回一个JSON数据

---

出现自适应效果:转发到error请求，让BasicErrorController来处理该请求

这里没有设置错误状态码，转发成功后，状态码为200，因此无法走到定制错误页面解析流程

@ControllerAdvice//处理全局异常的类
public class exception
{
    @ExceptionHandler(UserNotFoundException.class)
    public String handleException(Exception e){
        Map<String,Object> map = new HashMap<>();
        map.put("code","user.notexist");
        map.put("message",e.getMessage());
        //转发到error请求
        //BasicErrorController：处理默认/error请求
        return "forward:/error";
    }
}

---

传入我们自己的错误状态码 4xx 5xx，否则就不会进入定制错误页面的解析流程

@ControllerAdvice//处理全局异常的类
public class exception
{
    @ExceptionHandler(UserNotFoundException.class)
    public String handleException(Exception e, HttpServletRequest request){
        Map<String,Object> map = new HashMap<>();
        //传入我们自己的错误状态码  4xx 5xx，否则就不会进入定制错误页面的解析流程
        /**
         * Integer statusCode = (Integer) request
         .getAttribute("javax.servlet.error.status_code");
         */
        request.setAttribute("javax.servlet.error.status_code",400);
        map.put("code","user.notexist");
        map.put("message",e.getMessage());
        //转发到error请求
        //BasicErrorController：处理默认/error请求
        return "forward:/error";
    }
}

---

将我们定制数据携带出去

出现错误以后，会来到/error请求，会被BasicErrorController处理，响应出去可以获取的数据是由getErrorAttributes得到的（是AbstractErrorController（ErrorController）规定的方法)

​ 1、完全来编写一个ErrorController的实现类【或者是编写AbstractErrorController的子类】，放在容器中；

​ 2、页面上能用的数据，或者是json返回能用的数据都是通过errorAttributes.getErrorAttributes得到；

​ 容器中DefaultErrorAttributes.getErrorAttributes()；默认进行数据处理的；

自定义ErrorAttributes(错误属性)

这里springboot都是去容器中查看用户是否存在上面的错误相关的类，如果没有才会使用默认的配置类，因此我们可以通过重写上面的错误类，放入容器中，完成定制错误数据并携带出去

//给容器中加入我们自己定义的ErrorAttributes
@Component
 class MyErrorAttributes extends DefaultErrorAttributes
{
//返回值的map就是和页面json能获取的数据
    @Override
    public Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
        Map<String, Object> map = super.getErrorAttributes(webRequest, includeStackTrace);
        map.put("company","大忽悠集团有限公司");
        return map;
    }
}

最终的效果：响应是自适应的，可以通过定制ErrorAttributes改变需要返回的内容

如果我们在request域中放入了错误消息如下:

继承DefaultErrorAttributes类并重写其获取错误属性的方法中，获取request域中的数据

//给容器中加入我们自己定义的ErrorAttributes
@Component
 class MyErrorAttributes extends DefaultErrorAttributes
{
    @Override
    public Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
        Map<String, Object> map = super.getErrorAttributes(webRequest, includeStackTrace);
        map.put("company","大忽悠集团有限公司");
        //我们从request域中获取的数据
        Object msg = webRequest.getAttribute("error", 0);
        Object msg1 = webRequest.getAttribute("msg", 0);
        map.put("mistakes",msg);
        map.put("msg",msg1);
        return map;
    }
}