介紹:
在日常項目開發中,異常是常見的,但是如何更高效的處理好異常信息,讓我們能快速定位到BUG,是很重要的,不僅能夠提高我們的開發效率,還能讓你代碼看上去更舒服,SpringBoot的項目已經對有一定的異常處理了,但是對于我們開發者而言可能就不太合適了,因此我們需要對這些異常進行統一的捕獲并處理。
我們只需在完整的springboot項目中添加四個java類即可
一:異常枚舉類
/*** @version 1.0* @Author guozhen8* @Date 2023年11月23日 0023 17:57:01* @注釋 異常返回枚舉類*/
@Getter
@ToString
@AllArgsConstructor
public enum RespBeanEnum {SUCCESS(200,"SUCCESS"),ERROR(500,"服務端異常"),BIND_ERROR(500210,"參數校驗異常"),NULL_ERROR(500211,"找不到數據"),INSERT_ERROR(500212,"數據插入異常-主鍵重復" );private final Integer code;private final String message;}
二:異常返回結果類
/*** @version 1.0* @Author guozhen8* @Date 2023年11月23日 0023 17:57:01* @注釋 異常返回類*/
@Data
@NoArgsConstructor
@AllArgsConstructor
public class RespBean {private long code;private String message;private Object obj;/*** 功能描述:返回成功結果* @param* @return*/public static RespBean success(){return new RespBean(RespBeanEnum.SUCCESS.getCode(),RespBeanEnum.SUCCESS.getMessage(),null);}/*** 功能描述:返回成功結果* @param obj* @return*/public static RespBean success(Object obj){return new RespBean(RespBeanEnum.SUCCESS.getCode(),RespBeanEnum.SUCCESS.getMessage(),obj);}/*** 功能描述:返回失敗結果* @param respBeanEnum* @return*/public static RespBean error(RespBeanEnum respBeanEnum){return new RespBean(respBeanEnum.getCode(),respBeanEnum.getMessage(),null);}/*** 功能描述:返回失敗結果* @param respBeanEnum,obj* @return*/public static RespBean error(RespBeanEnum respBeanEnum,Object obj){return new RespBean(respBeanEnum.getCode(),respBeanEnum.getMessage(),obj);}
}
三:全局異常
/*** @version 1.0* @Author guozhen8* @Date 2023年11月23日 0023 17:57:01* @注釋 全局異常*/
@Data
@NoArgsConstructor
@AllArgsConstructor
public class GlobalException extends RuntimeException{private RespBeanEnum respBeanEnum;
}
四:全局異常處理類
/*** @version 1.0* @Author guozhen8* @Date 2023年11月23日 0023 17:57:01* @注釋 自定義異常處理類*/
@RestControllerAdvice
public class GlobalExceptionHandler {//調試日志private final Logger logger = LoggerFactory.getLogger(this.getClass());@ExceptionHandler(Exception.class)//處理哪些異常public RespBean ExceptionHandler(Exception e,HttpServletRequest request){//打印日志logger.error("Requst URL : {},Exception : {}", request.getRequestURL(),e);if(e instanceof GlobalException){//如果是之前自定義的異常GlobalException ex = (GlobalException) e;return RespBean.error(ex.getRespBeanEnum());}else if(e instanceof BindException) { //沒有通過參數校驗注解拋出的異常BindException ce = (BindException) e;RespBean respBean = RespBean.error(RespBeanEnum.BIND_ERROR);respBean.setMessage("參數校驗異常:" + ce.getMessage());return respBean;}else if(e instanceof DuplicateKeyException) { //插入重復數據拋出的異常DuplicateKeyException de = (DuplicateKeyException) e;RespBean respBean = RespBean.error(RespBeanEnum.INSERT_ERROR);respBean.setMessage("參數插入異常:" + de.getMessage());return respBean;}else if(e instanceof ConstraintViolationException) { //傳入數據有誤拋出的異常ConstraintViolationException de = ( ConstraintViolationException) e;RespBean respBean = RespBean.error(RespBeanEnum.BIND_ERROR);respBean.setMessage("參數校驗異常:" + de.getMessage());return respBean;}return RespBean.error(RespBeanEnum.ERROR);}}
五:使用方法
在使用時,我們可以返回異常結果類或者直接拋出相關異常即可。
//1:返回異常結果
return RespBean.error(RespBeanEnum.ERROR,"xxxx");
return RespBean.success("xxxx");
//2:拋出異常
throw new BindException("xxxx");