Spring Boot 中的默認(rèn)異常處理機(jī)制解析(如 /error 接口)
在 Spring Boot 中,為了簡(jiǎn)化 Web 應(yīng)用的異常處理流程,它提供了一套默認(rèn)的全局異常處理機(jī)制,其中最核心的就是 /error 接口。這個(gè)接口是 Spring Boot 提供的一個(gè)內(nèi)置錯(cuò)誤頁(yè)面控制器(BasicErrorController),用于統(tǒng)一返回錯(cuò)誤信息。
?? 一句話總結(jié):
? Spring Boot 默認(rèn)使用
BasicErrorController來(lái)處理所有未被捕獲的異常,并通過(guò)/error接口返回結(jié)構(gòu)化的錯(cuò)誤響應(yīng)或跳轉(zhuǎn)到錯(cuò)誤頁(yè)面(如 HTML 頁(yè)面)。
?? 一、默認(rèn)行為概覽
| 請(qǐng)求類型 | 返回內(nèi)容 |
|---|---|
| 瀏覽器請(qǐng)求(HTML) | 跳轉(zhuǎn)到 /error 頁(yè)面(如 error.html) |
| API 請(qǐng)求(JSON/REST) | 返回 JSON 格式的錯(cuò)誤信息 |
例如:
- 訪問(wèn)一個(gè)不存在的路徑:
GET /not-found - 控制器拋出未處理的異常 都會(huì)被 Spring Boot 的
/error端點(diǎn)捕獲并處理。
??? 二、核心組件解析
1. BasicErrorController
這是 Spring Boot 默認(rèn)提供的錯(cuò)誤處理器,負(fù)責(zé)處理 /error 請(qǐng)求。
@Controller
@RequestMapping("${server.error.path:${spring.mvc.async.request-timeout}}")
public class BasicErrorController extends AbstractErrorController {
...
}- 默認(rèn)路徑為
/error(可通過(guò)server.error.path配置修改) - 支持兩種響應(yīng)格式:
text/html:返回 HTML 錯(cuò)誤頁(yè)面(如error.html)- 其他格式(如 JSON):返回結(jié)構(gòu)化錯(cuò)誤信息
2. ErrorAttributes 接口
該接口定義了錯(cuò)誤信息的內(nèi)容來(lái)源,包括:
- 異常對(duì)象
- HTTP 狀態(tài)碼
- 請(qǐng)求 URL
- 時(shí)間戳等
默認(rèn)實(shí)現(xiàn)是 DefaultErrorAttributes,你也可以自定義。
3. ErrorViewResolver 接口
用于解析 HTML 錯(cuò)誤頁(yè)面。例如:
/templates/error/404.html/templates/error/5xx.html/templates/error.html
Spring Boot 會(huì)根據(jù)狀態(tài)碼優(yōu)先匹配具體頁(yè)面。
?? 三、默認(rèn)返回的 JSON 錯(cuò)誤結(jié)構(gòu)
當(dāng)你訪問(wèn)一個(gè) REST 接口時(shí),如果發(fā)生異常且沒(méi)有被 @ExceptionHandler 或 @ControllerAdvice 捕獲,Spring Boot 會(huì)返回如下格式的 JSON 響應(yīng):
{
"timestamp": "2025-07-12T10:45:00.000+00:00",
"status": 404,
"error": "Not Found",
"path": "/not-found"
}字段說(shuō)明:
| 字段名 | 含義 |
|---|---|
timestamp | 錯(cuò)誤發(fā)生時(shí)間 |
status | HTTP 狀態(tài)碼 |
error | 錯(cuò)誤描述 |
exception | 異常類名(僅當(dāng) spring.boot.debug=true 時(shí)顯示) |
message | 異常消息(可選) |
path | 出錯(cuò)的請(qǐng)求路徑 |
?? 四、如何自定義錯(cuò)誤處理?
雖然 Spring Boot 提供了默認(rèn)的錯(cuò)誤處理機(jī)制,但在實(shí)際項(xiàng)目中我們通常需要進(jìn)行定制:
1. 方式一:自定義 ErrorAttributes
你可以實(shí)現(xiàn) ErrorAttributes 接口來(lái)自定義錯(cuò)誤信息內(nèi)容:
@Component
public class CustomErrorAttributes extends DefaultErrorAttributes {
@Override
public Map<String, Object> getErrorAttributes(WebRequest webRequest, ErrorAttributeOptions options) {
Map<String, Object> errorMap = super.getErrorAttributes(webRequest, options);
errorMap.put("customInfo", "This is a custom error info.");
return errorMap;
}
}2. 方式二:繼承 BasicErrorController 自定義控制器
@RestController
@RequestMapping("${server.error.path:/error}")
public class CustomErrorController extends BasicErrorController {
public CustomErrorController(ErrorAttributes errorAttributes) {
super(errorAttributes, new ErrorProperties());
}
@Override
public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
Map<String, Object> body = getErrorAttributes(new ServletWebRequest(request), true);
return new ResponseEntity<>(body, HttpStatus.INTERNAL_SERVER_ERROR);
}
}3. 方式三:創(chuàng)建自定義錯(cuò)誤頁(yè)面(HTML)
將 HTML 頁(yè)面放在以下位置之一即可:
src/main/resources/templates/error/404.htmlsrc/main/resources/static/error/500.htmlsrc/main/resources/public/error.html
Spring Boot 會(huì)根據(jù) HTTP 狀態(tài)碼自動(dòng)選擇對(duì)應(yīng)的頁(yè)面。
4. 方式四:使用 @ControllerAdvice 全局處理異常
@RestControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(Exception.class)
public ResponseEntity<Map<String, Object>> handleException(Exception ex, HttpServletRequest request) {
Map<String, Object> errorBody = new HashMap<>();
errorBody.put("error", ex.getMessage());
errorBody.put("path", request.getRequestURI());
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(errorBody);
}
}這種方式比默認(rèn)機(jī)制更靈活,適用于大型項(xiàng)目。
?? 五、配置相關(guān)屬性(application.yml)
你可以在 application.yml 或 application.properties 中配置一些與錯(cuò)誤相關(guān)的參數(shù):
spring:
mvc:
async:
request-timeout: 0 # 禁用超時(shí)控制
server:
error:
path: /my-error # 自定義錯(cuò)誤路徑
whitelabel:
enabled: false # 關(guān)閉默認(rèn)白標(biāo)錯(cuò)誤頁(yè)? 六、總結(jié)
| 項(xiàng)目 | 內(nèi)容 |
|---|---|
| 默認(rèn)錯(cuò)誤端點(diǎn) | /error |
| 默認(rèn)控制器 | BasicErrorController |
| 默認(rèn)錯(cuò)誤信息 | DefaultErrorAttributes |
| 默認(rèn)視圖支持 | 支持 HTML 錯(cuò)誤頁(yè)面(按狀態(tài)碼命名) |
| JSON 輸出格式 | 包含 timestamp, status, error, path 等字段 |
| 可擴(kuò)展性 | 支持自定義 ErrorAttributes、ErrorController、HTML 頁(yè)面、@ControllerAdvice |
到此這篇關(guān)于Spring Boot 中的默認(rèn)異常處理機(jī)制(如 /error 接口)的文章就介紹到這了,更多相關(guān)Spring Boot 異常處理內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Java實(shí)現(xiàn)非對(duì)稱加密的三種方法
本文主要介紹了Java實(shí)現(xiàn)非對(duì)稱加密的三種方法,主要包括非對(duì)稱加密算法--DH(密鑰交換),非對(duì)稱加密算法--RSA,非對(duì)稱加密算法--EIGamal,具有一定的參考價(jià)值,感興趣的可以了解一下2023-12-12
SpringCloud之注冊(cè)中心之Nacos負(fù)載均衡詳解
Nacos提供多種負(fù)載均衡策略,包括權(quán)重、同機(jī)房、同地域、同環(huán)境等,服務(wù)下線和權(quán)重配置可以通過(guò)Nacos管理界面進(jìn)行,同時(shí),Nacos使用Raft算法選舉Leader節(jié)點(diǎn),若IP地址改變可能會(huì)影響Leader選舉,配置同集群優(yōu)先訪問(wèn)可以提高訪問(wèn)速度,通過(guò)配置集群名稱和負(fù)載均衡策略2025-03-03
常用json與javabean互轉(zhuǎn)的方法實(shí)現(xiàn)
這篇文章主要介紹了常用json與javabean互轉(zhuǎn)的方法實(shí)現(xiàn),文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2021-04-04
基于SpringBoot實(shí)現(xiàn)大文件分塊上傳功能
這篇文章主要介紹了基于SpringBoot實(shí)現(xiàn)大文件分塊上傳功能,實(shí)現(xiàn)原理其實(shí)很簡(jiǎn)單,核心就是客戶端把大文件按照一定規(guī)則進(jìn)行拆分,比如20MB為一個(gè)小塊,分解成一個(gè)一個(gè)的文件塊,然后把這些文件塊單獨(dú)上傳到服務(wù)端,需要的朋友可以參考下2024-09-09

