异常处理

我们开发项目的时候，数据在请求过程中发生错误是非常常见的事情。

如：权限不足、数据唯一异常、数据不能为空异常、义务异常等。 这些异常如果不经过处理会对前端开发人员和使用者造成不便，因此我们就需要统一处理他们。

源码位于：源码位于：eladmin-common 模块中的 exception 包中

异常封装

异常实体

  1. @Data
  2. class ApiError {
  3.     private Integer status;
  4.     @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
  5.     private LocalDateTime timestamp;
  6.     private String message;
  8.     private ApiError() {
  9.         timestamp = LocalDateTime.now();
  10.     }
  12.     public ApiError(Integer status,String message) {
  13.         this();
  14.         this.status = status;
  15.         this.message = message;
  16.     }
  17. }

自定义异常

1、通用异常

封装了 BadRequestException，用于处理通用的异常

  1. @Getter
  2. public class BadRequestException extends RuntimeException{
  4.     private Integer status = BAD_REQUEST.value();
  6.     public BadRequestException(String msg){
  7.         super(msg);
  8.     }
  10.     public BadRequestException(HttpStatus status,String msg){
  11.         super(msg);
  12.         this.status = status.value();
  13.     }
  14. }

2、实体相关异常

(1) 实体不存在： EntityNotFoundException

  1. import org.springframework.util.StringUtils;
  3. /**
  4.  * @author Zheng Jie
  5.  * @date 2018-11-23
  6.  */
  7. public class EntityNotFoundException extends RuntimeException {
  9.     public EntityNotFoundException(Class clazz, String field, String val) {
  10.         super(EntityNotFoundException.generateMessage(clazz.getSimpleName(), field, val));
  11.     }
  13.     private static String generateMessage(String entity, String field, String val) {
  14.         return StringUtils.capitalize(entity)
  15.                 + " with " + field + " "+ val + " does not exist";
  16.     }
  17. }

(2) 实体已存在：EntityExistException

  1. import org.springframework.util.StringUtils;
  3. /**
  4.  * @author Zheng Jie
  5.  * @date 2018-11-23
  6.  */
  7. public class EntityExistException extends RuntimeException {
  9.     public EntityExistException(Class clazz, String field, String val) {
  10.         super(EntityExistException.generateMessage(clazz.getSimpleName(), field, val));
  11.     }
  13.     private static String generateMessage(String entity, String field, String val) {
  14.         return StringUtils.capitalize(entity)
  15.                 + " with " + field + " "+ val + " existed";
  16.     }
  17. }

使用场景，删除用户的时候是根据ID删除的，可判断ID是否存在，抛出异常

新增用户的时候用户名是唯一的，可判断用户是否存在，抛出异常

全局异常拦截

使用全局异常处理器 @RestControllerAdvice 处理请求发送的异常

  • @RestControllerAdvice：默认会扫描指定包中所有@RequestMapping注解

  • @ExceptionHandler：通过@ExceptionHandler的 value 属性可过滤拦截的条件

  1. @RestControllerAdvice
  2. public class GlobalExceptionHandler {
  4.     /**
  5.      * 处理所有不可知的异常
  6.      * @param e
  7.      * @return
  8.      */
  9.     @ExceptionHandler(Throwable.class)
  10.     public ResponseEntity handleException(Throwable e){
  11.         // 打印堆栈信息
  12.         log.error(ThrowableUtil.getStackTrace(e));
  13.         ApiError apiError = new ApiError(BAD_REQUEST.value(),e.getMessage());
  14.         return buildResponseEntity(apiError);
  15.     }
  16.     /**
  17.      * 处理自定义异常
  18.      * @param e
  19.      * @return
  20.      */
  21.     @ExceptionHandler(value = BadRequestException.class)
  22.     public ResponseEntity<ApiError> badRequestException(BadRequestException e) {
  23.         // 打印堆栈信息
  24.         log.error(ThrowableUtil.getStackTrace(e));
  25.         ApiError apiError = new ApiError(e.getStatus(),e.getMessage());
  26.         return buildResponseEntity(apiError);
  27.     }
  29.     /**
  30.      * 处理 EntityExist
  31.      * @param e
  32.      * @return
  33.      */
  34.     @ExceptionHandler(value = EntityExistException.class)
  35.     public ResponseEntity<ApiError> entityExistException(EntityExistException e) {
  36.         // 打印堆栈信息
  37.         log.error(ThrowableUtil.getStackTrace(e));
  38.         ApiError apiError = new ApiError(BAD_REQUEST.value(),e.getMessage());
  39.         return buildResponseEntity(apiError);
  40.     }
  42.     /**
  43.      * 处理 EntityNotFound
  44.      * @param e
  45.      * @return
  46.      */
  47.     @ExceptionHandler(value = EntityNotFoundException.class)
  48.     public ResponseEntity<ApiError> entityNotFoundException(EntityNotFoundException e) {
  49.         // 打印堆栈信息
  50.         log.error(ThrowableUtil.getStackTrace(e));
  51.         ApiError apiError = new ApiError(NOT_FOUND.value(),e.getMessage());
  52.         return buildResponseEntity(apiError);
  53.     }
  54.     /**
  55.      * 统一返回
  56.      * @param apiError
  57.      * @return
  58.      */
  59.     private ResponseEntity<ApiError> buildResponseEntity(ApiError apiError) {
  60.         return new ResponseEntity(apiError, HttpStatus.valueOf(apiError.getStatus()));
  61.     }
  62. }

具体使用

  1. // 通用异常
  2. throw new BadRequestException("发生了异常");
  3. // 通用异常，使用自定义状态码
  4. throw new BadRequestException(HttpStatus.OK, "发送了异常");
  5. // 实体存在异常
  6. throw new EntityExistException(User.class, "email", "elunez@qq.com");
  7. // 实体不存在异常
  8.  throw new EntityNotFoundException(User.class, "userName", "test");