SpringMVC通過注解實現(xiàn)全局異常處理問題小結(jié)
一、為什么需要全局異常處理?
開發(fā)應(yīng)用程序的過程中會遇到各種各樣的異常,如數(shù)據(jù)庫連接異常,網(wǎng)絡(luò)請求異常和業(yè)務(wù)邏輯異常等。傳統(tǒng)的try-catch模式在各個controller中處理由于太過于分散,代碼冗余度過高,導(dǎo)致維護成本過高。
全局處理能夠高效地解決這一問題
二、Spring全局異常的處理方式
SpringMVC通過@ControllerAdvice和@ExceptionHandler注解來實現(xiàn)全局異常處理
實現(xiàn)步驟:
1 創(chuàng)建自定義異常類
2 創(chuàng)建全局異常處理器,使用@ControllerAdvice注解
3 在處理器類中定義異常處理方法,使用@ExceptionHandler注解指定處理的異常類型
4 在異常處理方法中定義異常響應(yīng)的格式和內(nèi)容
三、具體實現(xiàn)
1 創(chuàng)建自定義異常類(以用戶未找到為例)
// 用戶未找到異常
public class UserNotFoundException extends RuntimeException {
public UserNotFoundException() {
super();
}
public UserNotFoundException(String message) {
super(message);
}
}
// 數(shù)據(jù)驗證異常
public class ValidationException extends RuntimeException {
public ValidationException(String message) {
super(message);
}
}2 創(chuàng)建全局異常處理器
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResponseStatus;
// 全局異常處理器,會攔截所有控制器拋出的異常
@ControllerAdvice
public class GlobalExceptionHandler {
// 處理用戶未找到異常
@ExceptionHandler(UserNotFoundException.class)
@ResponseBody // 將返回結(jié)果轉(zhuǎn)換為JSON
@ResponseStatus(HttpStatus.NOT_FOUND) // 設(shè)置HTTP狀態(tài)碼為404
public Result<Void> handleUserNotFoundException(UserNotFoundException e) {
return Result.error(404, e.getMessage());
}
// 處理數(shù)據(jù)驗證異常
@ExceptionHandler(ValidationException.class)
@ResponseBody
@ResponseStatus(HttpStatus.BAD_REQUEST) // 設(shè)置HTTP狀態(tài)碼為400
public Result<Void> handleValidationException(ValidationException e) {
return Result.error(400, e.getMessage());
}
// 處理其他未捕獲的異常
@ExceptionHandler(Exception.class)
@ResponseBody
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) // 設(shè)置HTTP狀態(tài)碼為500
public Result<Void> handleOtherExceptions(Exception e) {
// 實際項目中可以在這里記錄日志
return Result.error(500, "服務(wù)器內(nèi)部錯誤:" + e.getMessage());
}
}3 在控制器中使用
@RestController
@RequestMapping("/users")
public class UserController {
@Autowired
private UserService userService;
@GetMapping("/{id}")
public Result<User> getUser(@PathVariable Long id) {
// 這里不再需要try-catch,異常會被全局異常處理器捕獲
User user = userService.getUserById(id);
if (user == null) {
throw new UserNotFoundException("用戶不存在,ID: " + id);
}
return Result.success(user);
}
@PostMapping
public Result<User> createUser(@RequestBody User user) {
if (user.getName() == null || user.getName().isEmpty()) {
throw new ValidationException("用戶名不能為空");
}
User savedUser = userService.saveUser(user);
return Result.success(savedUser);
}
}四、工作原理
- 當(dāng)控制器方法中拋出異常時,Spring 會查找是否有匹配的
@ExceptionHandler @ControllerAdvice注解的類會被 Spring 掃描到,并作為全局異常處理器- Spring 會根據(jù)拋出的異常類型,找到對應(yīng)的
@ExceptionHandler方法 - 執(zhí)行異常處理方法,返回統(tǒng)一的響應(yīng)結(jié)果
五、高級用法
- 異常處理的優(yōu)先級:
- 控制器內(nèi)部的
@ExceptionHandler優(yōu)先于全局異常處理器 - 子類異常的處理器優(yōu)先于父類異常的處理器
- 控制器內(nèi)部的
- 結(jié)合日志記錄:
@ExceptionHandler(Exception.class)
public Result<Void> handleOtherExceptions(Exception e) {
log.error("發(fā)生未捕獲異常", e); // 記錄異常日志
return Result.error(500, "服務(wù)器內(nèi)部錯誤");
}六、總結(jié)
全局異常處理是 SpringMVC框架中一個非常實用的功能,通過@ControllerAdvice和@ExceptionHandler注解可以輕松實現(xiàn):
- 減少重復(fù)代碼,提高開發(fā)效率
- 統(tǒng)一異常響應(yīng)格式,便于前端處理
- 集中管理異常處理邏輯,便于維護
- 可以結(jié)合日志記錄,方便問題排查
掌握全局異常處理,能讓你的代碼更加健壯、優(yōu)雅。
到此這篇關(guān)于SpringMVC通過注解實現(xiàn)全局異常處理問題小結(jié)的文章就介紹到這了,更多相關(guān)SpringMVC全局異常處理內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
@FeignClient注解中屬性contextId的使用說明
這篇文章主要介紹了@FeignClient注解中屬性contextId的使用說明,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2022-06-06
使用Spring boot + jQuery上傳文件(kotlin)功能實例詳解
本文通過實例代碼給大家介紹了使用Spring boot + jQuery上傳文件(kotlin) 功能,需要的朋友可以參考下2017-07-07
Mybatis SqlSessionFactory與SqlSession詳細講解
SqlSessionFactory是MyBatis的核心類之一,其最重要的功能就是提供創(chuàng)建MyBatis的核心接口SqlSession,所以我們需要先創(chuàng)建SqlSessionFactory,為此我們需要提供配置文件和相關(guān)的參數(shù)2022-11-11
解決Java項目啟動報錯:Logback?configuration?error?detected:問題
這篇文章主要介紹了解決Java項目啟動報錯:Logback?configuration?error?detected:問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-04-04
MyBatis結(jié)果映射(ResultMap)的使用
在MyBatis中,結(jié)果映射是實現(xiàn)數(shù)據(jù)庫結(jié)果集到Java對象映射的核心,它不僅支持簡單的字段映射,還能處理字段名不一致、嵌套對象和集合映射等復(fù)雜場景,通過ResultMap,開發(fā)者可以靈活定義映射關(guān)系,以適應(yīng)各種需求,感興趣的可以了解一下2024-09-09

