SpringBoot實現全域性例外處理方法總結

2022-03-04 13:00:34

如果我們這樣處理異常,程式碼中就會出現特別多的例外處理模組，這樣程式碼就會變得可讀性非常差，而且業務模組邏輯會夾雜特別多的非業務邏輯。但是在專案開發的過程中我們應該將主要精力放在業務模組，除了必要的例外處理模組最好不要再包含其他無關緊要的程式碼。那麼我們如何處理專案中無處不在的異常呢?這就引出了我們要介紹的全域性例外處理方法,主要有兩種種方式：

HandlerExceptionResolver。

@ControllerAdvice+@ExceptionHandler 今天我們主要介紹一下@ControllerAdvice+@ExceptionHandler模式處理全域性異常。

全域性例外處理

首先我們先介紹一下@ControllerAdvice和@ExceptionHandler

@ControllerAdvice註解： 他是一個比較特殊的@Component,用於定義全域性例外處理類作用在所有的@Controller型別的介面上。

@ExceptionHandler註解: 用於宣告處理異常的方法。

設定全域性異常

@ControllerAdvice+@ExceptionHandler只要設計得當,就不用再在Controller使用trg-catch了!下面我們先寫介紹一個Controller層全域性例外處理類。

@ControllerAdvice
public class GlobalExceptionHandler {
   @ResponseBody
    @ExceptionHandler(Exception.class)
    public CommonResult exceptionHandler(HttpServletRequest request, Exception exception) throws Exception {    
        Map<String, Object> result = new HashMap<>(3);
        String message =exception.getMessage()+request.getRequestURL().toString();
        return CommonResult.failed(message);
    }
}

注:@ResponseBody的作用其實是將java物件轉為json格式的資料。然後到這裡為止，一個簡單的全域性例外處理解決方式就完成了,這只是一個簡單的例外處理方式，遠遠不能達到完整專案中全域性例外處理的方案。

全域性例外處理的升級

我們專案中業務處理，可以通過自定義的異常知道哪一個模組發生異常，並且不同的業務模組也有不同的例外處理方式，這也方便我們做擴充套件

public class ServiceException extends RuntimeException {
    private IErrorCode errorCode;
    public ServiceException(IErrorCode errorCode) {
        super(errorCode.getMessage());
        this.errorCode = errorCode;
    }
    public ServiceException(String message) {
        super(message);
    }
    public ServiceException(Throwable cause) {
        super(cause);
    }
    public ServiceException(String message, Throwable cause) {
        super(message, cause);
    }
    public IErrorCode getErrorCode() {
        return errorCode;
    }
}

加入自定義例外處理

@ControllerAdvice
public class GlobalExceptionHandler {
    /**
     * 處理所有Service層異常
     */
    @ResponseBody
    @ExceptionHandler(value = ServiceException.class)
    public CommonResult handle(ServiceException e) {
        if (e.getErrorCode() != null) {
            return CommonResult.failed(e.getErrorCode());
        }
        return CommonResult.failed(e.getMessage());
    }
    /**
     * 處理所有不可知的異常
     */
    @ResponseBody
    @ExceptionHandler(Exception.class)
    public CommonResult exceptionHandler(HttpServletRequest request, Exception exception) throws Exception {
     
        Map<String, Object> result = new HashMap<>(3);
        String message =exception.getMessage()+request.getRequestURL().toString();
        return CommonResult.failed(message);
    }
 
}

處理 Controller 資料繫結、資料校驗的異常

在使用者登入Model欄位上註解資料校驗規則。

@Data
@EqualsAndHashCode(callSuper = false)
public class UserLoginParam {
    @NotEmpty
    private String username;
    @NotEmpty
    private String password;
}

SpringBoot中可以使用@Validated + @RequestBody註解方式實現資料繫結和資料校驗。例如登入方式為：

@ApiOperation(value = "登入以後返回token")
    @RequestMapping(value = "/login", method = RequestMethod.POST)
    @ResponseBody
    public CommonResult login(@Validated @RequestBody UmsAdminLoginParam umsAdminLoginParam) {
        String token = adminService.login(umsAdminLoginParam.getUsername(), umsAdminLoginParam.getPassword());
        if (token == null) {
            return CommonResult.validateFailed("使用者名稱或密碼錯誤");
        }
        Map<String, String> tokenMap = new HashMap<>();
        tokenMap.put("token", token);
        tokenMap.put("tokenHead", tokenHead);
        return CommonResult.success(tokenMap);
    }

如果資料校驗不對資料丟擲的異常為MethodArgumentNotValidException,所以我們可以在全域性例外處理類中新增對MethodArgumentNotValidException異常的處理宣告，就可以實現全域性處理資料校驗和繫結的異常了，實現如下：

@ResponseBody
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public CommonResult handleValidException(MethodArgumentNotValidException e) {
        BindingResult bindingResult = e.getBindingResult();
        String message = null;
        if (bindingResult.hasErrors()) {
            FieldError fieldError = bindingResult.getFieldError();
            if (fieldError != null) {
                message = fieldError.getField()+fieldError.getDefaultMessage();
            }
        }
        return CommonResult.validateFailed(message);
    }

通過上面介紹的未知異常、資料校驗和自定義全域性異常所有的Controller層的例外處理方式全部都集中到了GlobalExceptionHandler類中，那麼我們在Controller類中就不再需要收到記錄錯誤了。

GlobalExceptionHandler全部程式碼

@ControllerAdvice
public class GlobalExceptionHandler {
    @ResponseBody
    @ExceptionHandler(value = ApiException.class)
    public CommonResult handle(ApiException e) {
        if (e.getErrorCode() != null) {
            return CommonResult.failed(e.getErrorCode());
        }
        return CommonResult.failed(e.getMessage());
    }
    @ResponseBody
    @ExceptionHandler(Exception.class)
    public CommonResult exceptionHandler(HttpServletRequest request, Exception exception) throws Exception {
        Map<String, Object> result = new HashMap<>(3);
        String message =exception.getMessage()+request.getRequestURL().toString();
        return CommonResult.failed(message);
       // return result;
    }
    @ResponseBody
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public CommonResult handleValidException(MethodArgumentNotValidException e) {
        BindingResult bindingResult = e.getBindingResult();
        String message = null;
        if (bindingResult.hasErrors()) {
            FieldError fieldError = bindingResult.getFieldError();
            if (fieldError != null) {
                message = fieldError.getField()+fieldError.getDefaultMessage();
            }
        }
        return CommonResult.validateFailed(message);
    }
}

總結

今天主要講解了@ControllerAdvice+@ExceptionHandler進行統一的在Controller層上的全域性例外處理。

到此這篇關於SpringBoot實現全域性例外處理方法總結的文章就介紹到這了,更多相關SpringBoot全域性例外處理內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！