快捷導(dǎo)航

java實(shí)現(xiàn)統(tǒng)一異常處理的示例

更新時(shí)間：2021年06月19日 14:14:11 作者：迷路人~

一個(gè)全局異常處理類需要處理三類異常1.業(yè)務(wù)類異常，2.運(yùn)行時(shí)異常，3.Error，本文給大家介紹java實(shí)現(xiàn)統(tǒng)一異常處理的示例，感興趣的朋友一起看看吧

對(duì)于Dao層和Service產(chǎn)生的異常要一直網(wǎng)上拋，直至Controller層，但是對(duì)于controller層不能處理的異常也不能直接拋給前端。

為什么不能在service處理異常？

答：Service 層往往涉及數(shù)據(jù)庫(kù)事務(wù)，出現(xiàn)異常同樣不適合捕獲，否則事務(wù)無(wú)法自動(dòng)回滾。此外 Service 層涉及業(yè)務(wù)邏輯，有些業(yè)務(wù)邏輯執(zhí)行中遇到業(yè)務(wù)異常，可能需要在異常后轉(zhuǎn)入分支業(yè)務(wù)流程。如果業(yè)務(wù)異常都被框架捕獲了，業(yè)務(wù)功能就會(huì)不正常?！?strong>引用：極客時(shí)間的Java業(yè)務(wù)開發(fā)常見錯(cuò)誤100例】

實(shí)現(xiàn)統(tǒng)一異常處理：

在spring框架下實(shí)現(xiàn)一個(gè)異常處理的類，用 @RestControllerAdvice + @ExceptionHandler

進(jìn)行修飾：

即@RestControllerAdvice默認(rèn)會(huì)攔截 controller類上拋出的不能處理的異常

一個(gè)全局異常處理類需要處理三類異常： 1.業(yè)務(wù)類異常，2.運(yùn)行時(shí)異常，3.Error

1.運(yùn)行時(shí)異常

/**
 * @創(chuàng)建人： liup
 * @創(chuàng)建時(shí)間: 2021/6/18
 * @描述   全局異常捕獲處理類
 */
@RestControllerAdvice
@Slf4j
public class GlobalExceptionHandler {
 
    
    /**
    * @Author:  liup
    * @date:  2021/6/18 14:34
      方法實(shí)現(xiàn)說(shuō)明:  攔截運(yùn)行時(shí)異常
    */
    @ExceptionHandler(value = RuntimeException.class)
    public R runtimeExceptionHandle(RuntimeException e){
        log.error("捕捉到運(yùn)行時(shí)異常",e);
        return R.failed("未知錯(cuò)誤");
    }
}

目前僅是攔截運(yùn)行時(shí)異常

R 是返回的消息體：

那如果不使用GlobalExceptionHandler，會(huì)報(bào)出什么錯(cuò)誤呢？

這個(gè)錯(cuò)誤是在service層拋出的，當(dāng)從redis 通過(guò)key獲取一個(gè)已刪除的value時(shí)，redis返回的是null，但是我沒有判斷這個(gè)value是否為null，就將其打印出來(lái)：

log.info(authInfoVo.toString());

注意：這是要返回給前端的，msg的內(nèi)容，是對(duì)用戶十分不友好的。

2.Error

RuntimeException只是異常中的一個(gè)類，不能包含所有的異常體系，還有一大類是叫Error（系統(tǒng)級(jí)異常），所以需要有一個(gè)兜底的異常捕獲：

/**
    * @Author:  liup
    * @date:  2021/6/18 15:01
      方法實(shí)現(xiàn)說(shuō)明: 捕獲系統(tǒng)級(jí)異常
    */
    @ExceptionHandler(value = Throwable.class)
    public R  throwableHandle(Throwable th){
        log.error("捕捉到Throwable異常",th);
        return R.failed("系統(tǒng)異常");
    }

和上面那個(gè)運(yùn)行時(shí)異常同時(shí)存在。

3.業(yè)務(wù)類異常

【自己定義的異常】

首先創(chuàng)建業(yè)務(wù)異常類

/**
 * @創(chuàng)建人： liup
 * @創(chuàng)建時(shí)間: 2021/6/18
 * @描述  業(yè)務(wù)類異常
 */
public class BusinessException extends RuntimeException{
 
      @Getter
       private final String code;
 
      /**
      * @Author:  liup
      * @date:  2021/6/18 15:10
        方法實(shí)現(xiàn)說(shuō)明:  根據(jù)消息碼【可用枚舉類】 構(gòu)造業(yè)務(wù)類異常
      */
    public BusinessException(String code) {
        this.code = code;
    }
 
    /**
    * @Author:  liup
    * @date:  2021/6/18 15:08
      方法實(shí)現(xiàn)說(shuō)明:  自定義消息體構(gòu)造業(yè)務(wù)類異常
    */
    public BusinessException(String code,String message) {
        super(message);
        this.code = code;
    }
 
    /**
    * @Author:  liup
    * @date:  2021/6/18 15:09
      方法實(shí)現(xiàn)說(shuō)明:  根據(jù)異常 構(gòu)造業(yè)務(wù)類異常
    */
    public BusinessException(String code,Throwable cause) {
        super(cause);
        this.code = code;
    }
 
}

三種異常攔截同時(shí)存在;

/**
 * @創(chuàng)建人： liup
 * @創(chuàng)建時(shí)間: 2021/6/18
 * @描述   全局異常捕獲處理類
 */
@RestControllerAdvice
@Slf4j
public class GlobalExceptionHandler {
 
 
    /**
    * @Author:  liup
    * @date:  2021/6/18 15:14
      方法實(shí)現(xiàn)說(shuō)明:  攔截業(yè)務(wù)類異常
    */
    @ExceptionHandler(value = BusinessException.class)
    public R businessExceptionHandle(BusinessException e){
 
        log.error("捕獲業(yè)務(wù)類異常：",e);
        return R.failed("業(yè)務(wù)類異常:"+e.getMessage());
    }
 
 
    /**
    * @Author:  liup
    * @date:  2021/6/18 14:34
      方法實(shí)現(xiàn)說(shuō)明:  攔截運(yùn)行時(shí)異常
//    */
    @ExceptionHandler(value = RuntimeException.class)
    public R runtimeExceptionHandle(RuntimeException e){
        log.error("捕捉到運(yùn)行時(shí)異常",e);
        return R.failed("未知錯(cuò)誤:");
    }
 
    /**
    * @Author:  liup
    * @date:  2021/6/18 15:01
      方法實(shí)現(xiàn)說(shuō)明: 捕獲系統(tǒng)級(jí)異常
    */
    @ExceptionHandler(value = Throwable.class)
    public R  throwableHandle(Throwable th){
        log.error("捕捉到Throwable異常",th);
        return R.failed("系統(tǒng)異常");
    }
}

4.對(duì)服務(wù)器友好：

以上是對(duì)前端友好，但是在服務(wù)器上，不是容易定位錯(cuò)誤,

但是若是在參數(shù)上添加上HttpServletRequest req, HandlerMethod method，就很容易定位到錯(cuò)誤

 private static int GENERIC_SERVER_ERROR_CODE = 2000;
    private static String GENERIC_SERVER_ERROR_MESSAGE = "服務(wù)器忙，請(qǐng)稍后再試";
 
    @ExceptionHandler
    public R handle(HttpServletRequest req, HandlerMethod method, Exception ex) {
        if (ex instanceof BusinessException) {
            BusinessException exception = (BusinessException) ex;
            log.warn(String.format("訪問(wèn) %s -> %s 出現(xiàn)業(yè)務(wù)異常！", req.getRequestURI(), method.toString()), ex);
            return R.failed(GENERIC_SERVER_ERROR_MESSAGE);
        } else if (ex instanceof RuntimeException){
            log.error(String.format("訪問(wèn) %s -> %s 出現(xiàn)運(yùn)行時(shí)異常！", req.getRequestURI(), method.toString()), ex);
            return R.failed(GENERIC_SERVER_ERROR_MESSAGE);
        }
 
        else {
            log.error(String.format("訪問(wèn) %s -> %s 出現(xiàn)系統(tǒng)異常！", req.getRequestURI(), method.toString()), ex);
            return R.failed(GENERIC_SERVER_ERROR_MESSAGE);
        }
    }