SpringBoot——错误处理机制

一、SpringBoot默认的错误处理机制

默认效果：浏览器，返回一个默认的错误页面。

浏览器发送请求的请求头：

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

1.1 原理

为什么会产生默认效果？可以参照ErrorMvcAutoConfiguration这个类。
给容器中添加了以下组件
1、DefaultErrorAttributes
帮我们在页面共享信息

public Map<String, Object> getErrorAttributes(ServerRequest request, boolean includeStackTrace) {
    Map<String, Object> errorAttributes = new LinkedHashMap();
    errorAttributes.put("timestamp", new Date());
    errorAttributes.put("path", request.path());
    Throwable error = this.getError(request);
    MergedAnnotation<ResponseStatus> responseStatusAnnotation = MergedAnnotations.from(error.getClass(), SearchStrategy.TYPE_HIERARCHY).get(ResponseStatus.class);
    HttpStatus errorStatus = this.determineHttpStatus(error, responseStatusAnnotation);
    errorAttributes.put("status", errorStatus.value());
    errorAttributes.put("error", errorStatus.getReasonPhrase());
    errorAttributes.put("message", this.determineMessage(error, responseStatusAnnotation));
    errorAttributes.put("requestId", request.exchange().getRequest().getId());
    this.handleException(errorAttributes, this.determineException(error), includeStackTrace);
    return errorAttributes;
}

2、BasicErrorController

@Controller
@RequestMapping({"${server.error.path:${error.path:/error}}"})
public class BasicErrorController extends AbstractErrorController {

	@RequestMapping(
        produces = {"text/html"}		//产生html类型的数据；浏览器发送的请求来到这个处理
    )
    public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) {
        HttpStatus status = this.getStatus(request);
        Map<String, Object> model = Collections.unmodifiableMap(this.getErrorAttributes(request, this.isIncludeStackTrace(request, MediaType.TEXT_HTML)));
        response.setStatus(status.value());
//去哪个页面作为错误页面，包含页面地址和页面内容
        ModelAndView modelAndView = this.resolveErrorView(request, response, status, model);
        return modelAndView != null ? modelAndView : new ModelAndView("error", model);
    }

    @RequestMapping	//产生json数据的；客户端发生的请求来到这个方法处理
    public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
        HttpStatus status = this.getStatus(request);
        if (status == HttpStatus.NO_CONTENT) {
            return new ResponseEntity(status);
        } else {
            Map<String, Object> body = this.getErrorAttributes(request, this.isIncludeStackTrace(request, MediaType.ALL));
            return new ResponseEntity(body, status);
        }
    }

3、ErrorPageCustomizer

public class ErrorProperties {
    @Value("${error.path:/error}")
    private String path = "/error";	//系统出现错误以后，来到error请求进行处理

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

public ModelAndView resolveErrorView(HttpServletRequest request, HttpStatus status, Map<String, Object> model) {
    ModelAndView modelAndView = this.resolve(String.valueOf(status.value()), model);
    if (modelAndView == null && SERIES_VIEWS.containsKey(status.series())) {
        modelAndView = this.resolve((String)SERIES_VIEWS.get(status.series()), model);
    }

    return modelAndView;
}

private ModelAndView resolve(String viewName, Map<String, Object> model) {
	//默认SpringBoot可以找到一个页面?error/404
    String errorViewName = "error/" + viewName;
	//模板引擎可以解析这个页面地址就用模板引擎解析
    TemplateAvailabilityProvider provider = this.templateAvailabilityProviders.getProvider(errorViewName, this.applicationContext);
    //模板引擎可用的情况下放回到errorViewName指定的视图地址
    //模板引擎不可用，就在静态资源文件夹下找errorViewName对应的页面 error/404.html
    return provider != null ? new ModelAndView(errorViewName, model) : this.resolveResource(errorViewName, model);
}

private ModelAndView resolveResource(String viewName, Map<String, Object> model) {
    String[] var3 = this.resourceProperties.getStaticLocations();
    int var4 = var3.length;

    for(int var5 = 0; var5 < var4; ++var5) {
        String location = var3[var5];

        try {
            Resource resource = this.applicationContext.getResource(location);
            resource = resource.createRelative(viewName + ".html");
            if (resource.exists()) {
                return new ModelAndView(new DefaultErrorViewResolver.HtmlResourceView(resource), model);
            }
        } catch (Exception var8) {
        }
    }

    return null;
}

public void render(Map<String, ?> model, HttpServletRequest request, HttpServletResponse response) throws Exception {
    if (response.isCommitted()) {
        String message = this.getMessage(model);
        logger.error(message);
    } else {
        response.setContentType(TEXT_HTML_UTF8.toString());
        StringBuilder builder = new StringBuilder();
        Date timestamp = (Date)model.get("timestamp");
        Object message = model.get("message");
        Object trace = model.get("trace");
        if (response.getContentType() == null) {
            response.setContentType(this.getContentType());
        }

        builder.append("
Whitelabel Error Page
").append("
This application has no explicit mapping for /error, so you are seeing this as a fallback.
").append("
").append(timestamp).append("
").append("
There was an unexpected error (type=").append(this.htmlEscape(model.get("error"))).append(", status=").append(this.htmlEscape(model.get("status"))).append(").
");
        if (message != null) {
            builder.append("
").append(this.htmlEscape(message)).append("
");
        }

        if (trace != null) {
            builder.append("
").append(this.htmlEscape(trace)).append("
");
        }

        builder.append("");
        response.getWriter().append(builder.toString());
    }
}

1.2 如果定制错误响应

1.2.1 如何定制错误的页面

① 有模板引擎的情况下；error/状态码【将错误页面命名为 错误状态码.html 放在模板引擎文件夹里面的error文件夹下】，发生此状态码错误就会来到对应的页面；
我们可以使用4xx和5xx作为错误页面的文件名来匹配这种类型的所有错误，精确优先（优先寻找精确的状态码.html）
页面能获取的信息:

• timestamp 时间戳
• status 状态码
• error 错误提示
• exception 异常
• message 异常消息
• errors JSR303数据校验的错误都在这里

② 没有模板引擎（模板引擎找不到这个错误页面），静态资源文件夹下
③ 以上都没有错误页面，就默认来到SpringBoot默认的错误提示页面

1.2.2 如何定制错误的json数据

1）自定义异常处理&返回定制json数据

@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数据

2）转发到error进行自适应响应效果

@ExceptionHandler(UserNotExistException.class)
public String HandleException(Exception e, HttpServletRequest request){
    Map<String,Object> map=new HashMap<>();
    //传入自己的状态码，4xx，5xx，否则就不会进入定制错误页面的的解析流程
    request.setAttribute("javax.servlet.error.status_code",500);
    map.put("code","user.notexist");
    map.put("message",e.getMessage());
//        return map;
    return "forward:/error";
}

3）将我们的定制的数据携带出去
出现错误以后，会来到/error请求，会被BasicErrorController处理，响应出去可以获取的数据是由getErrorAttributes得到的（是AbstractErrorController规定的方法）；
  1、完全来编写一个ErrorController的实现类d【或者是编写AbstractErrorController的子类】，放在容器中。
  2、页面上能用的数据，或者是json返回能用到的数据都是通过errorAttributes.getErrorAttributes得到的，容器中DefaultErrorAttributes.getErrorAttributes();默认进行数据处理的
自定义ErrorAttributes

@Component
public 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","achao");
        //我们的异常处理器携带的数据
        Map<String,Object> ext = (Map<String, Object>) webRequest.getAttribute("ext",0);
        map.put("ext",ext);
        return map;
    }
}

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