博客列表 >21、【转载】Spring Boot默认异常处理

21、【转载】Spring Boot默认异常处理

自由之上
自由之上原创
2022年11月13日 09:01:53556浏览

在日常的 Web 开发中,会经常遇到大大小小的异常,此时往往需要一个统一的异常处理机制,来保证客户端能接收较为友好的提示。Spring Boot 同样提供了一套默认的异常处理机制,本节将对它进行详细的介绍。

1、Spring Boot 默认异常处理机制

Spring Boot 提供了一套默认的异常处理机制,一旦程序中出现了异常,Spring Boot 会自动识别客户端的类型(浏览器客户端或机器客户端),并根据客户端的不同,以不同的形式展示异常信息。

1、对于浏览器客户端而言,Spring Boot 会响应一个“ whitelabel”错误视图,以 HTML 格式呈现错误信息,如图 1;

图1:Spring Boot 默认错误白页

  1. 对于机器客户端而言,Spring Boot 将生成 JSON 响应,来展示异常消息。
    1. {
    2. "timestamp": "2021-07-12T07:05:29.885+00:00",
    3. "status": 404,
    4. "error": "Not Found",
    5. "message": "No message available",
    6. "path": "/m1ain.html"
    7. }

2、Spring Boot 异常处理自动配置原理

Spring Boot 通过配置类 ErrorMvcAutoConfiguration 对异常处理提供了自动配置,该配置类向容器中注入了以下 4 个组件。

  • ErrorPageCustomizer:该组件会在在系统发生异常后,默认将请求转发到“/error”上。
  • BasicErrorController:处理默认的“/error”请求。
  • DefaultErrorViewResolver:默认的错误视图解析器,将异常信息解析到相应的错误视图上。
  • DefaultErrorAttributes:用于页面上共享异常信息。

下面,我们依次对这四个组件进行详细的介绍。

1、ErrorPageCustomizer

ErrorMvcAutoConfiguration 向容器中注入了一个名为 ErrorPageCustomizer 的组件,它主要用于定制错误页面的响应规则

  1. @Bean
  2. public ErrorPageCustomizer errorPageCustomizer(DispatcherServletPath dispatcherServletPath) {
  3. return new ErrorPageCustomizer(this.serverProperties, dispatcherServletPath);
  4. }

ErrorPageCustomizer 通过 registerErrorPages() 方法来注册错误页面的响应规则。当系统中发生异常后,ErrorPageCustomizer 组件会自动生效,并将请求转发到 “/error”上,交给 BasicErrorController 进行处理,其部分代码如下。

  1. @Override
  2. public void registerErrorPages(ErrorPageRegistry errorPageRegistry) {
  3. //将请求转发到 /errror(this.properties.getError().getPath())上
  4. ErrorPage errorPage = new ErrorPage(this.dispatcherServletPath.getRelativePath(this.properties.getError().getPath()));
  5. // 注册错误页面
  6. errorPageRegistry.addErrorPages(errorPage);
  7. }

2、BasicErrorController

ErrorMvcAutoConfiguration 还向容器中注入了一个 错误控制器组件 BasicErrorController,代码如下。

  1. @Bean
  2. @ConditionalOnMissingBean(value = ErrorController.class, search = SearchStrategy.CURRENT)
  3. public BasicErrorController basicErrorController(ErrorAttributes errorAttributes, ObjectProvider<ErrorViewResolver> errorViewResolvers) {
  4. return new BasicErrorController(errorAttributes, this.serverProperties.getError(),
  5. errorViewResolvers.orderedStream().collect(Collectors.toList()));
  6. }

BasicErrorController 的定义如下。

  1. //BasicErrorController 用于处理 “/error” 请求
  2. @Controller
  3. @RequestMapping("${server.error.path:${error.path:/error}}")
  4. public class BasicErrorController extends AbstractErrorController {
  5. ......
  6. /**
  7. * 该方法用于处理浏览器客户端的请求发生的异常
  8. * 生成 html 页面来展示异常信息
  9. * @param request
  10. * @param response
  11. * @return
  12. */
  13. @RequestMapping(produces = MediaType.TEXT_HTML_VALUE)
  14. public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) {
  15. //获取错误状态码
  16. HttpStatus status = getStatus(request);
  17. //getErrorAttributes 根据错误信息来封装一些 model 数据,用于页面显示
  18. Map<String, Object> model = Collections
  19. .unmodifiableMap(getErrorAttributes(request, getErrorAttributeOptions(request, MediaType.TEXT_HTML)));
  20. //为响应对象设置错误状态码
  21. response.setStatus(status.value());
  22. //调用 resolveErrorView() 方法,使用错误视图解析器生成 ModelAndView 对象(包含错误页面地址和页面内容)
  23. ModelAndView modelAndView = resolveErrorView(request, response, status, model);
  24. return (modelAndView != null) ? modelAndView : new ModelAndView("error", model);
  25. }
  26. /**
  27. * 该方法用于处理机器客户端的请求发生的错误
  28. * 产生 JSON 格式的数据展示错误信息
  29. * @param request
  30. * @return
  31. */
  32. @RequestMapping
  33. public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
  34. HttpStatus status = getStatus(request);
  35. if (status == HttpStatus.NO_CONTENT) {
  36. return new ResponseEntity<>(status);
  37. }
  38. Map<String, Object> body = getErrorAttributes(request, getErrorAttributeOptions(request, MediaType.ALL));
  39. return new ResponseEntity<>(body, status);
  40. }
  41. ......
  42. }

Spring Boot 通过 BasicErrorController 进行统一的错误处理(例如默认的“/error”请求)。Spring Boot 会自动识别发出请求的客户端的类型(浏览器客户端或机器客户端),并根据客户端类型,将请求分别交给 errorHtml() 和 error() 方法进行处理。

返回值类型 方法声明 客户端类型 错误信息返类型
ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) 浏览器客户端 text/html(错误页面)
ResponseEntity<Map<String, Object>> error(HttpServletRequest request) 机器客户端(例如安卓、IOS、Postman 等等) JSON

换句话说,当使用浏览器访问出现异常时,会进入 BasicErrorController 控制器中的 errorHtml() 方法进行处理,
当使用安卓、IOS、Postman 等机器客户端访问出现异常时,就进入error() 方法处理。

在 errorHtml() 方法中会调用父类(AbstractErrorController)的 resolveErrorView() 方法,代码如下。

  1. protected ModelAndView resolveErrorView(HttpServletRequest request, HttpServletResponse response, HttpStatus status, Map<String, Object> model) {
  2. //获取容器中的所有的错误视图解析器来处理该异常信息
  3. for (ErrorViewResolver resolver : this.errorViewResolvers) {
  4. //调用错误视图解析器的 resolveErrorView 解析到错误视图页面
  5. ModelAndView modelAndView = resolver.resolveErrorView(request, status, model);
  6. if (modelAndView != null) {
  7. return modelAndView;
  8. }
  9. }
  10. return null;
  11. }

从上述源码可以看出,在响应页面的时候,会在父类的 resolveErrorView 方法中获取容器中所有的 ErrorViewResolver 对象(错误视图解析器,包括 DefaultErrorViewResolver 在内),一起来解析异常信息。

3、DefaultErrorViewResolver

ErrorMvcAutoConfiguration 还向容器中注入了一个 默认的错误视图解析器组件 DefaultErrorViewResolver,代码如下。

  1. @Bean
  2. @ConditionalOnBean(DispatcherServlet.class)
  3. @ConditionalOnMissingBean(ErrorViewResolver.class)
  4. DefaultErrorViewResolver conventionErrorViewResolver() {
  5. return new DefaultErrorViewResolver(this.applicationContext, this.resources);
  6. }

当发出请求的客户端为浏览器时,Spring Boot 会获取容器中所有的 ErrorViewResolver 对象(错误视图解析器),并分别调用它们的 resolveErrorView() 方法对异常信息进行解析,其中自然也包括 DefaultErrorViewResolver(默认错误信息解析器)。

DefaultErrorViewResolver 的部分代码如下。

  1. public class DefaultErrorViewResolver implements ErrorViewResolver, Ordered {
  2. private static final Map<HttpStatus.Series, String> SERIES_VIEWS;
  3. static {
  4. Map<HttpStatus.Series, String> views = new EnumMap<>(HttpStatus.Series.class);
  5. views.put(Series.CLIENT_ERROR, "4xx");
  6. views.put(Series.SERVER_ERROR, "5xx");
  7. SERIES_VIEWS = Collections.unmodifiableMap(views);
  8. }
  9. ......
  10. @Override
  11. public ModelAndView resolveErrorView(HttpServletRequest request, HttpStatus status, Map<String, Object> model) {
  12. //尝试以错误状态码作为错误页面名进行解析
  13. ModelAndView modelAndView = resolve(String.valueOf(status.value()), model);
  14. if (modelAndView == null && SERIES_VIEWS.containsKey(status.series())) {
  15. //尝试以 4xx 或 5xx 作为错误页面页面进行解析
  16. modelAndView = resolve(SERIES_VIEWS.get(status.series()), model);
  17. }
  18. return modelAndView;
  19. }
  20. private ModelAndView resolve(String viewName, Map<String, Object> model) {
  21. //错误模板页面,例如 error/404、error/4xx、error/500、error/5xx
  22. String errorViewName = "error/" + viewName;
  23. //当模板引擎可以解析这些模板页面时,就用模板引擎解析
  24. TemplateAvailabilityProvider provider = this.templateAvailabilityProviders.getProvider(errorViewName,
  25. this.applicationContext);
  26. if (provider != null) {
  27. //在模板能够解析到模板页面的情况下,返回 errorViewName 指定的视图
  28. return new ModelAndView(errorViewName, model);
  29. }
  30. //若模板引擎不能解析,则去静态资源文件夹下查找 errorViewName 对应的页面
  31. return resolveResource(errorViewName, model);
  32. }
  33. private ModelAndView resolveResource(String viewName, Map<String, Object> model) {
  34. //遍历所有静态资源文件夹
  35. for (String location : this.resources.getStaticLocations()) {
  36. try {
  37. Resource resource = this.applicationContext.getResource(location);
  38. //静态资源文件夹下的错误页面,例如error/404.html、error/4xx.html、error/500.html、error/5xx.html
  39. resource = resource.createRelative(viewName + ".html");
  40. //若静态资源文件夹下存在以上错误页面,则直接返回
  41. if (resource.exists()) {
  42. return new ModelAndView(new DefaultErrorViewResolver.HtmlResourceView(resource), model);
  43. }
  44. } catch (Exception ex) {
  45. }
  46. }
  47. return null;
  48. }
  49. ......
  50. }

DefaultErrorViewResolver 解析异常信息的步骤如下:

  1. 根据错误状态码(例如 404、500、400 等),生成一个错误视图 error/status,例如 error/404、error/500、error/400。
  2. 尝试使用模板引擎解析 error/status 视图,即尝试从 classpath 类路径下的 templates 目录下,查找 error/status.html,例如 error/404.html、error/500.html、error/400.html。
  3. 若模板引擎能够解析到 error/status 视图,则将视图和数据封装成 ModelAndView 返回并结束整个解析流程,否则跳转到第 4 步。
  4. 依次从各个静态资源文件夹中查找 error/status.html,若在静态文件夹中找到了该错误页面,则返回并结束整个解析流程,否则跳转到第 5 步。
  5. 将错误状态码(例如 404、500、400 等)转换为 4xx 或 5xx,然后重复前 4 个步骤,若解析成功则返回并结束整个解析流程,否则跳转第 6 步。
  6. 处理默认的 “/error ”请求,使用 Spring Boot 默认的错误页面(Whitelabel Error Page)。

4、DefaultErrorAttributes

ErrorMvcAutoConfiguration 还向容器中注入了一个组件 默认错误属性处理工具 DefaultErrorAttributes,代码如下。

  1. @Bean
  2. @ConditionalOnMissingBean(value = ErrorAttributes.class, search = SearchStrategy.CURRENT)
  3. public DefaultErrorAttributes errorAttributes() {
  4. return new DefaultErrorAttributes();
  5. }

DefaultErrorAttributes 是 Spring Boot 的默认错误属性处理工具,它可以从请求中获取异常或错误信息,并将其封装为一个 Map 对象返回,其部分代码如下。

  1. public class DefaultErrorAttributes implements ErrorAttributes, HandlerExceptionResolver, Ordered {
  2. ......
  3. @Override
  4. public Map<String, Object> getErrorAttributes(WebRequest webRequest, ErrorAttributeOptions options) {
  5. Map<String, Object> errorAttributes = getErrorAttributes(webRequest, options.isIncluded(Include.STACK_TRACE));
  6. if (!options.isIncluded(Include.EXCEPTION)) {
  7. errorAttributes.remove("exception");
  8. }
  9. if (!options.isIncluded(Include.STACK_TRACE)) {
  10. errorAttributes.remove("trace");
  11. }
  12. if (!options.isIncluded(Include.MESSAGE) && errorAttributes.get("message") != null) {
  13. errorAttributes.remove("message");
  14. }
  15. if (!options.isIncluded(Include.BINDING_ERRORS)) {
  16. errorAttributes.remove("errors");
  17. }
  18. return errorAttributes;
  19. }
  20. private Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
  21. Map<String, Object> errorAttributes = new LinkedHashMap<>();
  22. errorAttributes.put("timestamp", new Date());
  23. addStatus(errorAttributes, webRequest);
  24. addErrorDetails(errorAttributes, webRequest, includeStackTrace);
  25. addPath(errorAttributes, webRequest);
  26. return errorAttributes;
  27. }
  28. ......
  29. }

在 Spring Boot 默认的 Error 控制器(BasicErrorController)处理错误时,会调用 DefaultErrorAttributes 的 getErrorAttributes() 方法获取错误或异常信息,并封装成 model 数据(Map 对象),返回到页面或 JSON 数据中。该 model 数据主要包含以下属性:

  • timestamp:时间戳;
  • status:错误状态码
  • error:错误的提示
  • exception:导致请求处理失败的异常对象
  • message:错误/异常消息
  • trace: 错误/异常栈信息
  • path:错误/异常抛出时所请求的URL路径**
    所有通过 DefaultErrorAttributes 封装到 model 数据中的属性,都可以直接在页面或 JSON 中获取。
声明:本文内容转载自脚本之家,由网友自发贡献,版权归原作者所有,如您发现涉嫌抄袭侵权,请联系admin@php.cn 核实处理。
全部评论
文明上网理性发言,请遵守新闻评论服务协议