springboot的错误处理机制

springboot的错误处理机制

可以参照ErrorMvcAutoConfiguration

DefaultErrorAttributes

@Bean
	@ConditionalOnMissingBean(value = ErrorAttributes.class,
			search = SearchStrategy.CURRENT)
	public DefaultErrorAttributes errorAttributes() {
		return new DefaultErrorAttributes(
				this.serverProperties.getError().isIncludeException());
	}

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

BasicErrorController

@Bean
	@ConditionalOnMissingBean(value = ErrorController.class,
			search = SearchStrategy.CURRENT)
	public BasicErrorController basicErrorController(ErrorAttributes errorAttributes) {
		return new BasicErrorController(errorAttributes, this.serverProperties.getError(),
				this.errorViewResolvers);
	}

@Controller
@RequestMapping("${server.error.path:${error.path:/error}}")
public class BasicErrorController extends AbstractErrorController {
//产生html
@RequestMapping(produces = MediaType.TEXT_HTML_VALUE)
	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) ? 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);
	}
	}

ErrorPageCustomizer

@Bean
	public ErrorPageCustomizer errorPageCustomizer() {
		return new ErrorPageCustomizer(this.serverProperties, this.dispatcherServletPath);
	}

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

DefaultErrorViewResolver

@Bean
		@ConditionalOnBean(DispatcherServlet.class)
		@ConditionalOnMissingBean
		public DefaultErrorViewResolver conventionErrorViewResolver() {
			return new DefaultErrorViewResolver(this.applicationContext,
					this.resourceProperties);
		}

@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())) {
			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

• 响应页面: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;
  }

如果定制错误响应：

• 有模板引擎，error/状态码，放在templates文件夹下的error文件夹下。可以使用4xx和5xx作为错误页面来匹配所有的错误。精确优先
  页面能获取的信息：
  timestamp:时间戳
  status：状态码
  error：错误提示
  exception：异常对象
  message：异常消息
  errors：JSR303数据校验的错误
• 没有模板引擎，在静态资源文件夹下面找
• 都没有，就是默认来到springboot默认的错误页面