【SpringBoot】SpringBoot 错误处理机制（九）

　　本例介绍SpringBoot错误处理机制

错误处理现象

　　新建一个SpringBoot Web项目，在浏览器中随便输入一个错误地址进行访问，如：http://localhost:8081/test/aa，会出现一个错误页面

　　浏览器页面错误：

　　　　

　　如果用PostMan请求错误地址，得到一个Json错误

　　Json错误：

　　　　

错误处理原理

　　可以参考ErrorMvcAutoConfiguration，错误处理的自动配置

　　一但系统出现4xx或者5xx之类的错误;ErrorPageCustomizer就会生效(定制错误的响应规则);就会来到/error请求;就会被BasicErrorController处理;

　　1、DefaultErrorAttributes: 错误请求中有的属性

@Override
public Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
    Map<String, Object> errorAttributes = new LinkedHashMap<>();
    errorAttributes.put("timestamp", new Date());
    addStatus(errorAttributes, webRequest);
    addErrorDetails(errorAttributes, webRequest, includeStackTrace);
    addPath(errorAttributes, webRequest);
    return errorAttributes;
}

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

// 产生error界面
@RequestMapping(produces = MediaType.TEXT_HTML_VALUE)
public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) {
    HttpStatus status = getStatus(request);
    Map<String, Object> model = Collections
            // getErrorAttributes 获取错误内容
            .unmodifiableMap(getErrorAttributes(request, isIncludeStackTrace(request, MediaType.TEXT_HTML)));
    response.setStatus(status.value());

    // 去哪个错误界面
    ModelAndView modelAndView = resolveErrorView(request, response, status, model);
    return (modelAndView != null) ? modelAndView : new ModelAndView("error", model);
}

// 产生错误json数据
@RequestMapping
public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
    Map<String, Object> body = getErrorAttributes(request, isIncludeStackTrace(request, MediaType.ALL));
    HttpStatus status = getStatus(request);
    return new ResponseEntity<>(body, status);
}

　　3、ErrorPageCustomizer: 系统出现错误以后来到error请求进行处理;(web.xml注册的错误页面规则)

/**
 * {@link WebServerFactoryCustomizer} that configures the server's error pages.
 */
private static class ErrorPageCustomizer implements ErrorPageRegistrar, Ordered {

    private final ServerProperties properties;

    private final DispatcherServletPath dispatcherServletPath;

    protected ErrorPageCustomizer(ServerProperties properties, DispatcherServletPath dispatcherServletPath) {
        this.properties = properties;
        this.dispatcherServletPath = dispatcherServletPath;
    }

    // 注入错误页面
    @Override
    public void registerErrorPages(ErrorPageRegistry errorPageRegistry) {
        ErrorPage errorPage = new ErrorPage(
                this.dispatcherServletPath.getRelativePath(this.properties.getError().getPath()));
        errorPageRegistry.addErrorPages(errorPage);
    }

    @Override
    public int getOrder() {
        return 0;
    }

}

　　　　// 错误路径配置

@Value("${error.path:/error}")
private String path = "/error"; 

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

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

        // status.series() 状态码
        modelAndView = resolve(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);

    if (provider != null) {
        //模板引擎可用的情况下返回到errorViewName指定的视图地址
        return new ModelAndView(errorViewName, model);
    }
    //模板引擎不可用，就在静态资源文件夹下找errorViewName对应的页面 error/404.html
    return resolveResource(errorViewName, model);
}

定制错误响应

　　1、定制错误的页面

　　　　a、有模板引擎的情况下;error/状态码; 【将错误页面命名为 错误状态码.html 放在模板引擎文件夹里面的error文件夹下】，发生此状态码的错误就会来到 对应的页面; 可以使用4xx和5xx作为错误页面的文件名来匹配这种类型的所有错误，精确优先(优先寻找精确的状态码.html);

　　　　　　页面能获取的信息:

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

　　　　　　

　　　　　　404.html如下：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>404</title>
</head>
<body>
    <h3> 404 </h3>
    <h3> [[${status}]]</h3>
    <h3> [[${timestamp}]]</h3>
</body>
</html>

　　

　　　　b、没有模板引擎(模板引擎找不到这个错误页面)，静态资源文件夹下找;

　　　　　　

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

　　2、定制错误的json数据

　　　　a、自定义异常处理&返回定制json数据;没有自适应效果

package com.test.springboot.controller;

import com.test.springboot.exception.UserNotExistException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.servlet.http.HttpServletRequest;
import java.util.HashMap;
import java.util.Map;

@ControllerAdvice
public class MyExceptionHandler {

    // 浏览器和客户端返回的都是json
    @ResponseBody
    @ExceptionHandler(UserNotExistException.class)
    public Map<String, Object> handlerException(Exception e){
        HashMap<String, Object> map = new HashMap<>();
        map.put("code", "not.exist");
        map.put("message", e.getMessage());
        return map;
    }
}

　　　　b、转发到/error进行自适应响应效果处理

    // 页面请求 返回错误页面
    // 非页面请求 返回json数据
    @ExceptionHandler(UserNotExistException.class)
    public String handlerException(Exception e, HttpServletRequest request){
        // 设置自己的错误状态码 4xx 5xx
        // 否则就不会进入定制错误页面的解析流程
        /**
         * Integer statusCode = (Integer) request.getAttribute("javax.servlet.error.status_code");
         */
        request.setAttribute("javax.servlet.error.status_code", 500);

        HashMap<String, Object> map = new HashMap<>();
        map.put("code", "not.exist");
        map.put("message", e.getMessage());
        // 转发的error请求
        return "forward:/error";
    }

　　　　c、将定制数据携带出去

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

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

　　　　　　方法2、页面上能用的数据，或者是json返回能用的数据都是通过errorAttributes.getErrorAttributes得到; 容器中DefaultErrorAttributes.getErrorAttributes();默认进行数据处理的;

　　　　　　　　方法2实现如下：

// 给容器中添加自定义的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", "test.com");
        // 加入请求域request中的数据
        map.put("ext", webRequest.getAttribute("ext", 0));

        return map;
    }
}

　　　　　　　　效果如下（如果是页面，直接用${ext.code }获取即可）：