SpringBoot错误处理机制

SpringBoot错误处理的自动配置由 ErrorMvcAutoConfiguration提供，所以我们从对此类的分析入手研究错误处理机制。

一. DefaultErrorAttributes

可以看出此组件帮助我们在页面共享信息。

二. BasicErrorController

可以看出此组件处理默认/error请求。但是第一个方法产生html类型的数据，而第二个方法产生json数据。
html数据针对浏览器的错误处理，json针对非浏览器客户端的访问。


可以看出因为在浏览器中对所接受的数据类型限定为html，而在postman测试中，对接受数据的类型不做要求。

三. ErrorPageCustomizer

此组件负责错误页面的注册，系统出现错误以后来到error请求进行处理。

四. DefaultErrorViewResolver

此组件负责解析错误页面。

一但系统出现4xx或者5xx之类的错误；ErrorPageCustomizer就会生效（定制错误的响应规则）；就会来到/error请求；就会BasicErrorController处理，去哪个页面是由DefaultErrorViewResolver解析得到的；

五. 如何自定义错误响应页面

5.1 如何定制错误页面

​1）有模板引擎的情况

error/状态码，将错误页面命名为 :错误状态码.html 放在模板引擎文件夹里面的 error文件夹下,发生此状态码的错误就会来到 对应的页面。
我们可以使用4xx和5xx作为错误页面的文件名来匹配这种类型的所有错误，但是精确优先（优先寻找精确的状态码.html），比如存在404.html时，4xx.html在发生404不会被匹配。
​页面能获取的信息：

• timestamp：时间戳
• status：状态码
• error：错误提示
• exception：异常对象
• message：异常消息
• errors：JSR303数据校验的错误

2）没有模板引擎（模板引擎找不到这个错误页面）
去静态资源文件夹下找，但是此时的数据不能被模板引擎解析

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

5.2 如何定制返回的Json数据

首先给容器中加入我们自定义的ErrorAttributes

//给容器中加入我们自己定义的ErrorAttributes
@Component
public class MyErrorAttributes extends DefaultErrorAttributes {

    //返回值的map就是页面和json能获取的所有字段
    @Override
    public Map<String, Object> getErrorAttributes(RequestAttributes requestAttributes, boolean includeStackTrace) {
        Map<String, Object> map = super.getErrorAttributes(requestAttributes, includeStackTrace);
        map.put("company","atguigu");

        //我们的异常处理器携带的数据
        Map<String,Object> ext = (Map<String, Object>) requestAttributes.getAttribute("ext", 0);
        map.put("ext",ext);
        return map;
    }
}

利用父类的getErrorAttributes方法获得SpringBoot初始定义的Map数据，我们也可以自己往集合中加入自己想要展示的数据。比如

map.put("company","atguigu");

我们自定义一个异常：

public class UserNotExistException extends RuntimeException {

    public UserNotExistException() {
        super("用户不存在");
    }
}

再自定义一个Controller，在我们请求中刻意带参数触发异常。

@Controller
public class HelloController {
    @ResponseBody
    @RequestMapping("/hello")
    public  String hello(@RequestParam("user") String user){
        if(user.equals("aaa")){
            throw new UserNotExistException();
        }
        return "Hello World";
    }
}

我们定义一个全局异常处理器

@ControllerAdvice
public class MyExceptionHandler {
//    1、浏览器客户端返回的都是json
    @ResponseBody
    @ExceptionHandler(UserNotExistException.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;
    }
}

访问指定URL，我们触发异常，但是浏览器和Postman都得到Json格式的返回数据。
所以我们采用SpringBoot自带的BasicErrorController来自适应我们的请求。实现浏览器访问和Postman访问实现不同的返回数据格式。

@ControllerAdvice
public class MyExceptionHandler {
    @ExceptionHandler(UserNotExistException.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",500);
        map.put("code","user.notexist");
        map.put("message","用户出错啦");
        request.setAttribute("ext",map);
        //转发到/error
        return "forward:/error";
    }
}

我们重定向到/error请求进行处理，但是在request请求中我们必须自己传入状态码，而且可以再声明一个Map用来存储要返回的数据，并ErrorAttributes
中将此map加入。
从这里可以看出，我们要返回出的数据，必须要加到ErrorAttributes类中getErrorAttributes方法中。