SpringBoot异常处理_springboot异常注解
liuian 2025-09-18 22:49 19 浏览
在 Spring Boot 中,异常处理是构建健壮、可维护 Web 应用的关键部分。良好的异常处理机制可以统一返回格式、提升用户体验、便于调试和监控。
以下是 Spring Boot 中处理异常的完整指南和最佳实践:
一、核心注解
1. @ControllerAdvice
- 全局控制器增强,用于定义全局异常处理器。
- 可以作用于所有 @Controller 或 @RestController。
2. @ExceptionHandler
- 定义具体的异常处理方法。
- 可以在控制器内部使用(局部),也可以配合 @ControllerAdvice 使用(全局)。
二、全局异常处理(推荐方式)
示例:创建全局异常处理器
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.servlet.NoHandlerFoundException;
@ControllerAdvice
public class GlobalExceptionHandler {
// 处理自定义业务异常
@ExceptionHandler(BusinessException.class)
public ResponseEntity<ErrorResponse> handleBusinessException(BusinessException e) {
ErrorResponse error = new ErrorResponse(
"BUSINESS_ERROR",
e.getMessage(),
System.currentTimeMillis()
);
return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(error);
}
// 处理参数校验异常(如 @Valid)
@ExceptionHandler(MethodArgumentNotValidException.class)
public ResponseEntity<ErrorResponse> handleValidationException(MethodArgumentNotValidException e) {
String message = e.getBindingResult().getFieldError().getDefaultMessage();
ErrorResponse error = new ErrorResponse(
"VALIDATION_ERROR",
message,
System.currentTimeMillis()
);
return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(error);
}
// 处理资源未找到(404)
@ExceptionHandler(NoHandlerFoundException.class)
public ResponseEntity<ErrorResponse> handleNotFoundException(NoHandlerFoundException e) {
ErrorResponse error = new ErrorResponse(
"NOT_FOUND",
"The requested resource was not found: " + e.getRequestURL(),
System.currentTimeMillis()
);
return ResponseEntity.status(HttpStatus.NOT_FOUND).body(error);
}
// 处理空指针等系统异常
@ExceptionHandler(NullPointerException.class)
public ResponseEntity<ErrorResponse> handleNullPointerException(NullPointerException e) {
ErrorResponse error = new ErrorResponse(
"SYSTEM_ERROR",
"A system error occurred.",
System.currentTimeMillis()
);
// 记录详细日志
// log.error("NullPointerException", e);
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(error);
}
// 处理所有未被捕获的异常(兜底)
@ExceptionHandler(Exception.class)
public ResponseEntity<ErrorResponse> handleGeneralException(Exception e) {
ErrorResponse error = new ErrorResponse(
"INTERNAL_ERROR",
"An unexpected error occurred.",
System.currentTimeMillis()
);
// 记录完整异常堆栈
// log.error("Unhandled exception", e);
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(error);
}
}定义统一的错误响应体
public class ErrorResponse {
private String code;
private String message;
private long timestamp;
public ErrorResponse(String code, String message, long timestamp) {
this.code = code;
this.message = message;
this.timestamp = timestamp;
}
// getter & setter
}三、自定义业务异常
public class BusinessException extends RuntimeException {
public BusinessException(String message) {
super(message);
}
public BusinessException(String message, Throwable cause) {
super(message, cause);
}
}在业务逻辑中抛出:
@Service
public class UserService {
public User getUser(Long id) {
if (id <= 0) {
throw new BusinessException("Invalid user ID: " + id);
}
// ...
}
}四、处理参数校验异常
1. 添加依赖(已包含在 web starter 中)
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>2. 在 DTO 上使用校验注解
public class CreateUserRequest {
@NotBlank(message = "Name is required")
private String name;
@Email(message = "Invalid email format")
private String email;
// getter & setter
}3. 在 Controller 中启用校验
@PostMapping("/users")
public ResponseEntity<User> createUser(@Valid @RequestBody CreateUserRequest request) {
// ...
}4. 全局处理 MethodArgumentNotValidException
如上文所示,在 GlobalExceptionHandler 中处理。
五、配置文件设置(可选)
# application.yml
spring:
# 启用精确的异常映射(可选)
web:
resources:
add-mappings: true
# 开发环境可开启详细错误信息(生产环境务必关闭!)
server:
error:
include-message: always
include-binding-errors: always
include-stacktrace: on_param生产环境警告:不要暴露堆栈信息给前端,防止信息泄露。
六、特殊异常处理
1. 处理 404(NoHandlerFound)
# application.yml
spring:
mvc:
throw-exception-if-no-handler-found: true # 未找到处理器时抛出异常
web:
resources:
add-mappings: false # 禁用默认静态资源映射(可选)然后在 @ControllerAdvice 中捕获 NoHandlerFoundException。
2. 处理 Spring Security 异常
@ExceptionHandler(AccessDeniedException.class)
public ResponseEntity<ErrorResponse> handleAccessDenied(AccessDeniedException e) {
return ResponseEntity.status(HttpStatus.FORBIDDEN).body(...);
}七、最佳实践
实践 | 说明 |
使用 @ControllerAdvice | 实现全局异常处理,避免重复代码 |
定义统一错误格式 | 前后端约定一致的错误结构 |
区分异常类型 | 业务异常、系统异常、校验异常分别处理 |
记录日志 | 特别是系统异常,便于排查问题 |
生产环境隐藏细节 | 不暴露堆栈、数据库错误等敏感信息 |
使用自定义异常 | 提高代码可读性和可维护性 |
返回合适的 HTTP 状态码 | 如 400、401、403、404、500 等 |
八、测试异常处理
@Test
public void shouldReturn400WhenInvalidInput() throws Exception {
mockMvc.perform(post("/api/users")
.contentType(MediaType.APPLICATION_JSON)
.content("{\"name\": \"\", \"email\": \"invalid\"}"))
.andExpect(status().isBadRequest())
.andExpect(jsonPath("$.code").value("VALIDATION_ERROR"));
}九、高级:自定义 ErrorController(可选)
如果需要完全控制错误页面或响应,可以实现 ErrorController 接口(Spring Boot 2.3+ 推荐使用 implements ErrorAttributes 或 @ControllerAdvice)。
总结
Spring Boot 的异常处理流程:
请求 → Controller → Service → 抛出异常
↓
@ExceptionHandler (局部或全局)
↓
统一返回 JSON 错误响应核心原则:
- 集中处理:使用 @ControllerAdvice 避免散落在各处的 try-catch。
- 类型化处理:不同异常返回不同状态码和提示。
- 用户友好:前端能根据 code 或 message 做相应处理。
- 安全可靠:不暴露系统内部细节。
相关推荐
- 搭建一个20人的办公网络(适用于20多人的小型办公网络环境)
-
楼主有5台机上网,则需要一个8口路由器,组网方法如下:设备:1、8口路由器一台,其中8口为LAN(局域网)端口,一个WAN(广域网)端口,价格100--400元2、网线N米,这个你自己会看了:)...
- 笔记本电脑各种参数介绍(笔记本电脑各项参数新手普及知识)
-
1、CPU:这个主要取决于频率和二级缓存,频率越高、二级缓存越大,速度越快,现在的CPU有三级缓存、四级缓存等,都影响相应速度。2、内存:内存的存取速度取决于接口、颗粒数量多少与储存大小,一般来说,内...
- 汉字上面带拼音输入法下载(字上面带拼音的输入法是哪个)
-
使用手机上的拼音输入法打成汉字的方法如下:1.打开手机上的拼音输入法,在输入框中输入汉字的拼音,例如“nihao”。2.根据输入法提示的候选词,选择正确的汉字。例如,如果输入“nihao”,输...
- xpsp3安装版系统下载(windowsxpsp3安装教程)
-
xpsp3纯净版在采用微软封装部署技术的基础上,结合作者的实际工作经验,融合了许多实用的功能。它通过一键分区、一键装系统、自动装驱动、一键设定分辨率,一键填IP,一键Ghost备份(恢复)等一系列...
- 没有备份的手机数据怎么恢复
-
手机没有备份恢复数据方法如下1、使用数据线将手机与电脑连接好,在“我的电脑”中可以看到手机的盘符。 2、将手机开启USB调试模式。在手机设置中找到开发者选项,然后点击“开启USB调试模式”。 3、...
- 电脑怎么激活windows11专业版
-
win11专业版激活方法有多种,以下提供两种常用的激活方式:方法一:使用激活密钥激活。在win11桌面上右键点击“此电脑”,选择“属性”选项。进入属性页面后,点击“更改产品密钥或升级windows”。...
- 华为手机助手下载官网(华为手机助手app下载专区)
-
华为手机助手策略调整,已不支持从应用市场下载手机助手,目前华为手机助手是需要在电脑上下载或更新手机助手到最新版本,https://consumer.huawei.com/cn/support/his...
- 光纤线断了怎么接(宽带光纤线断了怎么接)
-
宽带光纤线断了可以重接,具体操作方法如下:1、光纤连接的时候要根据束管内,同色相连,同芯相连,按顺序进行连接,由大到小。一般有三种连接方法,分别是熔接、活动连接和机械连接。2、连接的时候要开剥光缆,抛...
- win7旗舰版和专业版区别(win7旗舰版跟专业版)
-
1、功能区别:Win7旗舰版比专业版多了三个功能,分别是Bitlocker、BitlockerToGo和多语言界面; 2、用途区别:旗舰版的功能是所有版本中最全最强大的,占用的系统资源,...
- 万能连接钥匙(万能wifi连接钥匙下载)
-
1、首先打开wifi万能钥匙软件,若手机没有开启WLAN,就根据软件提示打开WLAN开关;2、打开WLAN开关后,会显示附近的WiFi,如果知道密码,可点击相应WiFi后点击‘输入密码’连接;3、若不...
- 雨林木风音乐叫什么(雨林木风是啥)
-
雨林木风的创始人是陈年鑫先生。陈年鑫先生于1999年创立了雨林木风公司,其初衷是为满足中国市场对高品质、高性能电脑的需求。在陈年鑫先生的领导下,雨林木风以技术创新、产品质量和客户服务为核心价值,不断推...
- aics6序列号永久序列号(aics6破解序列号)
-
关于AICS6这个版本,虽然是比较久远的版本,但是在功能上也是十分全面和强大的,作为一名平面设计师的话,AICS6的现有的功能已经能够应付几乎所有的设计工作了……到底AICC2019的功能是不是...
- 手机可以装电脑系统吗(手机可以装电脑系统吗怎么装)
-
答题公式1:手机可以通过数据线或无线连接的方式给电脑装系统。手机安装系统需要一定的技巧和软件支持,一般需要通过数据线或无线连接的方式与电脑连接,并下载相应的软件和系统文件进行安装。对于大部分手机用户来...
- 一周热门
- 最近发表
- 标签列表
-
- python判断字典是否为空 (50)
- crontab每周一执行 (48)
- aes和des区别 (43)
- bash脚本和shell脚本的区别 (35)
- canvas库 (33)
- dataframe筛选满足条件的行 (35)
- gitlab日志 (33)
- lua xpcall (36)
- blob转json (33)
- python判断是否在列表中 (34)
- python html转pdf (36)
- 安装指定版本npm (37)
- idea搜索jar包内容 (33)
- css鼠标悬停出现隐藏的文字 (34)
- linux nacos启动命令 (33)
- gitlab 日志 (36)
- adb pull (37)
- python判断元素在不在列表里 (34)
- python 字典删除元素 (34)
- vscode切换git分支 (35)
- python bytes转16进制 (35)
- grep前后几行 (34)
- hashmap转list (35)
- c++ 字符串查找 (35)
- mysql刷新权限 (34)
