Spring Boot的错误处理机制

spring boot的默认处理机制

默认效果：

​ 1）、浏览器，返回一个默认的错误页面

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

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

客户端发送请求的请求头：

原理： ​ 可以参照***ErrorMvcAutoConfiguration***；错误处理的自动配置；

ErrorMvcAutoConfiguration类主要是给容器中添加了以下组件：

1. DefaultErrorAttributes：

   帮我们在页面共享信息；界面上显示的数据就是这个类进行封装的
   @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注册的错误页面规则）
@Override
		public void registerErrorPages(ErrorPageRegistry errorPageRegistry) {
			ErrorPage errorPage = new ErrorPage(this.properties.getServletPrefix()
					+ this.properties.getError().getPath()); //这里就是拿到路径的
			errorPageRegistry.addErrorPages(errorPage);
		}

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）如何定制错误的页面

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

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

2. 没有模板引擎（模板引擎找不到这个错误页面），静态资源文件夹下找；
3. 以上都没有错误页面，就是默认来到SpringBoot默认的错误提示页面；
   AbstractErrorController类的resolveErrorView->
   
   继续调用ErrorViewResolver类的resolveErrorView
   
   继续调用 resolve就来到了下面，进行错误试图的路径解析也就是之前说的DefaultErrorViewResolver
   
   如果说模板引擎和静态资源下也都没有找到error/状态码.html就会返回一个null这样就会使用springboot的默认界面 代码在下面
   
   这个error是 ErrorMvcAutoConfiguration中定义的，代码如下：
   
   （整整看了一晚上才把这个逻辑弄清楚，真的是无语了！！！哎）

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

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

底层运行流程：
在错误信息的自动配置类中：ErrorMvcAutoConfiguration类，注解首先是导入了ResourceProperties资源

1. 首先 ErrorPageCustomizer类定制错误信息，其实就是返回一个ErrorPage 核心就是获得一个路径/error
   
2. 接下来BasicErrorController类进行解析，他其实主要是通过调用DefaultErrorAttributes类里的 getErrorAttributes方法进行获取信息
   
   然后可以看一下 BasicErrorController组件，
   表示说如果有ErrorController就不会生效了，所以你如果想完全的接管获取信息的组件你就直接继承这个接口就行了，但是不建议这么做，那怎么能让他自己配置的生效，并且原来的还能用呢，就是之前说的了。BasicErrorController类进行解析，他其实主要是通过调用DefaultErrorAttributes类里的 getErrorAttributes方法进行获取信息，所以我们可以直接继承DefaultErrorAttributes这个类，然后重写里面获取信息的方法就行了。
   
   这样就能吧我们的信息携带出去了。

整个springboot的错误信息处理流程包括各种情况：