Spring注解之@ExceptionHandler 统一异常处理和获取方法名

摘要:在 Spring Boot 中,使用Spring注解@ControllerAdvice 和 @ExceptionHandler 统一处理异常,并捕获方法名,从而快速定位错误原因。

背景分析

最近走查线上环境日志时,发现打印了很多org.springframework.web.HttpRequestMethodNotSupportedException: Request method 'GET' not supported异常日志,虽然知道是因为接口不支持GET请求导致的,但是,定位不到是因为错误调用哪个接口导致,给人很大困惑。

@ExceptionHandler介绍

异常处理器@ExceptionHandler是Spring MVC框架中用于处理异常的注解,方法名按需自定义,方法参数可以是Exception及其子类对象、HttpServletRequest、HttpServletResponse等,系统会自动为它们赋值。方法返回值类型可以为ModelAndView、Model、Map、View、String以及void等。它的作用是把各个Controller中抛出的异常集中到一个类中处理。

在被@ControllerAdvice或者@RestControllerAdvice修饰的类里,可以使用@ExceptionHandler捕捉异常,返回值类型为Map的示例如下:

java 复制代码
@Slf4j
@RestControllerAdvice
public class GlobalExceptionAdvice {
	/*
   * 捕捉HTTP请求方式异常HttpRequestMethodNotSupportedException
   */
   @ExceptionHandler(HttpRequestMethodNotSupportedException.class)
   public Map<String, Object> handleBadMethodException(HttpRequestMethodNotSupportedException exception, HttpServletRequest req) {
       log.error("不支持的请求方式:{}-{}", req.getRequestURI(), exception.getMessage());
       Map<String, Object> result=new HashMap();
       result.put("msg","不支持的请求方式");
       result.put("code", HttpStatus.METHOD_NOT_ALLOWED.value());
       return result;
   }
}

@RestControllerAdvice:放在类的上面,表示这个类中有异常处理器,它是基于AOP的、对控制器类的一个增强。

req.getRequestURI()用于获取当前API访问路径的URI,里面包含方法名,用于快速定位是哪个API出错。

在上述异常处理器示例中,当控制层抛出HttpRequestMethodNotSupportedException异常时,handleBadMethodException方法会被调用,返回一个包含错误信息的Map对象。如果把@ExceptionHandler(HttpRequestMethodNotSupportedException.class)改为@ExceptionHandler(Exception.class),则是处理全局异常了,会捕获所有未被其它方法处理的异常,这样处理的缺点是异常太过宽泛,不利于排查问题。

验证功能的方法很简单,请使用GET请求访问仅支持POST请求的函数,此时,控制台将打印如下信息:

不支持的请求方式:/wiener/XXXMethod-Request method 'GET' not supported

结束语

Spring MVC的@ExceptionHandler注解为Web应用程序提供了便捷的异常处理机制。通过使用该注解,可以在控制器中捕获和处理特定类型的异常,提供友好的错误信息给用户。在实际项目中,合理使用@ExceptionHandler能够提高代码的可维护性和用户体验。通过本文的解析和实践,读者可以更好地理解和掌握@ExceptionHandler的用法和原理。希望这篇文章对您有所帮助,感谢阅读!

相关推荐
fouryears_234177 小时前
Spring,Spring Boot 和 Spring MVC 的关系以及区别
java·spring boot·spring·mvc
板板正8 小时前
SpringAI——提示词(Prompt)、提示词模板(PromptTemplate)
java·spring boot·ai·prompt
板板正8 小时前
SpringAI——对话记忆
java·spring boot·ai
皮皮林5519 小时前
为什么 SpringBoot 宁可挨骂也要干掉 spring.factories?
spring boot
midsummer_woo11 小时前
基于springboot+vue+mysql工程教育认证的计算机课程管理平台(源码+论文)
vue.js·spring boot·mysql
小马爱打代码12 小时前
Spring Boot 监控:AOP vs Filter vs Java Agent
spring boot·监控
摸鱼仙人~12 小时前
Spring Boot 参数校验:@Valid 与 @Validated
java·spring boot·后端
小沈同学呀15 小时前
Spring Boot 中 META-INF 的作用与功能详解
java·spring boot·后端
欲儿15 小时前
LiteCloud超轻量级网盘项目基于Spring Boot
java·spring boot·后端·轻量级网盘项目
livemetee16 小时前
springboot 整合spring-kafka客户端:SASL_SSL+PLAINTEXT方式
spring boot·spring·kafka