SpringBoot_错误处理机制_定制错误

一、自动配置类

• /org/springframework/boot/spring-boot-test-autoconfigure/1.5.10.RELEASE/spring-boot-test-autoconfigure-1.5.10.RELEASE.jar!/META-INF/spring.factories
• org.springframework.boot.autoconfigure.web.ErrorMvcAutoConfiguration

---

二、默认的错误处理

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

SpringBoot 是根据浏览器发送请求的请求头，来决定返回的类型

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

---

三、SpringBoot 原理实现

可以参照ErrorMvcAutoConfiguration，错误处理的自动配置，给容器中添加了以下组件

1. DefaultErrorAttributes
2. BasicErrorController：处理默认/error请求
3. ErrorPageCustomizer
4. DefaultErrorViewResolver

a）DefaultErrorAttributes

//帮我们在页面共享信息
//org.springframework.boot.autoconfigure.web.DefaultErrorAttributes#getErrorAttributes
@Override
public Map getErrorAttributes(RequestAttributes requestAttributes,
		boolean includeStackTrace) {
	Map errorAttributes = new LinkedHashMap();
	errorAttributes.put("timestamp", new Date());
	addStatus(errorAttributes, requestAttributes);
	addErrorDetails(errorAttributes, requestAttributes, includeStackTrace);
	addPath(errorAttributes, requestAttributes);
	return errorAttributes;
}

可以在页面取出的值有

1. timestamp
2. status
3. error
4. exception
5. path

b）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 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> error(HttpServletRequest request) {
	Map body = getErrorAttributes(request,
			isIncludeStackTrace(request, MediaType.ALL));
	HttpStatus status = getStatus(request);
	return new ResponseEntity>(body, status);
}

 c）ErrorPageCustomizer

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

d）DefaultErrorViewResolver 

@Override
public ModelAndView resolveErrorView(HttpServletRequest request, HttpStatus status,
		Map 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 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 model) {
    //所有的ErrorViewResolver得到ModelAndView
   for (ErrorViewResolver resolver : this.errorViewResolvers) {
      ModelAndView modelAndView = resolver.resolveErrorView(request, status, model);
      if (modelAndView != null) {
         return modelAndView;
      }
   }
   return null;
}

---

四、如何定制错误响应

a）有模板引擎的情况下

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

页面能获取的信息

1. ​ timestamp：时间戳
2. ​ status：状态码
3. ​ error：错误提示
4. ​ exception：异常对象
5. ​ message：异常消息
6. ​ errors：JSR303数据校验的错误都在这里

b）没有模板引擎

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

c）以上都没有

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

---

五、如何定制错误的json数据

a）自定义异常处理&返回定制json数据

@ControllerAdvice
public class MyExceptionHandler {

    @ResponseBody
    @ExceptionHandler(UserNotExistException.class)
    public Map handleException(Exception e){
        Map map = new HashMap<>();
        map.put("code","user.notexist");
        map.put("message",e.getMessage());
        return map;
    }
}
//没有自适应效果...

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

@ExceptionHandler(UserNotExistException.class)
public String handleException(Exception e, HttpServletRequest request){
	Map 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";
}

这个时候我们携带的 code 和 message 是不能携带过去的，为什么要传 javax.servlet.error.status_code 这个是根据后面代码来的

@Controller
@RequestMapping("${server.error.path:${error.path:/error}}")
public class BasicErrorController extends AbstractErrorController {

//org.springframework.boot.autoconfigure.web.BasicErrorController#errorHtml
@RequestMapping(produces = "text/html")
public ModelAndView errorHtml(HttpServletRequest request,
		HttpServletResponse response) {
	HttpStatus status = getStatus(request);
	Map 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);
}
//org.springframework.boot.autoconfigure.web.BasicErrorController#error
@RequestMapping
@ResponseBody
public ResponseEntity> error(HttpServletRequest request) {
	Map body = getErrorAttributes(request,
			isIncludeStackTrace(request, MediaType.ALL));
	HttpStatus status = getStatus(request);
	return new ResponseEntity>(body, status);
}

//org.springframework.boot.autoconfigure.web.AbstractErrorController#getStatus
protected HttpStatus getStatus(HttpServletRequest request) {
	Integer statusCode = (Integer) request
			.getAttribute("javax.servlet.error.status_code");
	if (statusCode == null) {
		return HttpStatus.INTERNAL_SERVER_ERROR;
	}
	try {
		return HttpStatus.valueOf(statusCode);
	}
	catch (Exception ex) {
		return HttpStatus.INTERNAL_SERVER_ERROR;
	}
}

 c）将我们的定制数据携带出去

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

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

 

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

SpringBoot 默认是有这个类的，如果我们写了就用我们自己的

//org.springframework.boot.autoconfigure.web.ErrorMvcAutoConfiguration#errorAttributes
@Bean
@ConditionalOnMissingBean(value = ErrorAttributes.class, search = SearchStrategy.CURRENT)
public DefaultErrorAttributes errorAttributes() {
	return new DefaultErrorAttributes();
}

 自定义ErrorAttributes

//给容器中加入我们自己定义的ErrorAttributes
@Component
public class MyErrorAttributes extends DefaultErrorAttributes {

    @Override
    public Map getErrorAttributes(RequestAttributes requestAttributes, boolean includeStackTrace) {
        Map map = super.getErrorAttributes(requestAttributes, includeStackTrace);
        map.put("company","atguigu");
        return map;
    }
}

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