SpringBoot中異常處理實戰(zhàn)記錄

更新時間：2022年05月01日 10:03:11 作者：huan1993

在我們實際項目開放中經(jīng)常需要我們處理很多的異常,如何在spring boot項目里面實現(xiàn)異常處理呢,下面這篇文章主要給大家介紹了關于SpringBoot中異常處理的相關資料,需要的朋友可以參考下

一、背景

在我們編寫程序的過程中，程序中可能隨時發(fā)生各種異常，那么我們如何優(yōu)雅的處理各種異常呢？

二、需求

1、攔截系統(tǒng)中部分異常，返回自定義的響應。

比如：

系統(tǒng)發(fā)生HttpRequestMethodNotSupportedException異常，我們需要返回如下信息。

http的狀態(tài)碼：返回 405

{
	code: 自定義異常碼,
	message: 錯誤消息
}

2、實現(xiàn)自定義異常的攔截

攔截我們自己寫的 BizException

三、編寫一些異常基礎代碼

1、引入jar包

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-validation</artifactId>
    </dependency>
</dependencies>

注意：

引入spring-boot-starter-validation是為了驗證請求的中的參數(shù)，然后當參數(shù)不滿足時拋出異常。

2、定義一個自定義異常

public class BizException extends RuntimeException {
    public BizException() {
    }
    public BizException(String message) {
        super(message);
    }
    public BizException(String message, Throwable cause) {
        super(message, cause);
    }
    public BizException(Throwable cause) {
        super(cause);
    }
    public BizException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
        super(message, cause, enableSuppression, writableStackTrace);
    }
}

解釋

提供一個 /exception/password api，需要傳遞一個password參數(shù)

1、當不傳遞 password 參數(shù)時將拋出MethodArgumentNotValidException異常。

2、當password傳遞exception參數(shù)時，則拋出BizException異常。

4、測試

1、不傳遞password參數(shù)響應是什么

1、使用默認的DefaultHandlerExceptionResolver處理

這個類DefaultHandlerExceptionResolver是默認自動配置的。

從上圖中可以看出有一個默認字段的返回值

2、使用ResponseEntityExceptionHandler處理

1、編寫異常處理代碼-使用默認的邏輯

@RestControllerAdvice
public class RestExceptionHandler extends ResponseEntityExceptionHandler {

    @Override
    protected ResponseEntity<Object> handleMethodArgumentNotValid(MethodArgumentNotValidException ex, HttpHeaders headers, HttpStatus status, WebRequest request) {
        // 此處自定義返回值
        return super.handleMethodArgumentNotValid(ex, headers, status, request);
    }
}

可以看到handleMethodArgumentNotValid方法直接調用父類的方法，即使用默認的處理方式。

從上圖中可以看出返回值是空

2、編寫異常處理代碼-返回值返回自定義內容

@Component
@RestControllerAdvice
public class RestExceptionHandler extends ResponseEntityExceptionHandler {
	@Override
    protected ResponseEntity<Object> handleMethodArgumentNotValid(MethodArgumentNotValidException ex, HttpHeaders headers, HttpStatus status, WebRequest request) {
        // 此處自定義返回值
        return super.handleMethodArgumentNotValid(ex, headers, status, request);
    }
        
	@Override
    protected ResponseEntity<Object> handleHttpRequestMethodNotSupported(HttpRequestMethodNotSupportedException ex, HttpHeaders headers, HttpStatus status, WebRequest request) {
        Set<HttpMethod> supportedMethods = ex.getSupportedHttpMethods();

        // 自定義請求返回值
        Map<String, Object> body = new HashMap<>(4);
        body.put("code", "錯誤碼");
        body.put("message", "當前請求的方法不支持,支持的請求方法為:" + supportedMethods);

        return new ResponseEntity<>(body, headers, status);
    }
}

由上面的代碼可知handleHttpRequestMethodNotSupported方法返回了自定義的body。

從上圖中可以看出，返回了我們自己定義的返回值。

2、password參數(shù)傳遞exception1、使用ResponseEntityExceptionHandler或DefaultHandlerExceptionResolver處理

由上圖可知返回結果不對，我們需要自定義返回結果。

2、返回自定義異常

1、編寫B(tài)izException處理代碼

@RestControllerAdvice
public class BizExceptionHandler {

    @ExceptionHandler(BizException.class)
    public ResponseEntity<Object> handleBizException(BizException exception) {
        // 自定義請求返回值
        Map<String, Object> body = new HashMap<>(4);
        body.put("code", "錯誤碼");
        body.put("message", "異常信息為:" + exception.getMessage());
        return new ResponseEntity<>(body, HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

2、測試返回結果