Spring Boot：異常處理

Spring Boot

前言
使用自定義錯誤頁面處理異常
使用 @ExceptionHandler 注解處理異常
使用 @ControllerAdvice 注解處理異常
使用配置類處理異常
使用自定義類處理異常

在這里插入圖片描述

前言

在 Spring Boot 中，異常處理是一個重要的部分，可以允許開發者優雅地處理應用程序中可能發生的錯誤和異常。Spring Boot 提供了一套完整的機制來處理異常，包括全局異常處理、特定異常處理以及自定義錯誤頁面等。而當 Spring Boot 應用程序中發生異常時，Spring Boot 默認會提供一個錯誤頁面來顯示錯誤信息。這個默認的錯誤頁面通常包括一個錯誤狀態碼（如 404 或 500 ），一個簡短的錯誤描述，以及一個可選的堆棧跟蹤（這取決于應用程序的配置）。通常情況下，開發者往往傾向于自定義錯誤頁面。下面簡單介紹 Spring Boot 異常處理的方式。
在這里插入圖片描述

使用自定義錯誤頁面處理異常

在 Spring Boot 中，自定義錯誤頁面是一種常用來處理異常的方式，并提供用戶友好的反饋。開發者可以為特定的 HTTP 狀態碼（如404、 500等）創建自定義的錯誤頁面，也可以創建一個通用的錯誤頁面來處理所有未捕獲的異常。

簡單示例：
首先，在 src/main/resources/templates 目錄下創建一個錯誤頁面，名為 Error.html 的 Thymeleaf 視圖模板

<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><title>ErrorDemo</title>
</head><body><h1 th:text="${status}">異常狀態碼</h1><p th:text="${error}">錯誤提示信息</p><p th:if="${message}">異常消息<span th:text="${message}"></span></p><p th:text="exception">錯誤對象</p><p th:text="errors">JSR303數據校驗的異常信息</p><p>Return to <a th:href="@{/}">Home</a>.</p></body>
</html>

然后，創建 Controller 包再創建一個 TestController 類，并創建一個 Test.html

package cn.edu.SpringBootExceptionHandlingDemo.Controller;import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;@Controller
public class TestController {@GetMapping("/Test.html")public String index(){return "Test";}
}

最后，啟動 Spring Boot ，故意觸發異常（如訪問一個不存在的 URL ），以查看自定義錯誤頁面
結果如圖：
在這里插入圖片描述

使用 @ExceptionHandler 注解處理異常

在 Spring 中，@ExceptionHandler 注解允許指定一個方法來處理特定類型的異常。當你在控制器（ Controller ）或全局異常處理類（使用@ControllerAdvice 注解）中使用 @ExceptionHandler 注解時，Spring 會自動將匹配的異常傳遞給相應的方法進行處理。

簡單示例：
首先，在 TestController 類上添加一個數學運算的實現，再使用 @ExceptionHandler 注解指定數字運算類型的異常使用 testError() 方法進行異常處理

package cn.edu.SpringBootExceptionHandlingDemo.Controller;import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.servlet.ModelAndView;@Controller
public class TestController {@GetMapping("/Test.html")public String index(){double math = 20240329/0;return "Test";}// 指定數字運算異常后，使用該方法進行異常處理@ExceptionHandler(value = {java.lang.ArithmeticException.class})public ModelAndView testError(Exception exception){ModelAndView modelAndView = new ModelAndView();modelAndView.addObject("err",exception);// 指定錯誤視圖模板modelAndView.setViewName("ErrorExceptionHandler");return modelAndView;}
}

然后，在 Test.html 上添加運算結果，并創建錯誤視圖模板 ErrorExceptionHandler.html

<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><title>Test</title>
</head>
<body>運算結果為：<p th:text="${math}" />Hello World!!!
</body>
</html>

<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><title>ErrorExceptionHandlerDemo</title>
</head>
<body>異常信息：[[${err}]]
</body>
</html>

最后，啟動 Spring Boot ，打開瀏覽器輸入 http://localhost:8080/Test.html 并按下回車鍵
結果如圖：
在這里插入圖片描述

使用 @ControllerAdvice 注解處理異常

使用 @ExceptionHandler 注解雖然比自定義錯誤頁面更加靈活處理異常，但是只局限于使用該注解的 Controller 類內部上。而使用@ControllerAdvice 注解可以定義一個類來包含多個 @ExceptionHandler 方法，每個方法處理特定類型的異常。這樣，便不需要在每個控制器中重復編寫異常處理邏輯了。

簡單示例：
在 Contoller 包內創建一個 AdviceController 類，將上述 @ExceptionHandler 方法剪切到該位置

package cn.edu.SpringBootExceptionHandlingDemo.Controller;import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.servlet.ModelAndView;@ControllerAdvice
public class AdviceController {// 指定數字運算異常后，使用該方法進行異常處理@ExceptionHandler(value = {java.lang.ArithmeticException.class})public ModelAndView testError(Exception exception){ModelAndView modelAndView = new ModelAndView();modelAndView.addObject("err",exception);// 指定錯誤視圖模板modelAndView.setViewName("ErrorExceptionHandler");return modelAndView;}
}

最后，啟動 Spring Boot ，打開瀏覽器輸入 http://localhost:8080/Test.html 并按下回車鍵
結果一樣，但使用 @ControllerAdvice 注解無需重復編寫異常處理邏輯：
在這里插入圖片描述

使用配置類處理異常

在 Spring 中，SimpleMappingExceptionResolver 是一個方便的異常解析器，可以將特定類型的異常映射到特定的視圖名稱，使得異常處理更加簡單和統一；也可以通過配置類來配置 SimpleMappingExceptionResolver ，以便在應用程序中全局處理異常。

簡單示例：
創建 Configuration 包并在包內創建一個 ErrorConfiguration 配置類，將 AdviceController 類移除或注釋以免影響測試結果

package cn.edu.SpringBootExceptionHandlingDemo.Configuration;import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.handler.SimpleMappingExceptionResolver;import java.util.Properties;@Configuration
public class ErrorConfiguration {@Beanpublic SimpleMappingExceptionResolver simpleMappingExceptionResolver(){SimpleMappingExceptionResolver simpleMappingExceptionResolver = new SimpleMappingExceptionResolver();Properties properties = new Properties();// 異常處理類型、顯示錯誤視圖名稱properties.put("java.lang.ArithmeticException","ErrorExceptionHandler.html");simpleMappingExceptionResolver.setExceptionMappings(properties);// 指定異常信息變量名稱為 err ，默認為 exceptionsimpleMappingExceptionResolver.setExceptionAttribute("err");return simpleMappingExceptionResolver;}
}

最后，啟動 Spring Boot ，打開瀏覽器輸入 http://localhost:8080/Test.html 并按下回車鍵
結果一樣：
在這里插入圖片描述

使用自定義類處理異常

在 Spring Boot 中，也可以創建一個自定義的異常處理器，通常通過實現 HandlerExceptionResolver 接口或繼承 SimpleMappingExceptionResolver 類，并在其中添加自定義邏輯，便可以處理異常。

簡單示例：
接著，在 Configuration 內創建一個 CustomErrorConfiguration 自定義類并實現 HandlerExceptionResolver 接口，將 ErrorConfiguration 配置類和 AdviceController 類移除或注釋以免影響測試結果

package cn.edu.SpringBootExceptionHandlingDemo.Configuration;import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;@Configuration
public class CustomErrorConfiguration implements HandlerExceptionResolver {@Overridepublic ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {ModelAndView modelAndView = new ModelAndView();// 數字運算類型異常if(ex instanceof ArithmeticException){modelAndView.setViewName("ErrorExceptionHandler");}// 異常信息對象modelAndView.addObject("err",ex);return modelAndView;}
}