快捷導(dǎo)航

詳解如何在SpringBoot項(xiàng)目中使用全局異常處理

更新時(shí)間：2022年10月19日 16:44:49 作者：picacho_pkq

在完整的項(xiàng)目開發(fā)中，異常的出現(xiàn)幾乎是無法避免的；如果凡是有可能出現(xiàn)異常的地方，我們都手動(dòng)的使用try-catch將其捕獲的話，會使得代碼顯得十分臃腫并且后期不好維護(hù)。本文介紹了pringBoot項(xiàng)目中使用全局異常處理的方法，需要的可以參考一下

在完整的項(xiàng)目開發(fā)中，異常的出現(xiàn)幾乎是無法避免的；如果凡是有可能出現(xiàn)異常的地方，我們都手動(dòng)的使用try-catch將其捕獲的話，雖然也能達(dá)到處理異常的效果，但是這樣做會使得代碼顯得十分臃腫并且后期不好維護(hù)，也不利于多人系統(tǒng)開發(fā)。

在Spring Boot中提供了統(tǒng)一處理異常的方法，SpringBoot中有一個(gè)ControllerAdvice的注解，使用該注解表示開啟了全局異常的捕獲，我們只需在自定義一個(gè)方法使用ExceptionHandler注解然后定義捕獲異常的類型即可對這些捕獲的異常進(jìn)行統(tǒng)一的處理。接下來就用一個(gè)小demo來演示一下全局異常處理的方法。

1. 創(chuàng)建自定義異常

接著上一篇在Spring Boot項(xiàng)目中使用統(tǒng)一返回結(jié)果一文中，繼續(xù)添加全局異常處理部分。

NotLoginException.java

@Data
@NoArgsConstructor
@AllArgsConstructor
@ToString
public class NotLoginException extends RuntimeException{

    private Integer errorCode;
    private String message;

}

2.創(chuàng)建全局異常處理器

定義全局異常處理器，用來捕獲項(xiàng)目中拋出的自定義異常和普通異常，然后按照統(tǒng)一的數(shù)據(jù)格式返回給前端。在項(xiàng)目中不管是返回失敗結(jié)果，還是返回成功結(jié)果，我們都統(tǒng)一返回?cái)?shù)據(jù)的格式。

MyExceptionHandler.java

@ControllerAdvice
public class MyExceptionHandler {

    /**
     * 捕獲我們自定義的異常
     * @param notLoginException
     * @return
     */
    @ExceptionHandler(NotLoginException.class)
    @ResponseBody
    public Result notLoginExceptionHandler(NotLoginException notLoginException){
        return ResultGenerator.genErrorResult(notLoginException.getErrorCode(), notLoginException.getMessage());
    }

    /**
     * 捕獲其他異常
     * @param exception
     * @return
     */
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public Result otherException(Exception exception){
        return ResultGenerator.genErrorResult(Constants.RESULT_CODE_SERVER_ERROR, exception.getMessage());
    }


    // 可以定義區(qū)分更細(xì)粒度的異常，然后在此處進(jìn)行捕獲

}

3.創(chuàng)建測試控制器

ExceptionController.java

@Controller
public class ExceptionController {


    @GetMapping("/notLoginException/{id}")
    @ResponseBody
    public Result notLoginException(@PathVariable("id") Integer id){
        if(id != null && id == 1){
            // 拋出一個(gè)自定義的異常
            throw new NotLoginException(Constants.RESULT_CODE_BAD_REQUEST, "沒有登陸");  // 這里一般會定一個(gè)枚舉，定義每一個(gè)狀態(tài)碼對應(yīng)的信息
        }
        return ResultGenerator.genSuccessResult();
    }


    @GetMapping("/exception")
    @ResponseBody
    public Result exception(){
        int num = 1 / 0;
        return ResultGenerator.genSuccessResult();
    }
}

測試自定義異常，先正常給參數(shù)，接著給錯(cuò)誤參數(shù)，讓其拋出異常。