Spring Boot中的全局异常处理机制详解
ztj100 2024-12-15 18:01 28 浏览 0 评论
在Web开发中,能够有一个统一的异常处理机制会为整个的Web应用程序的稳定性和用户体验带来很大的帮助。而在Spring Boot中也提供了非常强大的异常处理机制们可以优雅的实现对于异常的捕获了处理,在提升代码维护性的同时也可以很好的提升用户体验。下面我们就来详细的介绍一下Spring Boot中的全局异常处理机制。
为什么需要全局异常处理?
在开发过程中,可能会遇到各种的需要进行异常处理的场景,而在整个的Web项目中包含了很多的模块,如果每个模块都进行单独的异常处理,那么就会导致代码的冗余,并且代码将会变的非常难维护。而全局异常处理机制就可以提供一整套完整的全局异常处理逻辑,可以减少代码冗余,提供统一的异常响应处理,也可以让开发者更好的统计异常快速定位问题。
Spring Boot 中的异常处理方式
在SpringBoot中提供了很多的异常处理方式,如下所示。
使用@ExceptionHandler注解
@ExceptionHandler注解主要是用来对特定异常进行处理,与@Controller或@RestController注解一起使用来处理各种控制器异常捕获,如下所示。
@RestController
public class DemoController {
@GetMapping("/test")
public String test() {
throw new IllegalArgumentException("非法参数异常");
}
@ExceptionHandler(IllegalArgumentException.class)
public ResponseEntity<String> handleIllegalArgumentException(IllegalArgumentException ex) {
return new ResponseEntity<>("错误信息: " + ex.getMessage(), HttpStatus.BAD_REQUEST);
}
}
通过简单的方式来处理控制器内的异常,但是没有办法对全局的异常进行捕获。
使用@ControllerAdvice和@RestControllerAdvice
@ControllerAdvice是在Spring中所提供的用来进行全局异常处理的注解,专门用于捕获@Controller层的异常。如果是是RESTful风格的接口(JSON 响应)的异常,则可以通过@RestControllerAdvice注解实现。如下所示。
@RestControllerAdvice
public class GlobalExceptionHandler {
// 捕获特定异常
@ExceptionHandler(IllegalArgumentException.class)
public ResponseEntity<String> handleIllegalArgumentException(IllegalArgumentException ex) {
return new ResponseEntity<>("非法参数: " + ex.getMessage(), HttpStatus.BAD_REQUEST);
}
// 捕获所有异常
@ExceptionHandler(Exception.class)
public ResponseEntity<String> handleException(Exception ex) {
return new ResponseEntity<>("服务器内部错误: " + ex.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
}
}
用于统一处理所有控制器中的异常,可以针对不同的异常返回不同的响应结果,但是需要手动配置各种异常处理器方法,比较麻烦。
使用ResponseEntityExceptionHandler
ResponseEntityExceptionHandler也是在Spring框架中提供的异常处理基类,默认实现了对很多常见异常,例如HttpRequestMethodNotSupportedException等的处理。我们可以通过继承这个类并重写其方法,来实现自定义异常处理逻辑,如下所示。
@RestControllerAdvice
public class CustomExceptionHandler extends ResponseEntityExceptionHandler {
@Override
protected ResponseEntity<Object> handleMethodArgumentNotValid(MethodArgumentNotValidException ex,
HttpHeaders headers,
HttpStatus status,
WebRequest request) {
String errorMessage = ex.getBindingResult().getAllErrors().get(0).getDefaultMessage();
return new ResponseEntity<>("参数验证失败: " + errorMessage, HttpStatus.BAD_REQUEST);
}
}
可以直接复用Spring默认的异常处理逻辑,所以比较适合处理一些验证类的异常处理,但是这个异常处理只适用于Spring中定义的异常。
自定义异常和统一响应格式
为了让异常响应更具结构化和可读性,我们可以通过定义一个统一的错误响应类,以及自定义异常类来对异常处理进行封装,如下所示。
统一响应类
public class ErrorResponse {
private int code;
private String message;
private LocalDateTime timestamp;
// 构造方法、Getter和Setter
public ErrorResponse(int code, String message) {
this.code = code;
this.message = message;
this.timestamp = LocalDateTime.now();
}
}
自定义异常类
public class BusinessException extends RuntimeException {
private int code;
public BusinessException(int code, String message) {
super(message);
this.code = code;
}
public int getCode() {
return code;
}
}
全局处理逻辑
@RestControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(BusinessException.class)
public ResponseEntity<ErrorResponse> handleBusinessException(BusinessException ex) {
ErrorResponse errorResponse = new ErrorResponse(ex.getCode(), ex.getMessage());
return new ResponseEntity<>(errorResponse, HttpStatus.BAD_REQUEST);
}
@ExceptionHandler(Exception.class)
public ResponseEntity<ErrorResponse> handleGenericException(Exception ex) {
ErrorResponse errorResponse = new ErrorResponse(500, "服务器内部错误");
return new ResponseEntity<>(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
}
}
总结
在Spring Boot中提供了很多的全局异常处理机制,其中@ExceptionHandler 适合局部处理。@ControllerAdvice或@RestControllerAdvice则是比较适合全局异常管理,通过结合ResponseEntityExceptionHandler和自定义异常我们可以满足更多样化的需求。通过这些技术综合实现,我们可以构建出一套高效健壮的异常处理体系,来提升系统的稳定性和用户体验。
相关推荐
- sharding-jdbc实现`分库分表`与`读写分离`
-
一、前言本文将基于以下环境整合...
- 三分钟了解mysql中主键、外键、非空、唯一、默认约束是什么
-
在数据库中,数据表是数据库中最重要、最基本的操作对象,是数据存储的基本单位。数据表被定义为列的集合,数据在表中是按照行和列的格式来存储的。每一行代表一条唯一的记录,每一列代表记录中的一个域。...
- MySQL8行级锁_mysql如何加行级锁
-
MySQL8行级锁版本:8.0.34基本概念...
- mysql使用小技巧_mysql使用入门
-
1、MySQL中有许多很实用的函数,好好利用它们可以省去很多时间:group_concat()将取到的值用逗号连接,可以这么用:selectgroup_concat(distinctid)fr...
- MySQL/MariaDB中如何支持全部的Unicode?
-
永远不要在MySQL中使用utf8,并且始终使用utf8mb4。utf8mb4介绍MySQL/MariaDB中,utf8字符集并不是对Unicode的真正实现,即不是真正的UTF-8编码,因...
- 聊聊 MySQL Server 可执行注释,你懂了吗?
-
前言MySQLServer当前支持如下3种注释风格:...
- MySQL系列-源码编译安装(v5.7.34)
-
一、系统环境要求...
- MySQL的锁就锁住我啦!与腾讯大佬的技术交谈,是我小看它了
-
对酒当歌,人生几何!朝朝暮暮,唯有己脱。苦苦寻觅找工作之间,殊不知今日之事乃我心之痛,难道是我不配拥有工作嘛。自面试后他所谓的等待都过去一段时日,可惜在下京东上的小金库都要见低啦。每每想到不由心中一...
- MySQL字符问题_mysql中字符串的位置
-
中文写入乱码问题:我输入的中文编码是urf8的,建的库是urf8的,但是插入mysql总是乱码,一堆"???????????????????????"我用的是ibatis,终于找到原因了,我是这么解决...
- 深圳尚学堂:mysql基本sql语句大全(三)
-
数据开发-经典1.按姓氏笔画排序:Select*FromTableNameOrderByCustomerNameCollateChinese_PRC_Stroke_ci_as//从少...
- MySQL进行行级锁的?一会next-key锁,一会间隙锁,一会记录锁?
-
大家好,是不是很多人都对MySQL加行级锁的规则搞的迷迷糊糊,一会是next-key锁,一会是间隙锁,一会又是记录锁。坦白说,确实还挺复杂的,但是好在我找点了点规律,也知道如何如何用命令分析加...
- 一文讲清怎么利用Python Django实现Excel数据表的导入导出功能
-
摘要:Python作为一门简单易学且功能强大的编程语言,广受程序员、数据分析师和AI工程师的青睐。本文系统讲解了如何使用Python的Django框架结合openpyxl库实现Excel...
- 用DataX实现两个MySQL实例间的数据同步
-
DataXDataX使用Java实现。如果可以实现数据库实例之间准实时的...
- MySQL数据库知识_mysql数据库基础知识
-
MySQL是一种关系型数据库管理系统;那废话不多说,直接上自己以前学习整理文档:查看数据库命令:(1).查看存储过程状态:showprocedurestatus;(2).显示系统变量:show...
- 如何为MySQL中的JSON字段设置索引
-
背景MySQL在2015年中发布的5.7.8版本中首次引入了JSON数据类型。自此,它成了一种逃离严格列定义的方式,可以存储各种形状和大小的JSON文档,例如审计日志、配置信息、第三方数据包、用户自定...
你 发表评论:
欢迎- 一周热门
-
-
MySQL中这14个小玩意,让人眼前一亮!
-
旗舰机新标杆 OPPO Find X2系列正式发布 售价5499元起
-
【VueTorrent】一款吊炸天的qBittorrent主题,人人都可用
-
面试官:使用int类型做加减操作,是线程安全吗
-
C++编程知识:ToString()字符串转换你用正确了吗?
-
【Spring Boot】WebSocket 的 6 种集成方式
-
PyTorch 深度学习实战(26):多目标强化学习Multi-Objective RL
-
pytorch中的 scatter_()函数使用和详解
-
与 Java 17 相比,Java 21 究竟有多快?
-
基于TensorRT_LLM的大模型推理加速与OpenAI兼容服务优化
-
- 最近发表
- 标签列表
-
- idea eval reset (50)
- vue dispatch (70)
- update canceled (42)
- order by asc (53)
- spring gateway (67)
- 简单代码编程 贪吃蛇 (40)
- transforms.resize (33)
- redisson trylock (35)
- 卸载node (35)
- np.reshape (33)
- torch.arange (34)
- npm 源 (35)
- vue3 deep (35)
- win10 ssh (35)
- vue foreach (34)
- idea设置编码为utf8 (35)
- vue 数组添加元素 (34)
- std find (34)
- tablefield注解用途 (35)
- python str转json (34)
- java websocket客户端 (34)
- tensor.view (34)
- java jackson (34)
- vmware17pro最新密钥 (34)
- mysql单表最大数据量 (35)