本文主要是介绍Spring Boot 中的默认异常处理机制及执行流程,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
《SpringBoot中的默认异常处理机制及执行流程》SpringBoot内置BasicErrorController,自动处理异常并生成HTML/JSON响应,支持自定义错误路径、配置及扩展,如...
Spring Boot 异常处理机制详解
Spring Boot 提供了一套完善的默认异常处理机制,通过内置的 BasicErrorController 自动处理应用中的各类异常情况。这套机制基于 Spring MVC 的异常处理框架构建,具有以下特点:
多格式响应支持:
默认错误路径:
- 提供了/error映射路径作为统一的错误处理入口
- 可以通过实现ErrorController接口来自定义错误处理逻辑
错误页面配置:
内置异常转换:
- 自动将常见异常转换为合适的HTTP状态码
- 例如:MethodArgumentNotValidException -> 400 Bad Request
- 例如:NoHandlerFoundException -> 404 Not Found
配置选项:
- 通过server.error.*配置项可以自定义错误处理行为
- 例如:server.error.include-message=always(控制错误信息是否包含详细异常信息)
实际应用示例:
// 自定义错误页 @Controller public编程 class MyErrorController implements ErrorController { @RequestMapping("/error") public String handleError(HttpServletRequest request) { Object status = request.getAttribute("Javax.servlet.error.status_code"); if (status != null) { Integer statusCode = Integer.valueOf(status.toString()); if(statusCode == 404) { return "error/404"; } else if(statusCode == 500) { return "error/500"; } } return "error/generic"; } }
这套机制既适用于传统Web应用的页面错误展示,也适配RESTful API的JSON错误响应,为开发者提供了开箱即用的异常处理解决方案。
默认错误页面功能
当应用出现异常时,Spring Boot 会自动展示一个"Whitelabel Error Page"(白色标签错误页),这个页面包含以下关键信息:
- HTTP状态码(如404、500等)
- 错误发生的时间戳(精确到毫秒)
- 具体的错误信息(异常消息)
- 请求的URL路径
- 错误跟踪ID(便于日志关联)
例如:
自动异常转换机制
Spring Boot 会自动将常见的异常类型转换为合适的HTTP状态码:
404 Not Found
- 触发条件:
NoHandlerFoundException
- 使用场景:当请求的URL没有对应的控制器方法时
- 示例:访问
/api/non-existent-endpoint
- 触发条件:
400 Bad Request
- 触发条件:
MethodArgumentNotValidException
(方法参数验证失败) - 使用场景:表单验证失败、REST API参数校验不通过
- 示例:提交的JSON数据缺少必填字段
- 触发条件:
500 Internal Server Error
- 触发条件:其他所有未捕获的异常
- 使用场景:业务逻辑中的运行时异常
- 示例:数据库连接失败、空指针异常
错误属性配置选项
开发者可以通过 application.properties
或 application.yml
文件自定义错误处理行为:
# 控制错误信息中是否包含异常消息 server.error.include-message=always # 可选值:always, on_param, never # 控制是否包含堆栈跟踪信息 server.error.include-stacktrace=on_param # 可选值:always, on_param, never # 自定义错误处理路径(默认为/error) server.error.path=/custom-error # 是否包含错误详情(绑定异常的具体字段错误) server.error.include-binding-errors=always
默认错误处理流程详解
异常触发阶段
- 当应用代码中抛出异常且未被捕获时
- 异常被Spring MVC的
DispatcherServlet
捕获
请求转发阶段
DispatcherServlet
将异常转发到配置的错误路径(默认是/error
)- 根据请求的
Accept
头决定响应格式(HTML或JSON)
错误处理阶段
BasicErrorController
处理该请求- 收集错误信息(状态码、错误消息、时间戳等)
- 对于浏览器请求(Accept包含text/html),返回HTML错误页
- 对于API请求(Ac编程cept包含application/json),返回JSON格式的错误信息
响应生成阶段 JSON响应示例:
{ "timestamp": "2023-05-15T08:12:34.567+00:00", "status": 404, "error": "Not Found", "path": "/api/non-existent" }
扩展机制
虽然Spring Boot提供了默认处理,但开发者可以通过以下方式扩展:
自定义ErrorController
- 实现
ErrorController
接口 - 重写
getErrorPath()
和error()
方法 - 示例:记录错误日志或发送告警通知
- 实现
全局异常处理器
- 使用
@ControllerAdvice
注解定义全局异常处理类 - 配合
@ExceptionHandler
处理特定异常 - 示例:
@ControllerAdvice public class GlobalExceptionHandler { @ExceptionHandler(value = {UserNotFoundException.class}) protected ResponseEntity<ErrorResponse> handleUserNotFound(UserNotFoundException ex) { ErrorResponse error = new ErrorResponse("USER_NOT_FOUND", ex.getMessage()); return new ResponseEntity<>(error, HttpStatus.NOT_FOUND); } }
- 使用
继承ResponseEntityExceptionHandler
- 继承Spring提供的基类进行更细粒度的控制
- 可以覆盖处理特定MVC异常的默认行为
- 示例:自定义验证错误的响应格式
这套机制使得开发者可以快速构建健壮的应用程序,同时保留足够的灵活性来定制错误处理逻辑,满足特定业务场景的需求。
到此这篇关于Spring Boot 中的默认异常处理机制的文章就介绍到这了,更多相关Spring Boot 默认异常处理内容请搜索China编程(www.chinasem.cn)以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程China编程(www.chinasem.cn)!
这篇关于Spring Boot 中的默认异常处理机制及执行流程的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!