SpringBoot定制三種錯誤頁面及錯誤數(shù)據(jù)方法示例
我們知道 Spring Boot 已經(jīng)提供了一套默認的異常處理機制，但是 Spring Boot 提供的默認異常處理機制卻并不一定適合我們實際的業(yè)務(wù)場景，因此，我們通常會根據(jù)自身的需要對 Spring Boot 全局異常進行統(tǒng)一定制，例如定制錯誤頁面，定制錯誤數(shù)據(jù)等。
定制錯誤頁面
我們可以通過以下 3 種方式定制 Spring Boot 錯誤頁面：
- 自定義 error.html
- 自定義動態(tài)錯誤頁面
- 自定義靜態(tài)錯誤頁面
自定義 error.html
我們可以直接在模板引擎文件夾（/resources/templates）下創(chuàng)建 error.html ，覆蓋 Spring Boot 默認的錯誤視圖頁面（Whitelabel Error Page）。
示例 1
1. 在 spring-boot-adminex 的模板引擎文件夾（classpath:/resources/templates）下，創(chuàng)建一個 error.html，代碼如下。
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>自定義 error.html</title>
</head>
<body>
<h1>自定義 error.html</h1>
<p>status：<span th:text="${status}"></span></p>
<p>error：<span th:text="${error}"></span></p>
<p>timestamp：<span th:text="${timestamp}"></span></p>
<p>message：<span th:text="${message}"></span></p>
<p>path：<span th:text="${path}"></span></p>
</body>
</html>
2. 啟動 Spring Boot，在完成登陸跳轉(zhuǎn)到主頁后，使用瀏覽器地訪問“http://localhost:8080/111”，結(jié)果如下圖。
圖1：自定義 error.html
由圖 1 可以看出，Spring Boot 使用了我們自定義的 error.html 覆蓋了默認的錯誤視圖頁面（Whitelabel Error Page）。
自定義動態(tài)錯誤頁面
如果 Sprng Boot 項目使用了模板引擎，當程序發(fā)生異常時，Spring Boot 的默認錯誤視圖解析器（DefaultErrorViewResolver）就會解析模板引擎文件夾（resources/templates/）下 error 目錄中的錯誤視圖頁面。
精確匹配
我們可以根據(jù)錯誤狀態(tài)碼（例如 404、500、400 等等）的不同，分別創(chuàng)建不同的動態(tài)錯誤頁面（例如 404.html、500.html、400.html 等等），并將它們存放在模板引擎文件夾下的 error 目錄中。當發(fā)生異常時，Spring Boot 會根據(jù)其錯誤狀態(tài)碼精確匹配到對應(yīng)的錯誤頁面上。
示例 2
1. 在 spring-boot-adminex 的模板引擎文件夾下 error 目錄中，創(chuàng)建一個名為 404.html 的錯誤頁面，代碼如下。
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title></title>
</head>
<body>
<h1>自定義動態(tài)錯誤頁面 404.html</h1>
<p>status：<span th:text="${status}"></span></p>
<p>error：<span th:text="${error}"></span></p>
<p>timestamp：<span th:text="${timestamp}"></span></p>
<p>message：<span th:text="${message}"></span></p>
<p>path：<span th:text="${path}"></span></p>
</body>
</html>
2. 啟動 Spring Boot，在完成登陸跳轉(zhuǎn)到主頁后，在瀏覽器地址欄輸入“http://localhost:8080/111”，結(jié)果如下圖。
圖2：自定義動態(tài)錯誤頁面（精確匹配）
模糊匹配
我們還可以使用 4xx.html 和 5xx.html? 作為動態(tài)錯誤頁面的文件名，并將它們存放在模板引擎文件夾下的 error 目錄中，來模糊匹配對應(yīng)類型的所有錯誤，例如 404、400 等錯誤狀態(tài)碼以“4”開頭的所有異常，都會解析到動態(tài)錯誤頁面 4xx.html 上。
示例 3
在 spring-boot-adminex 的模板引擎文件夾下 error 目錄中，創(chuàng)建一個名為 4xx.html 的錯誤頁面，代碼如下。
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title></title>
</head>
<body>
<h1>自定義動態(tài)錯誤頁面 4xx.html</h1>
<p>status：<span th:text="${status}"></span></p>
<p>error：<span th:text="${error}"></span></p>
<p>timestamp：<span th:text="${timestamp}"></span></p>
<p>message：<span th:text="${message}"></span></p>
<p>path：<span th:text="${path}"></span></p>
</body>
</html>
2. 啟動 Spring Boot，在完成登陸跳轉(zhuǎn)到主頁后，使用瀏覽器訪問“http://localhost:8080/111”，結(jié)果如下圖。
圖3：自定義動態(tài)錯誤頁面（模糊匹配）
自定義靜態(tài)錯誤頁面
若 Sprng Boot 項目沒有使用模板引擎，當程序發(fā)生異常時，Spring Boot 的默認錯誤視圖解析器（DefaultErrorViewResolver）則會解析靜態(tài)資源文件夾下 error 目錄中的靜態(tài)錯誤頁面。
精確匹配
我們可以根據(jù)錯誤狀態(tài)碼（例如 404、500、400 等等）的不同，分別創(chuàng)建不同的靜態(tài)錯誤頁面（例如 404.html、500.html、400.html 等等），并將它們存放在靜態(tài)資源文件夾下的 error 目錄中。當發(fā)生異常時，Spring Boot 會根據(jù)錯誤狀態(tài)碼精確匹配到對應(yīng)的錯誤頁面上。
示例 4
1. 在 spring-boot-adminex 的靜態(tài)資源文件夾 src/recources/static 下的 error 目錄中，創(chuàng)建一個名為 404.html 的靜態(tài)錯誤頁面，代碼如下。
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title></title>
</head>
<body>
<h1>自定義靜態(tài)錯誤頁面 404.html</h1>
<p>status：<span th:text="${status}"></span></p>
<p>error：<span th:text="${error}"></span></p>
<p>timestamp：<span th:text="${timestamp}"></span></p>
<p>message：<span th:text="${message}"></span></p>
<p>path：<span th:text="${path}"></span></p>
</body>
</html>
2. 啟動 Spring Boot，在完成登陸跳轉(zhuǎn)到主頁后，使用瀏覽器訪問“http://localhost:8080/111”，結(jié)果如下圖。
圖3：自定義靜態(tài)錯誤頁面（精確匹配）
由于該錯誤頁為靜態(tài)頁面，無法識別 Thymeleaf 表達式，因此無法展示與錯誤相關(guān)的錯誤信息。
模糊匹配
我們還可以使用 4xx.html 和 5xx.html 作為靜態(tài)錯誤頁面的文件名，并將它們存放在靜態(tài)資源文件夾下的 error 目錄中，來模糊匹配對應(yīng)類型的所有錯誤，例如 404、400 等錯誤狀態(tài)碼以“4”開頭的所有錯誤，都會解析到靜態(tài)錯誤頁面 4xx.html 上。
示例 3
在 spring-boot-adminex 的模板引擎文件夾下的 error 目錄中，創(chuàng)建一個名為 4xx.html 的錯誤頁面，代碼如下。
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title></title>
</head>
<body>
<h1>自定義靜態(tài)錯誤頁面 4xx.html</h1>
<p>status：<span th:text="${status}"></span></p>
<p>error：<span th:text="${error}"></span></p>
<p>timestamp：<span th:text="${timestamp}"></span></p>
<p>message：<span th:text="${message}"></span></p>
<p>path：<span th:text="${path}"></span></p>
</body>
</html>
2. 啟動 Spring Boot，在完成登陸跳轉(zhuǎn)到主頁后，使用瀏覽器訪問“http://localhost:8080/111”，結(jié)果如下圖。
圖3：自定義靜態(tài)錯誤頁面（模糊匹配）
錯誤頁面優(yōu)先級
以上 5 種方式均可以定制 Spring Boot 錯誤頁面，且它們的優(yōu)先級順序為：自定義動態(tài)錯誤頁面（精確匹配）>自定義靜態(tài)錯誤頁面（精確匹配）>自定義動態(tài)錯誤頁面（模糊匹配）>自定義靜態(tài)錯誤頁面（模糊匹配）>自定義 error.html。
當遇到錯誤時，Spring Boot 會按照優(yōu)先級由高到低，依次查找解析錯誤頁，一旦找到可用的錯誤頁面，則直接返回客戶端展示。
定制錯誤數(shù)據(jù)
我們知道，Spring Boot 提供了一套默認的異常處理機制，其主要流程如下：
- 發(fā)生異常時，將請求轉(zhuǎn)發(fā)到“/error”，交由 BasicErrorController（Spring Boot 默認的 Error 控制器） 進行處理；
- BasicErrorController 根據(jù)客戶端的不同，自動適配返回的響應(yīng)形式，瀏覽器客戶端返回錯誤頁面，機器客戶端返回 JSON 數(shù)據(jù)。
- BasicErrorController 處理異常時，會調(diào)用 DefaultErrorAttributes（默認的錯誤屬性處理工具） 的 getErrorAttributes() 方法獲取錯誤數(shù)據(jù)。
我們還可以定制 Spring Boot 的錯誤數(shù)據(jù)，具體步驟如下。
- 自定義異常處理類，將請求轉(zhuǎn)發(fā)到 “/error”，交由 Spring Boot 底層（BasicErrorController）進行處理，自動適配瀏覽器客戶端和機器客戶端。
- 通過繼承 DefaultErrorAttributes 來定義一個錯誤屬性處理工具，并在原來的基礎(chǔ)上添加自定義的錯誤數(shù)據(jù)。
1. 自定義異常處理類
被 @ControllerAdvice 注解的類可以用來實現(xiàn)全局異常處理，這是 Spring MVC 中提供的功能，在 Spring Boot 中可以直接使用。
1）在 net.biancheng.net.exception 包內(nèi)，創(chuàng)建一個名為 UserNotExistException 的異常類，代碼如下。
package net.biancheng.www.exception;
/**
* 自定義異常
*/
public class UserNotExistException extends RuntimeException {
public UserNotExistException() {
super("用戶不存在！");
}
}
2）在 IndexController 添加以下方法，觸發(fā) UserNotExistException 異常，代碼如下。
@Controller
public class IndexController {
......
@GetMapping(value = {"/testException"})
public String testException(String user) {
if ("user".equals(user)) {
throw new UserNotExistException();
}
//跳轉(zhuǎn)到登錄頁 login.html
return "login";
}
}
3）在 net.biancheng.www.controller 中，創(chuàng)建一個名為 MyExceptionHandler 異常處理類，代碼如下。
package net.biancheng.www.controller;
import net.biancheng.www.exception.UserNotExistException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import javax.servlet.http.HttpServletRequest;
import java.util.HashMap;
import java.util.Map;
@ControllerAdvice
public class MyExceptionHandler {
@ExceptionHandler(UserNotExistException.class)
public String handleException(Exception e, HttpServletRequest request) {
Map<String, Object> map = new HashMap<>();
//向 request 對象傳入錯誤狀態(tài)碼
request.setAttribute("javax.servlet.error.status_code",500);
//根據(jù)當前處理的異常，自定義的錯誤數(shù)據(jù)
map.put("code", "user.notexist");
map.put("message", e.getMessage());
//將自定的錯誤數(shù)據(jù)傳入 request 域中
request.setAttribute("ext",map);
return "forward:/error";
}
}
2. 自定義錯誤屬性處理工具
1）在 net.biancheng.www.componet 包內(nèi)，創(chuàng)建一個錯誤屬性處理工具類 MyErrorAttributes（繼承 DefaultErrorAttributes ），通過該類我們便可以添加自定義的錯誤數(shù)據(jù)，代碼如下。
package net.biancheng.www.componet;
import org.springframework.boot.web.error.ErrorAttributeOptions;
import org.springframework.boot.web.servlet.error.DefaultErrorAttributes;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.WebRequest;
import java.util.Map;
//向容器中添加自定義的儲物屬性處理工具
@Component
public class MyErrorAttributes extends DefaultErrorAttributes {
@Override
public Map<String, Object> getErrorAttributes(WebRequest webRequest, ErrorAttributeOptions options) {
Map<String, Object> errorAttributes = super.getErrorAttributes(webRequest, options);
//添加自定義的錯誤數(shù)據(jù)
errorAttributes.put("company", "www.biancheng.net");
//獲取 MyExceptionHandler 傳入 request 域中的錯誤數(shù)據(jù)
Map ext = (Map) webRequest.getAttribute("ext", 0);
errorAttributes.put("ext", ext);
return errorAttributes;
}
}
2）在 templates/error 目錄下，創(chuàng)建動態(tài)錯誤頁面 5xx.html，代碼如下。
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>自定義 error.html</title>
</head>
<body>
<p>status：<span th:text="${status}"></span></p>
<p>error：<span th:text="${error}"></span></p>
<p>timestamp：<span th:text="${timestamp}"></span></p>
<p>message：<span th:text="${message}"></span></p>
<p>path：<span th:text="${path}"></span></p>
<!--取出定制的錯誤信息-->
<h3>以下為定制錯誤數(shù)據(jù)：</h3>
<p>company：<span th:text="${company}"></span></p>
<p>code：<span th:text="${ext.code}"></span></p>
<p>path：<span th:text="${ext.message}"></span></p>
</body>
</html>
3）啟動 Spring Boot，訪問“http://localhost:8080/testException?user=user”，結(jié)果如下圖。
圖4：定制錯誤數(shù)據(jù)
注意：為了避免攔截器干擾，建議先將攔截器屏蔽掉。?
以上就是SpringBoot自定義三種錯誤頁面及錯誤數(shù)據(jù)方法示例的詳細內(nèi)容，更多關(guān)于SpringBoot 自定義錯誤頁面、錯誤數(shù)據(jù)的資料請關(guān)注腳本之家其它相關(guān)文章！
相關(guān)文章
Java中的static關(guān)鍵字修飾屬性和方法(推薦)
這篇文章主要介紹了Java中的static關(guān)鍵字修飾屬性和方法,包括哪些成員屬性可以被static修飾，靜態(tài)屬性的訪問方法示例詳解，需要的朋友可以參考下2022-04-04
這篇文章主要介紹了java之Object類用法實例,是Java程序設(shè)計中比較重要的概念,以實例的形式對其定義及用法做了較為深入的講解,需要的朋友可以參考下2014-10-10
這篇文章主要介紹了 java批量修改文件名的實現(xiàn)方法的相關(guān)資料,實現(xiàn)批量修改文件下的所有文件的文件名，具有一定的參考價值，需要的朋友可以參考下2017-07-07
Spring+SpringMVC+MyBatis深入學(xué)習(xí)及搭建(三)之MyBatis全局配置文件解析
這篇文章主要介紹了Spring+SpringMVC+MyBatis深入學(xué)習(xí)及搭建(三)之MyBatis全局配置文件解析,需要的朋友可以參考下2017-05-05
Java實現(xiàn)Excel批量導(dǎo)入數(shù)據(jù)
這篇文章主要為大家詳細介紹了Java實現(xiàn)Excel批量導(dǎo)入數(shù)據(jù)，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2020-08-08
java中為何重寫equals時必須重寫hashCode方法詳解
這篇文章主要給大家介紹了關(guān)于java中為什么重寫equals時必須重寫hashCode方法的相關(guān)資料，文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2018-11-11
service層測試較簡單，目前大多數(shù)測試主要是針對public方法進行的。依據(jù)測試方法劃分，可以分為兩種：基于mock的隔離測試和基于dbunit的普通測試2022-12-12
這篇文章主要介紹了Spring boot使用多線程過程步驟解析,文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2020-07-07
這篇文章主要為大家詳細介紹了JavaSE的類和對象，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下，希望能夠給你帶來幫助2022-03-03
下面小編就為大家?guī)硪黄容^排序之快速排序(實例代碼)。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-06-06