• 深入理解Java自定义异常与全局异常处理 @RestControllerAdvice


            异常主要是包括编译时的异常运行时的异常。编译时的异常可以通过捕获异常获取,运行时候的异常主要是通过代码规范,或者测试

            Spring Boot提供了两种异常处理方式来统一处理和维护异常信息

            第一种方式是使用@RestControllerAdvice注解与@ExceptionHandler注解配合使用。第二种方式是ErrorController类,因为第一种方式主要是捕获在接口类的异常,如果需要自定义处理特定的HTTP错误代码(404,401),未进入控制器的和自定义错误页面,则需要使用ErrorController。

            一般来说,只使用@RestControllerAdvice+@ExceptionHandler就够了。

    • @ControllerAdvice:可以用来实现对Controller全局异常处理,与传统的基于AOP的方法不同,使用@ControllerAdvice可以捕获所有Controller中抛出的异常,而无需在每个Controller中配置@ExceptionHandler。通过在该类中使用@ExceptionHandler注解,可以根据不同的异常类型定义相应的处理方法。 @ControllerAdvice需要配合@ExceptionHandler一起使用。

    • @RestControllerAdvice是集合了@ControllerAdvice+@ResponseBody的功能,只是以JSON格式返回处理结果。


    创建个exception包:在其中创建自定义异常类

    自定义异常:

    1. public class SystemException extends RuntimeException {
    2.    private int code;
    3.    private String msg;
    4.    
    5. //获取枚举类中的code
    6.    public int getCode() {
    7.        return code;
    8.   }
    9.    //获取枚举类中的msg
    10.    public String getMsg() {
    11.        return msg;
    12.   }
    13.    public SystemException(RespBeanEnum respBeanEnum) {
    14.        //表示调用父类(RuntimeException)的构造方法,并传入respBeanEnum.getMsg()作为参数
    15.        super(respBeanEnum.getMsg());
    16.        this.code = respBeanEnum.getCode();
    17.        //这个其实是多余的,在super()方法中就已经传了msg,不过便于阅读。
    18.        this.msg = respBeanEnum.getMsg();
    19.   }
    20. }

            SystemException构造方法的参数是RespBeanEnum:

            定义一个枚举类,列出所有可能的错误类型,并为每个错误类型指定一个对应的错误码和错误消息。然后在自定义异常类中引用该枚举类,并使用其中的错误码和错误消息来初始化异常对象。

    1. public enum RespBeanEnum {
    2. int code;
    3. String msg;
    4.    SUCCESS(200, "操作成功"),
    5.    ERROR(500, "出现错误");
    6.    
    7. RespBeanEnum(int code, String errorMessage) {
    8.        this.code = code;
    9.        this.msg = errorMessage;
    10. }
    11. public int getCode() {
    12.   return code;
    13. }
    14. public String getMsg() {
    15.   return msg;
    16. }
    17. }
    • 解释1:

      super(respBeanEnum.getMsg())这个方法是调用父类的构造方法。最上面是:

    1. public Throwable(String message) {
    2.    fillInStackTrace();
    3.    detailMessage = message;
    4. }

            它的作用是利用父类的异常处理机制RuntimeExpetion,其包含了父类的一些异常处理机制,如堆栈轨迹,异常链的部分。则得在自定义异常类的构造方法中使用super(msg)

            通过super(respBeanEnum.getMsg())将错误消息传递给父类的构造方法,用于创建一个带有指定错误消息的自定义异常对象 SystemException

    通过结合枚举类,可以有以下优势:

    1. 错误分类清晰明确:枚举类可以将各种错误类型进行分类,使得代码的错误处理更具可读性和可维护性。

    2. 统一管理错误信息:在枚举类中定义错误码和错误消息,可以集中管理和维护所有错误信息,方便后续的修改和扩展

    3. 可拓展性:通过扩展枚举类,可以轻松添加新的错误类型,而无需修改和添加大量的代码。

    自定义全局异常处理:

    1. @RestControllerAdvice
    2. @Slf4j
    3. public class GlobalExceptionHandler {
    4.     //处理自定义异常
    5.     @ExceptionHandler(SystemException.class)
    6.     public RespBean systemExceptionHandler(SystemException e) {
    7.         //打印异常信息
    8.         log.error("出现了异常! {}", e);
    9.         //从异常对象中获取提示信息封装返回
    10.         //实际上e.getCode() 和 e.getMsg()返回的值就是枚举类定义的属性值
    11.         return RespBean.errorResult(e.getCode(), e.getMsg());
    12.     }
    13.     //处理其他异常
    14.     @ExceptionHandler(Exception.class)
    15.     public RespBean exceptionHandler(Exception e) {
    16.         //打印异常信息
    17.         log.error("出现了异常! {}", e);
    18.         //从异常对象中获取提示信息封装返回
    19.         return RespBean.errorResult(RespBeanEnum.SYSTEM_ERROR.getCode(), e.getMessage());
    20.     }
    21. }
    ERROR(500, "出现错误"),得到枚举类的code

  • 相关阅读:
    Spring Cloud微服务:Loadbalancer 实战
    [重庆思庄每日技术分享]-SQLLOADER express加载数据报 KUP-04040
    定时执行专家V6.1版发布,附更新日志及新功能截图
    软件测试之随机测试
    贪心算法(一)
    Kubernetes笔记-部署安装指南
    计组--输入输出系统--复习
    2023年数维杯国际大学生数学建模挑战赛
    光耦合器继电器与传统继电器:哪种最适合您的项目?
    分布式日志和链路追踪
  • 原文地址:https://blog.csdn.net/weixin_72926030/article/details/133885349