在現代的Web應用程式中，異常處理是確保應用程式穩定性和使用者滿意度的關鍵部分。無論是由於使用者輸入錯誤、系統故障還是其他原因，異常都可能在應用程式中發生。因此，有效的異常處理對於診斷問題、提高使用者體驗以及確保應用程式的可維護性至關重要。
本文將深入探討Spring Boot中的異常處理，特別是如何實現統一異常處理。統一異常處理是一種將異常處理邏輯集中管理的方法，使得應用程式的異常響應更加一致和可控。通過本文，您將學習如何在Spring Boot應用程式中建立強大的異常處理機制，從而更好地應對各種異常情況。
在本文中，我們將涵蓋以下主要內容：
@ControllerAdvice和@ExceptionHandler註解來處理各種異常情況。我們將提供示例程式碼，演示如何編寫通用的異常處理邏輯。異常處理是任何Web應用程式的關鍵組成部分。在Spring Boot中，異常處理是一個基本概念，確保應用程式在出現問題時能夠適當地響應和處理異常情況。
異常是指在應用程式執行期間發生的不正常情況。這些情況可能包括使用者提供的無效數據、資源不可用、網路問題、資料庫錯誤等。在Java中，異常通常是Throwable類或其子類的實例。
Spring Boot異常處理的基本概念如下：
Spring Boot使用注解驅動的方式來處理異常，這意味著您可以使用注解來標記方法，以指定它們用於處理特定類型的異常。以下是異常處理的工作原理：
Spring Boot提供了一個默認的異常處理機制，它會處理一些常見的異常情況，如404（資源未找到）和500（伺服器內部錯誤）。默認的異常處理器通常會生成一個包含錯誤訊息的HTML頁面，以向使用者顯示錯誤。
然而，對於許多應用程式來說，這種默認行為可能不夠滿足要求。通常，開發人員希望能夠自訂異常處理邏輯，以便更好地適應其應用程式的需求。這正是Spring Boot中統一異常處理的優勢所在，它允許開發人員完全掌控異常處理過程。
在許多應用程式中，異常處理程式碼散落在各個部分，不統一地處理異常。這種做法可能導致以下問題：
統一異常處理的目標是將異常處理邏輯集中管理，使其更易於維護、擴展和診斷。它使開發人員能夠在整個應用程式中實施一致的異常處理策略，從而提高了程式碼的可讀性和可維護性。
在接下來的部分，我們將深入研究如何在Spring Boot應用程式中創建統一異常處理器，並為不同類型的異常定義自訂處理邏輯。
在Spring Boot中，我們可以通過建立自定義的異常處理器來實現統一的異常處理。這些自定義處理器可以捕獲和處理應用程式中拋出的異常，並採取適當的措施來回應這些異常，例如記錄日誌、返回自定義錯誤信息或重新導向到錯誤頁面。
@ControllerAdvice註解要建立一個自定義的異常處理器，我們可以使用@ControllerAdvice註解。這個註解告訴Spring Boot，這個類是一個全局的異常處理器，可以處理整個應用程式中拋出的異常。
@ControllerAdvice
public class GlobalExceptionHandler {
// 異常處理邏輯
}
@ExceptionHandler註解在自定義的異常處理器類中，我們可以使用@ExceptionHandler註解來標記處理特定異常的方法。這些方法將捕獲與註解中指定的異常類型匹配的異常，並執行自定義的處理邏輯。
@ControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(MyCustomException.class)
public ResponseEntity<String> handleCustomException(MyCustomException ex) {
// 處理自定義異常
return new ResponseEntity<>(ex.getMessage(), HttpStatus.BAD_REQUEST);
}
}
在上面的示例中，handleCustomException方法捕獲MyCustomException類型的異常，並返回一個包含錯誤消息的HTTP響應。您可以根據需要定義多個@ExceptionHandler方法來處理不同類型的異常。
以下是一個示例程式碼片段，演示了如何編寫通用的異常處理邏輯，以捕獲並記錄所有異常：
@ControllerAdvice
public class GlobalExceptionHandler {
private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);
@ExceptionHandler(Exception.class)
public ResponseEntity<ErrorResponse> handleException(Exception ex) {
// 創建自定義錯誤響應
ErrorResponse errorResponse = new ErrorResponse("Internal Server Error", ex.getMessage());
// 記錄異常信息
logger.error("An error occurred: " + ex.getMessage(), ex);
// 返回通用錯誤消息
return new ResponseEntity<>(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
}
@ExceptionHandler(ResourceNotFoundException.class)
public ResponseEntity<ErrorResponse> handleResourceNotFoundException(ResourceNotFoundException ex) {
// 創建自定義錯誤響應
ErrorResponse errorResponse = new ErrorResponse("Resource Not Found", ex.getMessage());
// 記錄異常信息
logger.error("Resource not found: {}", ex.getMessage());
// 返回通用錯誤消息
return new ResponseEntity<>(errorResponse, HttpStatus.NOT_FOUND);
}
// 更多異常處理方法...
}
在這個示例中，handleException方法捕獲任何類型的異常，並記錄異常信息到日誌中。它返回一個通用的HTTP 500錯誤響應，以指示發生了內部伺服器錯誤。
通過使用@ControllerAdvice和@ExceptionHandler註解，我們可以輕鬆地建立強大的統一異常處理器，確保應用程式能夠適當地回應各種異常情況。接下來，我們將探討如何規範化異常響應的數據結構。
在我們的 Spring Boot 應用程式中，統一的異常處理機制不僅關乎如何處理異常，還關乎如何向客戶端返回具有一致結構的錯誤信息。這種統一的返回結構使客戶端能夠更容易地理解和處理錯誤，同時提高了 API 的可用性。
為了實現統一的返回結構，我們通常使用 DTO（數據傳輸物件）來封裝錯誤信息。一個典型的錯誤 DTO 可能包括以下屬性：
timestamp：錯誤的發生時間戳。status：HTTP 狀態碼，指示錯誤的類型，例如 404 表示“未找到”。error：錯誤的標題，簡要描述錯誤類型，例如“Not Found”。message：錯誤的具體信息，通常包括有關錯誤原因的詳細描述。path：請求的路徑，用於指示引起錯誤的請求是哪個。@Data //Lombok註解，詳細介紹在此系列第8天的文章
public class ErrorDto {
private LocalDateTime timestamp;
private int status;
private String error;
private String message;
private String path;
一旦我們定義了這樣的 DTO，我們可以在我們的統一異常處理器中使用它來封裝錯誤信息。這樣，無論發生什麼類型的異常，我們都可以將它轉換為統一的結構，並將其返回給客戶端。
@RestControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(Exception.class)
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
public ErrorDto handleGlobalException(Exception ex, HttpServletRequest request) {
ErrorDto errorDto = new ErrorDto();
errorDto.setTimestamp(LocalDateTime.now());
errorDto.setStatus(HttpStatus.INTERNAL_SERVER_ERROR.value());
errorDto.setError("Internal Server Error");
errorDto.setMessage(ex.getMessage());
errorDto.setPath(request.getRequestURI());
return errorDto;
}
}
@RestControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(Exception.class)
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
public ErrorDto handleGlobalException(Exception ex, HttpServletRequest request) {
ErrorDto errorDto = new ErrorDto();
errorDto.setTimestamp(LocalDateTime.now());
errorDto.setStatus(HttpStatus.INTERNAL_SERVER_ERROR.value());
errorDto.setError("Internal Server Error");
errorDto.setMessage(ex.getMessage());
errorDto.setPath(request.getRequestURI());
return errorDto;
}
}
在這個示例中，我們捕獲了所有類型的異常，並將它們轉換為統一的ErrorDto結構。然後，我們返回這個 DTO，使客戶端能夠簡單地處理錯誤。
通過使用統一的返回結構，我們可以確保客戶端總是收到具有相同結構的錯誤信息，從而簡化了客戶端程式碼的處理邏輯。這種一致性有助於提高 API 的可用性和開發效率。
接下來，我們將深入探討如何對不同類型的異常進行分類和處理，以進一步優化我們的異常處理機制。
iThome鐵人賽
看影片追技術