统一异常处理

统一异常处理类

  1. import com.honghe.managerTool.config.exception.MySecurityException;
  2. import com.honghe.managerTool.entity.Result;
  3. import org.slf4j.Logger;
  4. import org.slf4j.LoggerFactory;
  5. import org.springframework.web.bind.annotation.ControllerAdvice;
  6. import org.springframework.web.bind.annotation.ExceptionHandler;
  7. import org.springframework.web.bind.annotation.ResponseBody;
  10. /**
  11.  * @ControllerAdvice  //处理所有
  12.  * @ControllerAdvice(annotations=RestController.class)   //处理这个类下的异常
  13.  * @ControllerAdvice(basePackages={"com.honghe.managerTool.controller"})   //处理包下的异常
  14.  */
  16. @ControllerAdvice
  17. public class GlobalExceptionHandler {
  20.     private Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);
  22.     /**
  23.      * //处理需要处理的异常类
  24.      * @ExceptionHandler(value={RuntimeException.class,MyRuntimeException.class}) 
  25.      * @ExceptionHandler    //处理所有异常
  26.      * @ExceptionHandler(MySecurityException.class)  //处理专门的异常
  27.      */
  29.     @ResponseBody//返回字符串
  30.     @ExceptionHandler
  31.     public Result exceptionHandler(Exception e) {
  32.         if (e instanceof MySecurityException){
  33.             MySecurityException me = (MySecurityException)e;
  34.             //logger.error("权限异常",e);
  35.             return new Result(me.getCode(),false,e.getMessage());
  36.         }else if (e instanceof NullPointerException){
  37.             logger.error("空指针异常",e);
  38.             return new Result(-3,false,"空指针异常");
  39.         }else{
  40.             return new Result(-3,false,"异常");
  41.         }
  42.     }
  43. }

2.统一异常处理 - 图1
自定义异常类

  1. /**
  2.  * 权限验证异常
  3.  * @author zhaojianyu
  4.  */
  5. public class MySecurityException extends RuntimeException {
  7.     private Integer code;
  9.     /**
  10.      * 无参构造方法
  11.      */
  12.     public MySecurityException(){
  13.         super();
  14.     }
  16.     /**
  17.      * 有参的构造方法
  18.      */
  19.     public MySecurityException(String message,Integer code){
  20.         super(message);
  21.         this.code = code;
  22.     }
  24.     /**
  25.      * 用指定的详细信息和原因构造一个新的异常
  26.      */
  27.     public MySecurityException(String message, Throwable cause){
  29.         super(message,cause);
  30.     }
  32.     /**
  33.      * 用指定原因构造一个新的异常
  34.      */
  35.      public MySecurityException(Throwable cause) {
  36.          super(cause);
  37.      }
  40.     public Integer getCode() {
  41.         return code;
  42.     }
  43.     public void setCode(Integer code) {
  44.         this.code = code;
  45.     }
  46. }

抛出自定义异常

  1. throw new MySecurityException("请求超时,请同步服务器时间",-2);

返回值代码枚举类

  1. /**
  2.  *
  3.  * 返回值枚举类
  4.  * @author: zhaojianyu
  5.  * @create: 2018-10-11 17:50
  6.  **/
  7. public enum ResultEnum {
  8.     /**
  9.      * 异常信息
  10.      */
  11.     UNKONW_ERROR(-1,"未知错误"),
  12.     SUCCESS(0,"请求成功"),
  13.     SECURITY_EXCEPTION(-2,"权限异常"),
  14.     PARAMS_EXCEPTION(-3,"权限异常")
  15.     ;
  16.     private Integer code;
  17.     private String message;
  19.     ResultEnum() {
  20.     }
  22.     ResultEnum(Integer code, String message) {
  23.         this.code = code;
  24.         this.message = message;
  25.     }
  27.     public Integer getCode() {
  28.         return code;
  29.     }
  31.     public void setCode(Integer code) {
  32.         this.code = code;
  33.     }
  35.     public String getMessage() {
  36.         return message;
  37.     }
  39.     public void setMessage(String message) {
  40.         this.message = message;
  41.     }
  42. }

统一处理校验异常

针对参数校验 会发生以下三种异常

  • @RequestBody 可以标注在实体上 校验失败抛出异常: MethodArgumentNotValidException
  • @PathVariable 以及 @RequestParam 时 直接标注在方法参数上,同时需要在controller类上加上 @Validated 进行标注 校验失败抛出异常: ConstraintViolationException
  • 当get请求中 参数为实体时, 校验失败会抛出 BindException
  2. import com.tinet.smartlink.commons.mvc.response.ApiResponseEntity;
  3. import com.tinet.smartlink.commons.mvc.response.ErrorCode;
  4. import lombok.extern.slf4j.Slf4j;
  5. import org.springframework.http.ResponseEntity;
  6. import org.springframework.validation.BindException;
  7. import org.springframework.validation.BindingResult;
  8. import org.springframework.validation.FieldError;
  9. import org.springframework.web.bind.MethodArgumentNotValidException;
  10. import org.springframework.web.bind.annotation.ExceptionHandler;
  11. import org.springframework.web.bind.annotation.ResponseBody;
  12. import org.springframework.web.bind.annotation.RestControllerAdvice;
  13. import org.springframework.web.context.request.WebRequest;
  15. import javax.validation.ConstraintViolationException;
  16. import java.util.*;
  18. /**
  19.  * 统一异常处理
  20.  * @author zhaojy
  21.  */
  22. @Slf4j
  23. @RestControllerAdvice
  24. public class GlobalExceptionHandler {
  26.     /**
  27.      * 参数校验统一异常处理
  28.      */
  29.     @ResponseBody
  30.     @ExceptionHandler(value = {ConstraintViolationException.class, MethodArgumentNotValidException.class, BindException.class})
  31.     public ResponseEntity<Object> handleMethodArgumentException(Exception e, WebRequest request) {
  33.         StringBuilder message = new StringBuilder("[参数校验失败]: ");
  35.         Map<String, Object> map = null;
  36.         if (e instanceof MethodArgumentNotValidException) {
  37.             BindingResult bindingResult = ((MethodArgumentNotValidException) e).getBindingResult();
  39.             message.append(getExceptionMessageMap(bindingResult));
  41.         } else if (e instanceof ConstraintViolationException) {
  42.             message.append(e.getMessage());
  44.         } else if (e instanceof BindException) {
  45.             message.append(getExceptionMessageMap((BindingResult) e));
  47.         }
  48.         log.warn(message.toString());
  49.         return ApiResponseEntity.error(ErrorCode.InvalidParameter, message.toString()).toResponseEntity();
  50.     }
  52.     /**
  53.      * 获取校验失败字段 及message
  54.      *
  55.      * @param bindingResult 结果
  56.      * @return 空map 或 错误信息map
  57.      */
  58.     private Map<String, Object> getExceptionMessageMap(BindingResult bindingResult) {
  59.         Map<String, Object> map;
  60.         if (Objects.isNull(bindingResult)){
  61.             return new HashMap<>(1);
  62.         }
  63.         if (bindingResult.hasErrors()) {
  64.             List<FieldError> fieldErrors = bindingResult.getFieldErrors();
  65.             map = new HashMap<>(fieldErrors.size());
  66.             fieldErrors.forEach(error -> map.put(error.getField(), error.getDefaultMessage()));
  67.         } else {
  68.             map = new HashMap<>(1);
  69.         }
  70.         return map;
  71.     }
  72. }

参考视频连接
https://www.bilibili.com/video/av62728471