快捷導(dǎo)航

SpringMVC @ExceptionHandler典型用法及說明

更新時間：2026年04月16日 14:38:28 作者：張紫娃

文章介紹了Spring中的異常處理機制,包括處理單個和多個異常類型的方法,返回結(jié)構(gòu)化錯誤信息的推薦做法,以及處理所有異常的兜底方法,另外,還提到了@ExceptionHandler方法的多種返回類型

處理單個異常類型

當(dāng) getUser() 方法拋出 UserNotFoundException 時，會自動調(diào)用 handleUserNotFound() 方法進行處理。

@RestController
@RequestMapping("/users")
public class UserController {

    @GetMapping("/{id}")
    public User getUser(@PathVariable Long id) {
        // 可能拋出 UserNotFoundException
        return userService.getUserById(id);
    }

    @ExceptionHandler(UserNotFoundException.class)
    public ResponseEntity<String> handleUserNotFound(UserNotFoundException ex) {
        return ResponseEntity.status(HttpStatus.NOT_FOUND).body(ex.getMessage());
    }
}

處理多個異常類型

一個 @ExceptionHandler 方法可以處理多個異常類型：

@ExceptionHandler({IllegalArgumentException.class, ResourceNotFoundException.class})
public ResponseEntity<String> handleClientErrors(RuntimeException ex) {
    return ResponseEntity.status(HttpStatus.BAD_REQUEST).body("客戶端錯誤: " + ex.getMessage());
}

結(jié)合 @ResponseStatus 使用（返回指定狀態(tài)碼）

此時返回值直接作為響應(yīng)體，HTTP 狀態(tài)碼由 @ResponseStatus 指定。

@ExceptionHandler(ResourceNotFoundException.class)
@ResponseStatus(HttpStatus.NOT_FOUND)
public String handleResourceNotFound(ResourceNotFoundException ex) {
    return ex.getMessage();
}

返回結(jié)構(gòu)化錯誤信息（推薦做法）

@ExceptionHandler(UserNotFoundException.class)
public ResponseEntity<ErrorResponse> handleUserNotFound(UserNotFoundException ex) {
    ErrorResponse error = new ErrorResponse(HttpStatus.NOT_FOUND.value(), ex.getMessage(), LocalDateTime.now());
    return ResponseEntity.status(HttpStatus.NOT_FOUND).body(error);
}

// ErrorResponse 示例類
@Data
@NoArgsConstructor
@AllArgsConstructor
public class ErrorResponse {
    private int status;
    private String message;
    private LocalDateTime timestamp;
}

捕獲所有異常（兜底處理）

注意順序：

更具體的異常應(yīng)放在前面，避免被 Exception.class 攔截。

@ExceptionHandler(Exception.class)
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
public ErrorResponse handleAllExceptions(Exception ex) {
    return new ErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR.value(), "系統(tǒng)內(nèi)部錯誤", ex.getMessage(), LocalDateTime.now());
}

不同返回類型

@ExceptionHandler 方法可以有多種返回類型，如 String, ResponseEntity, Map, 自定義 DTO 等。

@RestController
@RequestMapping("/users")
public class UserController {

    @GetMapping("/{id}")
    public User getUser(@PathVariable Long id) {
        if (id == null || id <= 0) {
            throw new IllegalArgumentException("用戶 ID 不合法");
        }
        // ...
    }

    @ExceptionHandler(IllegalArgumentException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public String handleIllegalArgument(IllegalArgumentException ex) {
        return "參數(shù)錯誤：" + ex.getMessage();
    }

    @ExceptionHandler(UserNotFoundException.class)
    public ResponseEntity<ErrorResponse> handleUserNotFound(UserNotFoundException ex) {
        ErrorResponse error = new ErrorResponse(404, ex.getMessage(), LocalDateTime.now());
        return ResponseEntity.status(HttpStatus.NOT_FOUND).body(error);
    }

    @ExceptionHandler(Exception.class)
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    public ErrorResponse handleAllExceptions(Exception ex) {
        return new ErrorResponse(500, "系統(tǒng)錯誤", ex.getMessage(), LocalDateTime.now());
    }
}