尚硅谷学习笔记---SpringBoot错误处理机制

错误处理原理&定制错误页面

• 默认情况下当系统中错误错误的时候,SpringBoot的会跳转到一个空白页面,并显示默认的错误信息

• 有些情况下需要自定义错误页面和错误提示信息,那么要定制错误页面首先需要了解SpringBoot是如何处理系统错误的.
• 在SpringBoot自动配置中有以下组件参与处理错误信息,以下代码之中

帮我们在页面共享信息；
@Override
	public Map<String, Object> getErrorAttributes(RequestAttributes requestAttributes,
			boolean includeStackTrace) {
		Map<String, Object> errorAttributes = new LinkedHashMap<String, Object>();
		errorAttributes.put("timestamp", new Date());
		addStatus(errorAttributes, requestAttributes);
		addErrorDetails(errorAttributes, requestAttributes, includeStackTrace);
		addPath(errorAttributes, requestAttributes);
		return errorAttributes;
	}

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 = getStatus(request);
		Map<String, Object> model = Collections.unmodifiableMap(getErrorAttributes(
				request, isIncludeStackTrace(request, MediaType.TEXT_HTML)));
		response.setStatus(status.value());
        
        //去哪个页面作为错误页面；包含页面地址和页面内容
		ModelAndView modelAndView = 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 = getErrorAttributes(request,
				isIncludeStackTrace(request, MediaType.ALL));
		HttpStatus status = getStatus(request);
		return new ResponseEntity<Map<String, Object>>(body, status);
	}

3. ErrorPageCustomizer：

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

4、DefaultErrorViewResolver：

@Override
public ModelAndView resolveErrorView(HttpServletRequest request, HttpStatus status,
		Map<String, Object> model) {
	ModelAndView modelAndView = resolve(String.valueOf(status), model);
	if (modelAndView == null && SERIES_VIEWS.containsKey(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);
}

​

• 步骤：
• 一但系统出现4xx或者5xx之类的错误；ErrorPageCustomizer就会生效（定制错误的响应规则）；就会来到/error请求；就会被BasicErrorController处理；

1. 响应页面；去哪个页面是由DefaultErrorViewResolver解析得到的；

protected ModelAndView resolveErrorView(HttpServletRequest request,
      HttpServletResponse response, HttpStatus status, Map<String, Object> model) {
    //所有的ErrorViewResolver得到ModelAndView
   for (ErrorViewResolver resolver : this.errorViewResolvers) {
      ModelAndView modelAndView = resolver.resolveErrorView(request, status, model);
      if (modelAndView != null) {
         return modelAndView;
      }
   }
   return null;
}

定制错误页面

1. 有模板引擎的情况下；error/状态码; 【将错误页面命名为 错误状态码.html 放在模板引擎文件夹里面的 error文件夹下】，发生此状态码的错误就会来到 对应的页面；

• 我们可以使用4xx和5xx作为错误页面的文件名来匹配这种类型的所有错误，精确优先（优先寻找精确的状态码.html）；

• 页面能获取的信息；

属性名称	类型
​timestamp	时间戳
status	状态码
​error	错误提示
exception	异常对象
message	异常消息
errors	JSR303数据校验的错误都在这里

2. 没有模板引擎（模板引擎找不到这个错误页面），静态资源文件夹下找；

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

• 示例:在有模版的情况下,在templates文件夹下建立error文件夹

• 因为是通过templates模版引擎渲染的错误页面,因此可以在页面之中获取到错误信息

<h1>status:[[${status}]]</h1>
<h2>时间戳:[[${timestamp}]]</h2>
<h1>错误信息:[[${error}]]</h1>
<h1>异常对象:[[${exception}]]</h1>
<h1>异常信息:[[${message}]]</h1>
<h1>JSR303数据校验的错误:[[${errors}]]</h1>

定制错误json数据

• 自定义一个错误异常类—UserNoExistException

public class NoUserExistException extends RuntimeException {
    public NoUserExistException(){
        super("该用户不存在");
    }
}

1. 自定义异常处理类,定义处理NoUserExistException方法

@ControllerAdvice
public class MyExceptionHandler  {

    @ResponseBody
    @ExceptionHandler(value= NoUserExistException.class)
    public Map NoUserExistException(){
        Map<String,Object> map = new HashMap<>();
        map.put("code","user_noexist");
        map.put("msg","用户不存在");
        return map;
    }
}

• 通过这种方式可以定制错误json数据,但是无法做到自适应的效果,就是当用户通过浏览器访问的时候应该返回的是页面内容,而当用户通过其他客户端进行访问的时候应该返回json数据.

2. 改进上一个方法,通过转发返回页面

@ExceptionHandler(value = NoUserExistException.class)
public String NoUserExistException(Exception e, HttpServletRequest request) {
    //设置请求状态码,否则无法跳转到对应页面
    request.setAttribute("javax.servlet.error.status_code", 500);
    Map<String, Object> map = new HashMap<>();
    map.put("code", "user_noexist");
    map.put("msg", e.getMessage());
    return "forward:/error";
}

3. 通过转发可以做到自适应的效果,但是错误时所携带的参数是SpringBoot默认设置的参数.

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

  1. 完全来编写一个ErrorController的实现类【或者是编写AbstractErrorController的子类】，放在容器中；
  2. 页面上能用的数据，或者是json返回能用的数据都是通过errorAttributes.getErrorAttributes得到；

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

• 自定义ErrorAttributes

@Component
public class MyErrorAttributes extends DefaultErrorAttributes {
    @Override
    public Map<String, Object> getErrorAttributes(RequestAttributes requestAttributes, boolean includeStackTrace) {
        Map<String, Object> map = getErrorAttributes(requestAttributes, includeStackTrace);
        map.put("company","自定义数据");
        return map;
    }
}