SpringBoot全局異常處理之解決404/500錯誤

更新時間：2023年11月11日 12:05:35 作者：CN-ZHANG

在搭建項目框架的時候用的是springboot,想統(tǒng)一處理異常,但是發(fā)現(xiàn)404的錯誤總是捕捉不到,總是返回的是springBoot自帶的錯誤結(jié)果信息,這篇文章主要給大家介紹了關于SpringBoot全局異常處理之解決404/500錯誤的相關資料,需要的朋友可以參考下

前言

SpringBoot要全局處理 Spring Boot 應用程序中的 HTTP 404 和 500 錯誤，您可以自定義一個異常處理器類，并使用 @ControllerAdvice 和 @ExceptionHandler 注釋來攔截和處理這些異常。

解決方案

下面是一種可能的實現(xiàn)方式，它捕獲HTTP GET請求中PathVariable參數(shù)類型不匹配、參數(shù)格式錯誤以及其他所有未處理的異常，并返回一個包含錯誤代碼和錯誤消息的 Map 對象：

@ControllerAdvice
public class GlobalExceptionHandler {
     
    // 捕獲 PathVariable 參數(shù)類型不匹配或格式錯誤的異常，并返回錯誤信息
    @ExceptionHandler(MethodArgumentTypeMismatchException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ResponseBody
    public Map<String, Object> handleMethodArgumentTypeMismatchException(MethodArgumentTypeMismatchException ex) {
        return createErrorResponse(HttpStatus.BAD_REQUEST.value(), "請求參數(shù)有誤: " + ex.getMessage());
    }
 
    // 捕獲其他未處理的異常，并返回錯誤信息
    @ExceptionHandler(Exception.class)
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ResponseBody
    public Map<String, Object> handleUncaughtException(Exception ex) {
        return createErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR.value(), "系統(tǒng)內(nèi)部錯誤: " + ex.getMessage());
    }
 
    // 創(chuàng)建包含錯誤碼和錯誤消息的 Map 對象
    private Map<String, Object> createErrorResponse(int code, String message) {
        Map<String, Object> errorResponse = new HashMap<>();
        errorResponse.put("code", code);
        errorResponse.put("message", message);
        return errorResponse;
    }
}

說明：

在此示例中:

使用 @ControllerAdvice 和 @ExceptionHandler 注釋標識此類為全局異常處理程序，并捕獲了 MethodArgumentTypeMismatchException 和任何其他未處理的異常。
使用 @ResponseStatus(HttpStatus.BAD_REQUEST) 和 @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) 來指定異常的 HTTP 響應狀態(tài)碼。
使用@ResponseBody注釋來告訴 Spring Boot 應用程序，我們不想呈現(xiàn)采用模板引擎進行渲染的視圖，而是返回具體的響應正文對象。
createErrorResponse() 方法創(chuàng)建并返回包含錯誤代碼和錯誤消息的 Map 對象。

通用的全局異常處理

@ControllerAdvice
public class GlobalExceptionHandler {
    
    /**
     * 處理 HTTP 404 錯誤
     */
    @ExceptionHandler(NoHandlerFoundException.class)
    @ResponseStatus(HttpStatus.NOT_FOUND)
    @ResponseBody
    public ApiError handleNotFound(HttpServletRequest req, Exception ex) {
        return new ApiError(HttpStatus.NOT_FOUND.value(), "無該資源: " + req.getRequestURI());
    }
 
    /**
     * 處理 HTTP 500 錯誤
     */
    @ExceptionHandler(Exception.class)
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ResponseBody
    public ApiError handleInternalServerError(HttpServletRequest req, Exception ex) {
        return new ApiError(HttpStatus.INTERNAL_SERVER_ERROR.value(), "服務器內(nèi)部錯誤: " + ex.getMessage());
    }
 
    /**
     * 處理用戶登錄異常
     */
    @ExceptionHandler(UserLoginException.class)
    @ResponseStatus(HttpStatus.UNAUTHORIZED)
    @ResponseBody
    public ApiError handleUserLoginException(HttpServletRequest req, UserLoginException ex) {
        return new ApiError(HttpStatus.UNAUTHORIZED.value(), "用戶登錄失敗: " + ex.getMessage());
    }
 
    /**
     * 處理其他所有未處理的異常
     */
    @ExceptionHandler(Throwable.class)
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ResponseBody
    public ApiError handleOtherExceptions(HttpServletRequest req, Throwable ex) {
        return new ApiError(HttpStatus.INTERNAL_SERVER_ERROR.value(), "系統(tǒng)內(nèi)部錯誤: " + ex.getMessage());
    }
}

觸發(fā)異常

我們在控制器中模擬一個用戶登錄失敗的場景，并將 UserLoginException 拋出：

@RestController
public class UserController {
    
    @Autowired
    private UserService userService;
    
    @PostMapping("/login")
    public String login(@RequestBody LoginForm form) {
        // 驗證用戶名和密碼
        if (!userService.validate(form.getUsername(), form.getPassword())) {
            // 用戶不存在或密碼錯誤，拋出 UserLoginException 異常
            throw new UserLoginException("用戶名或密碼不正確");
        }
         
        // 登錄成功，返回 token 或用戶信息
        // ......
    }
}