1) springboot默认的错误处理机制
默认效果：
1) 浏览器， 返回一个默认的错误页面
springboot默认错误页面.png
2) 如果是其他客户端，默认响应一个json数据．
原理：
可以参照ErrorMvcAutoConfiguration：错误处理的自动配置
a. DefaultErrorAttributes
@Override
public 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;
}
b. BasicErrorController：处理/error请求
@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);
}
c. ErrorPageCustomizer
public class ErrorProperties {
// 系统出现错误后来到error请求进行处理；（web.xml注册的错误页面规则）
/**
* Path of the error controller.
*/
@Value("${error.path:/error}")
private String path = "/error";
d. 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对应的页面
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;
}
2) 如何定制错误响应
-
如何定制错误页面
1) 有模板引擎情况，error/404.html ［将错误页面命名为错误状态码.html放在模板引擎文件里的error文件夹下］，发生此状态码的错误就会来到对应的页面．
我们可以使用4xx和5xx命名的错误页面来匹配这种类型的错误，精确优先（优先寻找精确的状态码.html）
可以获取到的信息：
timestamp：时间戳
status：状态码
error：错误提示
exception：异常
message：异常信息
errors：JSR303数据校验的错误都在这里2) 没有模板引擎，去静态资源下寻找
3) 以上都没有，来到springboot的默认空白页面
- 如何定制错误的json数据
a. 自定义异常处理，返回定制的json数据
@ResponseBody
@ControllerAdvice
public class MyExceptionHandler {
@ExceptionHandler(UserNotExistException.class)
public Map<String, Object> handlerException(Exception e){
Map<String,Object> map = new HashMap<>();
map.put("codes","user.notExist");
map.put("message",e.getMessage());
return map;
}
}
// 没有自适应效果，不管是其他客户端还是浏览器都是返回json数据
b. 转发到/error进行自适应响应效果处理
@ExceptionHandler(UserNotExistException.class)
public String handlerException(Exception e, HttpServletRequest req) {
Map<String, Object> map = new HashMap<>();
// 传入自己的状态吗，
req.setAttribute("javax.servlet.error.status_code",500);
map.put("codes", "用户出错了");
map.put("message", e.getMessage());
return "forward:/error";
}
c. 将我们的定制数据携带出去
出现错误以后，会来到/error请求，会被BasicErrorController处理，响应出去可以获取的数据，是由getErrorAttributes得到的（是由AbstractErrorController(ErrorController)规定的方法）
- 完全编写一个ErrorController的实现类［或者是编写AbstractErrorController的子类］，放在容器中
- 第二种，页面上能用的数据，或者是json返回能用的数据都是通过errorAttributes得到；容器中DefaultErrorAttributes默认进行数据处理的．
自定义
@ExceptionHandler(UserNotExistException.class)
public String handlerException(Exception e, HttpServletRequest req) {
Map<String, Object> map = new HashMap<>();
// 传入自己的状态吗，
req.setAttribute("javax.servlet.error.status_code",500);
map.put("codes", "用户出错了");
map.put("message", e.getMessage());
req.setAttribute("mm",map);
return "forward:/error";
}
@Component
public class MyErrorAttributes extends DefaultErrorAttributes {
@Override
public Map<String, Object> getErrorAttributes(WebRequest request, boolean includeStackTrace) {
Map<String, Object> map = super.getErrorAttributes( request,includeStackTrace);
map.put("say","靳飞虎，大笨蛋");
Map<String,Object> mm = (Map) request.getAttribute("mm", 0);
map.put("message",mm);
return map;
}
}
最终的效果，响应是自适应的，可以通过定制ErrorAttributes改变需要返回的内容．
