Spring Boot 默认的错误处理机制 & 定制错误页面

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/Java_Glory/article/details/89922449

原理:

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

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

          1,DefaultErrorAttributes:在页面共享信息

          2,BasicErrorController:处理默认的 /error 请求

          3,ErrorPageCustomizer:定制错误的响应规则

          4,DefaultErrorViewResolver :响应解析的视图页面

步骤:

          1,一旦系统出现4xx或者5xx之类的错误,ErrorPageCustomizer就会生效,就会来到 /error 请求 ;

    @Value("${error.path:/error}")
    private String path = "/error";//系统出现错误以后来到error请求进行处理;(类似web.xml注册的错误页面规则)

          2,就会被 BasicErrorController 处理 /error 请求

@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 ? new ModelAndView("error", model) : modelAndView;
    }

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

    .....
    //浏览器发请求的请求头accept:优先"text/html",所以浏览器访问会得到一个html的空白(错误信息的页面)页面
    //其他客户端发送请求的请求头accept:"*/*",所以客户端访问会得到一串json格式的数据

}

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

    protected ModelAndView resolveErrorView(HttpServletRequest request, HttpServletResponse response, HttpStatus status, Map<String, Object> model) {

        //所有的 ErrorViewResolver 得到 ModelAndView 
        Iterator var5 = this.errorViewResolvers.iterator();

        ModelAndView modelAndView;
        do {
            if (!var5.hasNext()) {
                return null;
            }

            ErrorViewResolver resolver = (ErrorViewResolver)var5.next();
            modelAndView = resolver.resolveErrorView(request, status, model);
        } while(modelAndView == null);

        return modelAndView;
    }
    public ModelAndView resolveErrorView(HttpServletRequest request, HttpStatus status, Map<String, Object> model) {
        ModelAndView modelAndView = this.resolve(String.valueOf(status), 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) {
        //默认Spring Boot可以去找到一个页面 error/404.html
        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);
    }

4.DefaultErrorAttributes在页面共享信息

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

如何定制错误响应:

     1,如何定制错误的页面

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

页面能获取的信息;
​	timestamp:时间戳
​	status:状态码
​	error:错误提示
​	exception:异常对象
​	message:异常消息
​	errors:JSR303数据校验的错误都在这里
<h1>status:[[${status}]]</h1>
<h2>timestamp:[[${timestamp}]]</h2>
.....

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

          ③:以上都没有错误页面,就是默认来到SpringBoot默认的错误提示页面;

     2,如何定制错误的json数据

          ①:自定义处理异常 & 返回定制json数据;

    //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;
    }
    //没有自适应效果。

          ②:转发到/error进行自适应响应效果处理

    @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请求,会被BasicErrorController处理,响应出去可以获取的数据是由getErrorAttributes得到的         (是AbstractErrorController(ErrorController)规定的方法);

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

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

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

自定义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;
    }
}

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

					<h1>status:[[${status}]]</h1>
					<h2>timestamp:[[${timestamp}]]</h2>
					<h2>exception:[[${exception}]]</h2>
					<h2>message:[[${message}]]</h2>
					<h2>ext:[[${ext.code}]]</h2>
					<h2>ext:[[${ext.message}]]</h2>

本文需结合代码片段内的文字注释浏览。

猜你喜欢

转载自blog.csdn.net/Java_Glory/article/details/89922449