SpringBoot - 异常处理

1. 错误页面

在SpringBoot中发生错误的时候，默认会自动返回一个错误页面，如404错误如下所示

而对于其他的客户端工具返回一个json数据

springboot对于错误处理的默认处理在WebMvcAutoConfiguration配置类中

里面有以下组件

DefaultErrorAttributes 
BasicErrorController 
ErrorPageCustomizer 
DefaultErrorViewResolver

首先看ErrorPageCustomizer ，当系统出现4xx，5xx的错误，ErrorPageCustomizer 就会生效，定制错误的响应规则

系统出现错误以后就会来到/error请求进行处理，之后就得有人处理这个请求，这个时候就来到了BasicErrorController 进行处理


对于这个请求他有两种响应方式，返回HTML和返回JSON，这就是我们上面针对浏览器和针对客户端返回的数据不一样的原因

但是他怎么知道这个请求是浏览器发送的还是客户端发送的呢？

可以看到在浏览器发送的请求的请求头中的Accept字段，优先接收html

而对于其他客户端请求头并没有配置html优先接收

那么对于浏览器发送的请求是怎么返回错误页面的呢？再看返回HTML的代码

返回类型是ModelAndView，ModelAndView是通过resolveErrorView生成的，我们看resolveErrorView

通过ErrorViewResolver生成ModelAndView，而ErrorViewResolver就是DefaultErrorViewResolver，由他解析去哪个错误页面

一句话概括这段代码就是他会去找 error/viewname的页面，viewname是状态码；如果模板引擎可以解析这个页面地址就用模板引擎解析，返回指定的视图地址，如果不可以，就会在静态资源文件下找error/viewname对于的页面

也可以使用error/4xx对于所有的4开头的状态码的所有错误

页面能获取的信息；
timestamp：时间戳
status：状态码
error：错误提示
exception：异常对象
message：异常消息
errors：JSR303数据校验的错误都在这里

2. 错误数据

上面我们可以做到配置自己的错误页面，放到error/下就行了，那么对于JSON数据怎么定制呢？可看错误处理

① 使用@ControllerAdvice

@ControllerAdvice
public class MyExceptionHandler {
    @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;
    }
}
//没有自适应效果...

这样就能返回自己的json数据了

但是没有自适应效果，浏览器返回的不是错误页面，也是json数据，因为我们确实是返回的json数据

② 可以转发到/error进行自适应响应效果处理
记得我们在上面说的，SpringBoot里面配置了BasicErrorController 处理/error请求，而BasicErrorController的处理就是自适应的，所以我们可以把在错误的处理中转发到/error，让BasicErrorController进行自适应处理

@ControllerAdvice
public class MyExceptionHandler {

    @ExceptionHandler(UserNotExistException.class)
    public String handlerException(Exception e){
            Map<String, Object> map = new HashMap<>();
            map.put("code","user not exist");
            map.put("message", e.getMessage());
            return "forward:/error";
    }
}

可以看到确实自适应了，但是并没有使用我们的错误页面，这是因为我们转发到/error的请求是成功了的，状态码是200，所以我们在转发的时候要设置状态码

@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",e.getMessage());
     //转发到/error
     return "forward:/error";
 }

但是这样你会发现我们好像并没有定制消息，在handleException好像并没有被存取

③ 将我们的定制数据携带出去
出现错误以后，会来到/error请求，会被BasicErrorController处理，响应出去可以获取的数据是由getErrorAttributes得到的

这个getErrorAttributes是AbstractErrorController的规定的方法，AbstractErrorController继承了ErrorController

而在我们的容器中的错误解析的组件都是在容器中没有ErrorController的时候生效

所以我们可以编写一个ErrorController的实现类，或者是编写AbstractErrorController的子类放在容器中；

但是这样太麻烦

我们发现页面上能用的数据，或者是json返回能用的数据都是通过errorAttributes.getErrorAttributes得到；容器中DefaultErrorAttributes.getErrorAttributes()默认进行数据处理的，我们可以自己定义ErrorAttributes

//给容器中加入我们自己定义的ErrorAttributes
@Component
public class MyErrorAttributes extends DefaultErrorAttributes {
    @Override
    public Map<String, Object> getErrorAttributes(RequestAttributes requestAttributes, boolean includeStackTrace) {
        Map<String, Object> map = super.getErrorAttributes(requestAttributes, includeStackTrace);
        map.put("company","111");
        return map;
    }
}

这样就有了自己的字段