如果我们的项目发生了错误,SpringBoot会使用其错误处理机制来处理我们的错误,返回相对应的结果。如果我们相对其进行自定义修改,那么就要了解SpringBoot的错误处理机制流程,下面就对其进行介绍。
1. 错误处理机制流程
SpringBoot错误处理的自动配置都在ErrorMvcAutoConfiguration
中,错误处理机制有以下特点:
- SpringBoot 会自适应处理错误,响应页面或JSON数据
- SpringMVC的错误处理机制依然保留,MVC处理不了,才会交给boot进行处理
流程如下:
- 当我们的项目业务中出现错误,首先会使用SpringMVC的错误处理机制
HandlerExceptionResolver
- 先看
@ExceptionHandler
是否可以处理,如果能处理,那就直接进行处理并返回处理结果 - 如果处理不了,再看
@ResponseStatus
是否可以进行处理,如果能处理,直接进行处理并返回处理结果 - 如果上述两者都无法处理,那就看SpringMVC的默认错误响应机制能否处理,如果能处理,直接进行处理并返回处理结果
- 先看
- 如果SpringMVC的错误处理机制均无法处理,那就由SpringBoot进行接手
- SpringBoot会进行内容协商,如果响应JSON数据,可以直接获取错误信息并返回结果
- 如果需要响应错误页面,那么会按照以下顺序进行处理
- 根据精确的错误码查找是否存在相对应的页面,查找顺序如下:
- 先查找
classpath:/templates/error/
文件夹下是否存在 - 如果不存在,再在静态资源下查找
- 先查找
- 如果根据精确错误码没有找到相对应的页面,那就进行模糊查找
- 先查找
classpath:/templates/error/
文件夹下是否存在 - 如果不存在,再在静态资源下查找
- 先查找
- 根据精确的错误码查找是否存在相对应的页面,查找顺序如下:
- 如果精确和模糊匹配都没有找到相对应的错误页面,那就匹配名字是
error
的视图页面 error
页面也没有找到,那就匹配SpringBoot 提供的默认名为error
的视图页面- 无论在哪一步找到匹配的页面,都会进行错误处理,响应处理结果
举例说明
假如我们目前出现了404的错误码,且SpringMVC的错误处理机制无法处理,那么SpringBoot会进行以下操作
- 在
classpath:/templates/error/
文件夹下查找是否存在404.html,若找到,直接处理错误,响应页面 - 在静态资源文件夹下找404.html,若找到,直接处理错误,响应页面
- 在
classpath:/templates/error/
文件夹下查找是否存在4xx.html,若找到,直接处理错误,响应页面 - 静态资源文件夹下找4xx.html,若找到,直接处理错误,响应页面
- 在
classpath:/templates/
文件夹下查找是否存在error.html,若找到,直接处理错误,响应页面 - 使用SpringBoot 提供的默认名为
error
的视图页面,并响应结果
自定义错误响应
基于上述流程,如果我们想要自定义错误处理的响应,那么可以按照以下方法:
- 前后端分离,需要响应JSON格式
- 使用
@ControllerAdvice
+@ExceptionHandler
进行统一异常处理
- 使用
- 服务端页面渲染
- 不可预知的,HTTP码表示的服务器或客户端错误
- 在
classpath:/templates/error/
下面,放常用精确的错误码页面。例如:500.html,404.html - 在
classpath:/templates/error/
下面,放通用模糊匹配的错误码页面。 例如:5xx.html,4xx.html
- 在
- 发生业务错误
- 核心业务:通过代码处理错误,跳转到自己定制的错误页。
- 通用业务:classpath:/templates/error.html页面,显示错误信息。
- 不可预知的,HTTP码表示的服务器或客户端错误