Spring Boot：异常统一处理

忘是亡心i 2021-12-22 12:41 536阅读 0赞

## 一：前言 ##

这里先对需要使用到的注解或者类进行说明，顺便理清楚条理。  
**@ExceptionHandler**：注解使用在方法上，值为指定某个异常，当该方法所在的controller出现的异常与注解的异常对应，则会触发注解的方法。  
下面这个controller一旦出现异常都会将异常捕获转给该方法进行处理

@RestController
    @RequestMapping("user")
    public class UserController { 
    
        @ExceptionHandler(value = Exception.class)
        public void solveException(){ 
            //异常处理逻辑
        }
        
    }

**@controllerAdvice**： 注解在类上，注解的类会注册到spring容器中，类中可有三种注解，@ExceptionHandler，@InitBinder，@ModelAttribute。该类下只要是注解上面三个注解的方法就是让把方法应用到程序中所有带有@RequesMapping注解的方法上。

#### 流程 ： ####

1.  自定义一个自己的异常
2.  声明带有@ControllerAdvice的类和@ExceptionHandler的方法，将@ExceptionHandler的方法应用到所有controller。
3.  声明一个返回结果类
4.  声明一个枚举类，用来包含可能出现的异常类型

## 二：Demo ##

自定义异常：

@Data
    @AllArgsConstructor
    public class MyException extends RuntimeException{ 
        private Integer code;
        private String msg;
    
        public MyException(ResultEnum resultEnum){ 
            this.msg = resultEnum.getMsg();
            this.code = resultEnum.getCode();
        }
    }

自定义返回结果：

@Data
    @AllArgsConstructor
    @NoArgsConstructor
    public class Result { 
        private int code;
        private String msg;
    }

枚举类：

public enum  ResultEnum { 
        UNKNOW_ERROR(-1,"未知错误"),
        USER_ERROR(-2,"用户信息错误"),
        SUCCESS(0,"成功");
    
        private  Integer code;
        private  String msg;
    
        ResultEnum(Integer code, String msg) { 
            this.code = code;
            this.msg = msg;
        }
        //省略getter和setter
    }

工具类：

public class ResultUtil { 
    
        public static Result error(Integer code, String msg) { 
            Result result = new Result();
            result.setCode(code);
            result.setMsg(msg);
            return result;
        }
    }

自定义异常捕获类：

@ControllerAdvice
    @Slf4j
    public class MyExceptionHandler { 
    	//接收的是Exception，也就是只要是异常都会执行这方法
        @ExceptionHandler(value=Exception.class)
        @ResponseBody
        public Result handle(Exception e){ 
            if(e instanceof MyException){ 
                MyException myException = (MyException) e;
                return ResultUtil.error(myException.getCode(),myException.getMsg());
            }else{ 
                return ResultUtil.error(-1,"未知错误");
            }
        }
    }

controller类：

@RestController
    @RequestMapping("user")
    public class UserController { 
    
        @GetMapping("exception")
        public void catchException() throws Exception{ 
            throw new MyException(ResultEnum.USER_ERROR);
        }
     }

#### 流程： ####

1.  我们访问http://localhost:8080/user/exception来访问该方法，并抛出我们自定义的异常，通过枚举类来进行对异常信息的集合。
2.  通过自定义的异常捕获类，来进行对异常的捕获，执行方法。
3.  异常捕获类的方法中，通过ResultUtil工具类来进行生成Result对象返回。