SpringBoot中異常處理實例分析

這篇文章主要介紹“SpringBoot中異常處理實例分析”的相關知識，小編通過實際案例向大家展示操作過程，操作方法簡單快捷，實用性強，希望這篇“SpringBoot中異常處理實例分析”文章能幫助大家解決問題。

一、背景

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

二、需求

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

比如：

系統發生HttpRequestMethodNotSupportedException異常，我們需要返回如下信息。

http的狀態碼：返回 405

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

2、實現自定義異常的攔截

攔截我們自己寫的 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是為了驗證請求的中的參數，然后當參數不滿足時拋出異常。

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參數

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

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

4、測試

1、不傳遞password參數響應是什么

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參數傳遞exception1、使用ResponseEntityExceptionHandler或DefaultHandlerExceptionResolver處理

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

2、返回自定義異常

1、編寫BizException處理代碼

@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、測試返回結果

從上圖可知返回了自定義信息

四、注意事項

1、如果實現自定義異常處理類上使用@RestControllerAdvice注解方法上使用@ExceptionHandler來處理特定的異常

2、ResponseEntityExceptionHandler默認處理那些異常

3、使用了ResponseEntityExceptionHandler后，為什么發生了異常后返回體為空

默認情況下，實現了 ResponseEntityExceptionHandler這個類后，這個類處理的所有異常的響應結果都是 null，如果想返回別的值需要我們自己去處理。

關于“SpringBoot中異常處理實例分析”的內容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業相關的知識，可以關注億速云行業資訊頻道，小編每天都會為大家更新不同的知識點。