SpringBoot实现全局异常的封装和统一处理

 更新时间:2023年12月12日 08:10:31   作者:程序员无名  
在Spring Boot应用中,全局异常的处理是一个非常重要的方面,本文主要为大家详细介绍了如何在Spring Boot中进行全局异常的封装和统一处理,需要的可以参考下

前言

在Spring Boot应用中,全局异常的处理是一个非常重要的方面,它可以提高系统的稳定性和用户体验。在这篇博客中,我们将介绍如何在Spring Boot中进行全局异常的封装和统一处理。

全局异常处理能够捕获应用中所有未处理的异常,统一进行处理,防止异常信息泄露到客户端,同时也能够记录异常信息以便后续的调试和分析。

接下来就用SpringBoot实例代码实现一个简单的全局异常拦截。

创建全局异常类

首先,我们需要创建一个自定义的全局异常类,继承自RuntimeException,用于封装业务异常信息。

/**
可直接进行throw该异常类进行返回信息
**/
public class CustomException extends RuntimeException {
    //错误码枚举
    private final ErrorCode errorCode;

    public CustomException(ErrorCode errorCode) {
        super(errorCode.getMessage());
        this.errorCode = errorCode;
    }

    public ErrorCode getErrorCode() {
        return errorCode;
    }
}

创建错误码枚举

为了更好地封装异常信息,我们创建一个错误码的枚举类,用于定义异常码和异常信息。

public enum ErrorCode {
    SUCCESS("10000", "success"),
    SYSTEM_ERROR("500", "系统系统,请联系管理员"),
    NOT_FOUNT("404","未找到对应的资源");

    // 其他错误码...

    private final String code;
    private final String message;

    ErrorCode(String code, String message) {
        this.code = code;
        this.message = message;
    }

    public String getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }
}

创建全局异常处理器

然后,我们创建一个全局异常处理器,使用@ControllerAdvice注解,配合@ExceptionHandler注解处理各种异常。

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(CustomException.class)
    public ResponseEntity<Response> handleCustomException(CustomException ex) {
        ErrorCode errorCode = ex.getErrorCode();
        return new ResponseEntity<>(Response.error(errorCode.getCode(), errorCode.getMessage()), HttpStatus.INTERNAL_SERVER_ERROR);
    }

    @ExceptionHandler(Exception.class)
    public ResponseEntity<Response> handleOtherExceptions(Exception ex) {
        return new ResponseEntity<>(Response.error(), HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

创建错误响应类

最后,我们创建一个错误响应类,用于返回统一的错误格式。

@Data
public class Response<T> {
    private  String code;
    private  String message;
    private T data;
    //默认的返回成功
    public static Response success(){
        Response response  =new Response();
        response.setCode(ErrorCode.SUCCESS.getCode());
        response.setMessage(ErrorCode.SUCCESS.getMessage());
        return response;
    }
    //带内容的返回成功
    public static <T> Response success(T data){
        Response<T> response  =new Response<T>();
        response.setCode(ErrorCode.SUCCESS.getCode());
        response.setData(data);
        response.setMessage(ErrorCode.SUCCESS.getMessage());
        return response;
    }
    //默认的返回失败
    public static Response error(){
        Response response  =new Response();
        response.setCode(ErrorCode.SYSTEM_ERROR.getCode());
        response.setMessage(ErrorCode.SYSTEM_ERROR.getMessage());
        return response;
    }
    //自定义的返回失败
    public static Response error(String code,String msg){
        Response response  =new Response();
        response.setCode(code);
        response.setMessage(msg);
        return response;
    }
}

测试

现在,我们可以在业务代码中通过抛出CustomException来触发全局异常处理,例如:

@RestController
@RequestMapping("/api/test")
public class TestConroller {
    @GetMapping("/success")
    public ResponseEntity<Response> successObj(){
        return ResponseEntity.ok(Response.success("111111"));
    }
    @GetMapping("/error")
    public ResponseEntity<Response> error(String name) {
    //传入的name等于张三时,抛出我们的异常处理。
        if(StringUtils.equals(name,"zhangsan")){
            throw new CustomException(ErrorCode.SYSTEM_ERROR);
        }
        return ResponseEntity.ok(Response.success());
    }
}    

访问:/api/test/success 返回:

{
"code": "10000",
"message": "success",
"data": "111111"
}

访问:/api/test/error?name=zhangsan 返回:

{
"code": "500",
"message": "系统系统,请联系管理员",
"data": null
}

通过以上步骤,我们成功地封装了全局异常并进行了统一处理。这种方式不仅提高了代码的可维护性,还使得异常信息的格式更加一致,方便客户端或其他系统进行处理。全局异常处理是一个非常值得关注的话题,尤其是在构建健壮的后端应用时。

到此这篇关于SpringBoot实现全局异常的封装和统一处理的文章就介绍到这了,更多相关SpringBoot全局异常内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Gradle修改本地仓库的位置方法实现

    Gradle修改本地仓库的位置方法实现

    这篇文章主要介绍了Gradle修改本地仓库的位置方法实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-07-07
  • 使用BufferedReader读取TXT文件中数值,并输出最大值

    使用BufferedReader读取TXT文件中数值,并输出最大值

    这篇文章主要介绍了使用BufferedReader读取TXT文件中数值,并输出最大值,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-12-12
  • SpringBoot框架aop切面的execution表达式解读

    SpringBoot框架aop切面的execution表达式解读

    这篇文章主要介绍了SpringBoot框架aop切面的execution表达式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-05-05
  • Java面向对象之final关键字详细解读

    Java面向对象之final关键字详细解读

    这篇文章主要介绍了Java面向对象之final关键字详细解读,final修饰的属性又叫常量,一般用 XX_XX_XX来命名,final修饰的属性在定义时必须赋初始值,并且以后不能再修改,需要的朋友可以参考下
    2024-01-01
  • Java中的jinfo命令使用详解

    Java中的jinfo命令使用详解

    jinfo是JDK提供的一个可以实时查看Java虚拟机各种配置参数和系统属性的命令行工具,本文给大家介绍下Java中的jinfo命令使用,感兴趣的朋友一起看看吧
    2022-03-03
  • Java CAS基本实现原理代码实例解析

    Java CAS基本实现原理代码实例解析

    这篇文章主要介绍了Java CAS基本实现原理代码实例解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-07-07
  • SpringSecurity中的UserDetails和UserDetailsService接口详解

    SpringSecurity中的UserDetails和UserDetailsService接口详解

    这篇文章主要介绍了SpringSecurity中的UserDetails和UserDetailsService接口详解,UserDetailsService 在 Spring Security 中主要承担查询系统内用户、验证密码、封装用户信息和角色权限,需要的朋友可以参考下
    2023-11-11
  • springboot dynamic多数据源demo以及常见切换、事务的问题

    springboot dynamic多数据源demo以及常见切换、事务的问题

    这篇文章主要介绍了springboot dynamic多数据源demo以及常见切换、事务的问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-07-07
  • Spring Boot 实现敏感词及特殊字符过滤处理

    Spring Boot 实现敏感词及特殊字符过滤处理

    这篇文章主要介绍了SpringBoot实现敏感词及特殊字符过滤处理方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-06-06
  • Spring中的aware接口详情

    Spring中的aware接口详情

    这篇文章主要介绍了Spring中的aware接口详情,Spring中有很多继承于aware中的接口,这些接口到底是做什么用到的,下面我们就一起来看看吧,文章详细内容需要的小伙伴可以参考一下
    2022-05-05

最新评论