Spring Boot 实现全局异常处理

在Spring Boot中,实现全局异常处理是一个常见的需求,它可以帮助我们集中处理应用中可能抛出的异常,并返回统一的响应格式给前端。这不仅可以减少代码重复,还能提高应用的可维护性和用户体验。

下面是一个简单的Spring Boot全局异常处理的实现步骤:

1. 创建自定义异常类(可选)

首先,你可以根据需要创建一些自定义异常类,以便在业务逻辑中抛出这些具体的异常。这样做的好处是可以让异常更加语义化,方便后续的处理和日志记录。

public class CustomException extends RuntimeException {  
    private static final long serialVersionUID = 1L;  
  
    private String errorCode;  
  
    public CustomException(String message, String errorCode) {  
        super(message);  
        this.errorCode = errorCode;  
    }  
  
    // Getter 和 Setter  
    public String getErrorCode() {  
        return errorCode;  
    }  
  
    public void setErrorCode(String errorCode) {  
        this.errorCode = errorCode;  
    }  
}

2. 创建全局异常处理器

接下来,创建一个全局异常处理器,通过@ControllerAdvice@RestControllerAdvice(如果你使用的是RESTful服务)注解来标注这个类,然后使用@ExceptionHandler注解来指定它要处理的异常类型。

@RestControllerAdvice  
public class GlobalExceptionHandler {  
  
    @ExceptionHandler(value = Exception.class)  
    public ResponseEntity<Object> handleAllExceptions(Exception e) {  
        // 这里可以根据具体的异常类型进行更细致的处理  
        // 例如,如果捕获到CustomException,则可以返回更具体的错误码和信息  
  
        // 简单的示例:返回状态码500和异常信息  
        ApiError apiError = new ApiError(HttpStatus.INTERNAL_SERVER_ERROR.value(), "Internal Server Error");  
        return new ResponseEntity<>(apiError, HttpStatus.INTERNAL_SERVER_ERROR);  
    }  
  
    @ExceptionHandler(value = CustomException.class)  
    public ResponseEntity<Object> handleCustomException(CustomException e) {  
        ApiError apiError = new ApiError(e.getErrorCode(), e.getMessage());  
        return new ResponseEntity<>(apiError, HttpStatus.valueOf(e.getErrorCode().startsWith("4") ? Integer.parseInt(e.getErrorCode().substring(0, 3)) : HttpStatus.INTERNAL_SERVER_ERROR.value()));  
    }  
  
    // ApiError 是一个简单的POJO类,用于封装错误信息  
    private static class ApiError {  
        private int status;  
        private String message;  
  
        public ApiError(int status, String message) {  
            this.status = status;  
            this.message = message;  
        }  
  
        // Getter 和 Setter  
    }  
}

注意:ApiError是一个简单的POJO类,用于封装错误信息,你可以根据实际需求调整它的结构。

3. 测试全局异常处理

现在,你可以在应用的任何地方抛出异常,并查看全局异常处理器是否正确地捕获并处理了这些异常。

4. 注意事项

  • 确保你的全局异常处理器类被Spring Boot扫描到,通常这意味着它应该位于Spring Boot的主类或启动类所在的包或子包中。
  • 根据你的应用需求,你可能需要为不同类型的异常编写多个@ExceptionHandler方法。
  • 考虑将异常信息记录到日志中,以便在问题发生时进行追踪和调试。
  • 如果你的应用是RESTful服务,并且你希望为前端返回统一的响应格式,那么使用@RestControllerAdviceResponseEntity是一个很好的选择。
相关推荐
技术无疆33 分钟前
快速开发与维护:探索 AndroidAnnotations
android·java·android studio·android-studio·androidx·代码注入
罗政3 小时前
[附源码]超简洁个人博客网站搭建+SpringBoot+Vue前后端分离
vue.js·spring boot·后端
架构文摘JGWZ4 小时前
Java 23 的12 个新特性!!
java·开发语言·学习
拾光师4 小时前
spring获取当前request
java·后端·spring
aPurpleBerry4 小时前
neo4j安装启动教程+对应的jdk配置
java·neo4j
我是苏苏5 小时前
Web开发:ABP框架2——入门级别的增删改查Demo
java·开发语言
xujinwei_gingko5 小时前
Spring IOC容器Bean对象管理-Java Config方式
java·spring
2301_789985945 小时前
Java语言程序设计基础篇_编程练习题*18.29(某个目录下的文件数目)
java·开发语言·学习
IT学长编程5 小时前
计算机毕业设计 教师科研信息管理系统的设计与实现 Java实战项目 附源码+文档+视频讲解
java·毕业设计·springboot·毕业论文·计算机毕业设计选题·计算机毕业设计开题报告·教师科研管理系统
m0_571957585 小时前
Java | Leetcode Java题解之第406题根据身高重建队列
java·leetcode·题解