快捷導(dǎo)航

Spring @ExceptionHandler注解統(tǒng)一異常處理和獲取方法名

更新時(shí)間：2023年09月25日 09:03:22 作者：樓蘭胡楊

這篇文章主要介紹了Spring注解之@ExceptionHandler 統(tǒng)一異常處理和獲取方法名,在實(shí)際項(xiàng)目中,合理使用@ExceptionHandler能夠提高代碼的可維護(hù)性和用戶(hù)體驗(yàn),通過(guò)本文的解析和實(shí)踐,讀者可以更好地理解和掌握@ExceptionHandler的用法和原理

摘要：

在 Spring Boot 中，使用Spring注解@ControllerAdvice 和 @ExceptionHandler 統(tǒng)一處理異常，并捕獲方法名，從而快速定位錯(cuò)誤原因。

背景分析

最近走查線上環(huán)境日志時(shí)，發(fā)現(xiàn)打印了很多org.springframework.web.HttpRequestMethodNotSupportedException: Request method 'GET' not supported異常日志，雖然知道是因?yàn)榻涌诓恢С諫ET請(qǐng)求導(dǎo)致的，但是，定位不到是因?yàn)殄e(cuò)誤調(diào)用哪個(gè)接口導(dǎo)致，給人很大困惑。

@ExceptionHandler介紹

異常處理器@ExceptionHandler是Spring MVC框架中用于處理異常的注解，方法名按需自定義，方法參數(shù)可以是Exception及其子類(lèi)對(duì)象、HttpServletRequest、HttpServletResponse等，系統(tǒng)會(huì)自動(dòng)為它們賦值。方法返回值類(lèi)型可以為ModelAndView、Model、Map、View、String以及void等。它的作用是把各個(gè)Controller中拋出的異常集中到一個(gè)類(lèi)中處理。

在被@ControllerAdvice或者@RestControllerAdvice修飾的類(lèi)里，可以使用@ExceptionHandler捕捉異常，返回值類(lèi)型為Map的示例如下：

@Slf4j
@RestControllerAdvice
public class GlobalExceptionAdvice {
	/*
   * 捕捉HTTP請(qǐng)求方式異常HttpRequestMethodNotSupportedException
   */
   @ExceptionHandler(HttpRequestMethodNotSupportedException.class)
   public Map<String, Object> handleBadMethodException(HttpRequestMethodNotSupportedException exception, HttpServletRequest req) {
       log.error("不支持的請(qǐng)求方式：{}-{}", req.getRequestURI(), exception.getMessage());
       Map<String, Object> result=new HashMap();
       result.put("msg","不支持的請(qǐng)求方式");
       result.put("code", HttpStatus.METHOD_NOT_ALLOWED.value());
       return result;
   }
}

@RestControllerAdvice：放在類(lèi)的上面，表示這個(gè)類(lèi)中有異常處理器，它是基于AOP的、對(duì)控制器類(lèi)的一個(gè)增強(qiáng)。

req.getRequestURI()用于獲取當(dāng)前API訪問(wèn)路徑的URI，里面包含方法名，用于快速定位是哪個(gè)API出錯(cuò)。

在上述異常處理器示例中，當(dāng)控制層拋出HttpRequestMethodNotSupportedException異常時(shí)，handleBadMethodException方法會(huì)被調(diào)用，返回一個(gè)包含錯(cuò)誤信息的Map對(duì)象。如果把@ExceptionHandler(HttpRequestMethodNotSupportedException.class)改為@ExceptionHandler(Exception.class)，則是處理全局異常了，會(huì)捕獲所有未被其它方法處理的異常，這樣處理的缺點(diǎn)是異常太過(guò)寬泛，不利于排查問(wèn)題。

驗(yàn)證功能的方法很簡(jiǎn)單，請(qǐng)使用GET請(qǐng)求訪問(wèn)僅支持POST請(qǐng)求的函數(shù)，此時(shí)，控制臺(tái)將打印如下信息：

不支持的請(qǐng)求方式：/wiener/XXXMethod-Request method 'GET' not supported

結(jié)束語(yǔ)

Spring MVC的@ExceptionHandler注解為Web應(yīng)用程序提供了便捷的異常處理機(jī)制。通過(guò)使用該注解，可以在控制器中捕獲和處理特定類(lèi)型的異常，提供友好的錯(cuò)誤信息給用戶(hù)。在實(shí)際項(xiàng)目中，合理使用@ExceptionHandler能夠提高代碼的可維護(hù)性和用戶(hù)體驗(yàn)。通過(guò)本文的解析和實(shí)踐，讀者可以更好地理解和掌握@ExceptionHandler的用法和原理。

到此這篇關(guān)于Spring注解之@ExceptionHandler 統(tǒng)一異常處理和獲取方法名的文章就介紹到這了,更多相關(guān)Spring @ExceptionHandler 統(tǒng)一異常處理內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: