默认效果:(访问一个不存在的页面)
- 浏览器访问会返回一个默认的错误页面
- 其他客户端访问会默认响应一个JSON数据
- 哪SpringBoot是怎么区分用户使用的是浏览器还是其他客户端呢?
SpringBoot会根据用户发送请求中的Content-Type信息来返回对应的异常内容,如果Content-Type是application/json则返回JSON文件,如果Content-Type是text/html,则返回html页面
原理:
可以参照ErrorMvcAutoConfiguration;错误处理的自动配置;
SpringBoot给容器中添加了以下组件
1)、DefaultErrorAttributes;
# 帮我们在页面共享信息
private Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
Map<String, Object> errorAttributes = new LinkedHashMap<>();
errorAttributes.put("timestamp", new Date());
addStatus(errorAttributes, webRequest);
addErrorDetails(errorAttributes, webRequest, includeStackTrace);
addPath(errorAttributes, webRequest);
return errorAttributes;
}
2)、BasicErrorController;
# 处理默认/error请求
@Controller
@RequestMapping("${server.error.path:${error.path:/error}}")
public class BasicErrorController extends AbstractErrorController {
@RequestMapping(produces = MediaType.TEXT_HTML_VALUE)// 产生HTML类型的数据 浏览器发送的请求来到这个方法处理
public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) {
HttpStatus status = getStatus(request);
Map<String, Object> model = Collections
.unmodifiableMap(getErrorAttributes(request, getErrorAttributeOptions(request, MediaType.TEXT_HTML)));
response.setStatus(status.value());
// 去哪个页面作为错误页面;包含页面地址和页面内容
ModelAndView modelAndView = resolveErrorView(request, response, status, model);
return (modelAndView != null) ? modelAndView : new ModelAndView("error", model);
}
@RequestMapping // 产生JSON类型的数据,其他客户端则来到这个方法处理
public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
HttpStatus status = getStatus(request);
if (status == HttpStatus.NO_CONTENT) {
return new ResponseEntity<>(status);
}
Map<String, Object> body = getErrorAttributes(request, getErrorAttributeOptions(request, MediaType.ALL));
return new ResponseEntity<>(body, status);
}
3)、ErrorPageCustomizer;
# 系统出现错误以后来到error请求进行处理
@Value("${error.path:/error}")
private String path = "/error";
4)、DefaultErrorViewResolver;
@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
return resolveResource(errorViewName, model);
}
步骤:
一但系统出现4xx或者5xx之类的错误;ErrorPageCustomizer就会生效(定制错误的响应规则);然后会来到/error请求;就会被BasicErrorController处理;
1)、响应页面;去哪个也页面是由DefaultErrorViewResolver解析得到的
protected ModelAndView resolveErrorView(HttpServletRequest request, HttpServletResponse response, HttpStatus status,
Map<String, Object> model) {
//所有的ErrorViewReslover得到ModelAndView
for (ErrorViewResolver resolver : this.errorViewResolvers) {
ModelAndView modelAndView = resolver.resolveErrorView(request, status, model);
if (modelAndView != null) {
return modelAndView;
}
}
return null;
}
- 1)、 如果定制错误响应;
- 1)、如果定制错误页面
- 1)、有模板引擎的情况下;error/状态码;【将错误页面命名为 错误状态码.html放在模板引擎文件夹下的error文件夹下】,发生次状态码的错误就会来到 对应的页面;
- 我们可以使用4xx或5xx作为错误页面的文件名来匹配这种类型的所有错误,精确优先(优先寻找精确的状态码.html)
- 页面能获取的信息
timestamp:时间戳
status:状态码
error:错误提示
exception:异常对象
message:错误信息
path:请求地址
errors:JSR303校验的错误 - 2)、没有模板引擎(模板引擎找不到)、就会去静态页面找;
- 3)、以上都没有错误页面,就是默认来到SpringBoot默认的错误提示页面
- 1)、如果定制错误页面
- 2)、响应JSON