@ControllerAdvice + @ExceptionHandler 全局处理 Controller 层异常
admin
2024-03-23 12:15:27
0

1.利用springmvc注解对Controller层异常全局处理
1.1优缺点
1.2基本使用
1.3处理Service层上抛的业务异常
1.4处理Controller数据绑定、数据校验的异常
参考文档 : https://mp.weixin.qq.com/s/D-sNcFWFXBSbp-md5EmAug

1.利用springmvc注解对Controller层异常全局处理
对于与数据库相关的 Spring MVC 项目,我们通常会把 事务 配置在 Service层,当数据库操作失败时让 Service 层抛出运行时异常,Spring 事物管理器就会进行回滚。

如此一来,我们的 Controller 层就不得不进行 try-catch Service 层的异常,否则会返回一些不友好的错误信息到客户端。但是,Controller 层每个方法体都写一些模板化的 try-catch 的代码,很难看也难维护,特别是还需要对 Service 层的不同异常进行不同处理的时候。

1.1优缺点
优点: 将Controller层的异常和数据校验的异常进行统一异常处理,减少模板代码,减少代码量,提升扩展性和可维护性

缺点: 只能处理Controller层未捕获(从Servcie层抛过来)的异常,对于Interceptor(拦截器)层的异常,Spring框架层的异常,就无能为力了。

1.2基本使用
1.2.1@ControllerAdvice 注解定义全局异常处理类
首先,确保此类GlobalExceptionHandler 能被扫描到并装载进Spring容器中。

@ControllerAdvice
public class GlobalExceptionHandler {
}

1.2.2@ExceptionHandler 注解声明异常处理方法

@ControllerAdvice
public class GlobalExceptionHandler {@ExceptionHandler(Exception.class)@ResponseBodyString handleException(){return "Exception Deal!";}
}

方法 handleException() 就会处理所有 Controller 层抛出的 Exception 及其子类的异常,这是最基本的用法了。

被 @ExceptionHandler 注解的方法的参数列表里,还可以声明很多种类型的参数。其原型如下:

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ExceptionHandler {/*** Exceptions handled by the annotated method. If empty, will default to any* exceptions listed in the method argument list.*/Class[] value() default {};}

如果 @ExceptionHandler 注解中未声明要处理的异常类型,则默认为参数列表中的异常类型。所以上面的写法,还可以写成这样:

@ControllerAdvice
public class GlobalExceptionHandler {@ExceptionHandler()@ResponseBodyString handleException(Exception e){return "Exception Deal! " + e.getMessage();}
}

参数对象就是 Controller 层抛出的异常对象!

1.3处理Service层上抛的业务异常
1.3.1代码示例

@ControllerAdvice
public class GlobalExceptionHandler {private static final Logger LOGGER = LoggerFactory.getLogger(GlobalExceptionHandler.class);/*** 处理所有不可知的异常* @param e* @return*/@ExceptionHandler(Exception.class)@ResponseBodyAppResponse handleException(Exception e){LOGGER.error(e.getMessage(), e);AppResponse response = new AppResponse();response.setFail("操作失败!");return response;}/*** 处理所有业务异常* @param e* @return*/@ExceptionHandler(BusinessException.class)@ResponseBodyAppResponse handleBusinessException(BusinessException e){LOGGER.error(e.getMessage(), e);AppResponse response = new AppResponse();response.setFail(e.getMessage());return response;}
}

BusinessException属于业务自定义异常类

@RestController
@RequestMapping(value = "/dogs", consumes = {MediaType.APPLICATION_JSON_UTF8_VALUE})
public class DogController {@Autowiredprivate DogService dogService;@PatchMapping(value = "")Dog update(@Validated(Update.class) @RequestBody Dog dog){return dogService.update(dog);}
}

这样Controller层就不需要进行异常处理了;

有时我们会在复杂带有数据库事务的业务中,当出现不和预期的数据时,直接抛出封装后的业务级运行时异常,进行数据库事务回滚,并希望该异常信息能被返回显示给用户。

我们可以使用自定义异常类可以针对具体业务处理异常;

Logger 进行所有的异常日志记录。

@ExceptionHandler(BusinessException.class) 声明了对 BusinessException 业务异常的处理,并获取该业务异常中的错误提示,构造后返回给客户端。
@ExceptionHandler(Exception.class) 声明了对 Exception 异常的处理,起到兜底作用,不管 Controller 层执行的代码出现了什么未能考虑到的异常,都返回统一的错误提示给客户端。

备注:以上 GlobalExceptionHandler 只是返回 Json 给客户端,更大的发挥空间需要按需求情况来做。但是实际开发中并不这么做,因为返回的Response对象可能封装不同的数据,放在同一异常处理固然是方便,但是可能不实用;

1.4处理Controller数据绑定、数据校验的异常
在Dog类中的字段上的注解数据校验规则:

@Data
public class Dog {@NotNull(message = "{Dog.id.non}", groups = {Update.class})@Min(value = 1, message = "{Dog.age.lt1}", groups = {Update.class})private Long id;@NotBlank(message = "{Dog.name.non}", groups = {Add.class, Update.class})private String name;@Min(value = 1, message = "{Dog.age.lt1}", groups = {Add.class, Update.class})private Integer age;
}

说明:

@NotNull、@Min、@NotBlank 这些注解的使用方法,不在本文范围内。如果不熟悉,请查找资料学习即可。

其他说明:

@Data 注解是 Lombok 项目的注解,可以使我们不用再在代码里手动加 getter & setter。

在 Eclipse 和 IntelliJ IDEA 中使用时,还需要安装相关插件,这个步骤自行Google/Baidu 吧!

基本使用:

SpringMVC 中对于 RESTFUL 的 Json 接口来说,数据绑定和校验,是这样的:

/*** 使用 GlobalExceptionHandler 全局处理 Controller 层异常的示例* @param dog* @return*/
@PatchMapping(value = "")
AppResponse update(@Validated(Update.class) @RequestBody Dog dog){AppResponse resp = new AppResponse();// 执行业务Dog newDog = dogService.update(dog);// 返回数据resp.setData(newDog);return resp;
}

使用 @Validated + @RequestBody 注解实现。

当使用了 @Validated + @RequestBody 注解但是没有在绑定的数据对象后面跟上 Errors 类型的参数声明的话,Spring MVC 框架会抛出 MethodArgumentNotValidException 异常。

所以,在 GlobalExceptionHandler 中加上对 MethodArgumentNotValidException 异常的声明和处理,就可以全局处理数据校验的异常了!加完后的代码如下:

/*** @ControllerAdvice + @ExceptionHandler 实现全局的 Controller 层的异常处理*/
@ControllerAdvice
public class GlobalExceptionHandler {private static final Logger LOGGER = LoggerFactory.getLogger(GlobalExceptionHandler.class);/*** 处理所有不可知的异常* @param e* @return*/@ExceptionHandler(Exception.class)@ResponseBodyAppResponse handleException(Exception e){LOGGER.error(e.getMessage(), e);AppResponse response = new AppResponse();response.setFail("操作失败!");return response;}/*** 处理所有业务异常* @param e* @return*/@ExceptionHandler(BusinessException.class)@ResponseBodyAppResponse handleBusinessException(BusinessException e){LOGGER.error(e.getMessage(), e);AppResponse response = new AppResponse();response.setFail(e.getMessage());return response;}/*** 处理所有接口数据验证异常* @param e* @return*/@ExceptionHandler(MethodArgumentNotValidException.class)@ResponseBodyAppResponse handleMethodArgumentNotValidException(MethodArgumentNotValidException e){LOGGER.error(e.getMessage(), e);AppResponse response = new AppResponse();response.setFail(e.getBindingResult().getAllErrors().get(0).getDefaultMessage());return response;}
}

注意到了吗,所有的 Controller 层的异常的日志记录,都是在这个 GlobalExceptionHandler 中进行记录。也就是说,Controller 层也不需要在手动记录错误日志了。

其实,可以利用springaop进行拦截,然后记录日志。

1.5总结
其实,被 @ExceptionHandler 注解的方法还可以声明很多参数,详见文档。

@ControllerAdvice 也还可以结合 @InitBinder、@ModelAttribute 等注解一起使用,应用在所有被 @RequestMapping 注解的方法上,详见搜索引擎。

相关内容

热门资讯

大疆状告美国FCC 文︱陆弃 大疆创新将美国联邦通信委员会(FCC)推上法庭,这不仅是一场企业与监管机关间的程序对抗,更...
新春坚守“医”线 守护万家安康 2026年新春佳节 万家灯火,阖家团圆 年味在氤氲的烟火气中弥漫 祈愿融进暖意融融的叙谈里 而同一时...
AMD与Nutanix建立战略... IT之家 2 月 26 日消息,AMD 与超融合企业 Nutanix 当地时间 25 日共同宣布,双...
深圳传音控股股份有限公司 20... 本公司董事会及全体董事保证本公告内容不存在任何虚假记载、误导性陈述或者重大遗漏,并对其内容的真实性、...
银行“开抢”压岁钱 春节过后,孩子们的红包往哪存?近日,多家银行推出儿童专属存款产品,利率略高于普通存款利率,起存门槛也...
工行官宣,宋建华离任 【导读】工商银行高级业务总监宋建华因年龄原因离任 中国基金报记者 嘉合 2月25日,工商银行发布公告...
打造新场景新业态 政策加码挖潜... 来源:滚动播报 (来源:经济参考报) 2月24日召开的国务院常务会议研究推进银发经济和养老服务发展有...
从年味里看春节消费新图景 从年味里看春节消费新图景 2月20日,游客在位于天津的国家海洋博物馆“未来海洋”展厅参观。 春...
原创 羽... 文丨郭小兴 编辑丨百进 来源丨新商悟 (本文约为1200字) 在消费电子行业增速放缓的关口,一家企业...
欧洲能否向乌克兰派兵?“得等普... 【文/观察者网 陈思佳】当地时间2月24日,俄乌冲突四周年之际,乌克兰总统泽连斯基在基辅欢迎了欧洲多...
1月泰国大米出口同比下降17.... 来源:中国新闻网 中新社曼谷2月25日电(李映民 刘宇博)泰国大米出口商协会主席查伦25日表示,20...
金价银价,双双大涨 大河财立方消息,2月23日,受美国关税政策的不确定性及避险情绪影响推动,国际金价银价开盘再度双双走高...
春天养肝正当时,记住这三点,一... 这两天出门,大伙儿有没有发现?风变软了,不似冬天那般刺骨,路边的树枝也悄悄冒了嫩芽,地气一点点往上走...
【网络股指数ETF收涨约2.3... 【网络股指数ETF收涨约2.3%,领跑美股行业ETF】周三(2月25日),网络股指数ETF收涨2.2...
“哑铃型”结构显现 白酒市场如... 来源:滚动播报 (来源:北京商报) 随着春节假期结束,白酒市场逐渐步入消费淡季。今年春节假期,白酒市...
AI产业链方向低位震荡,人工智... 2月25日,AI产业链方向低位震荡,光通信、AIGC、AI算力等板块承压。截至收盘,中证人工智能主题...
大疆起诉美监管,数据看清资金连... 近期国产无人机龙头大疆正式起诉美国联邦通信委员会,挑战其将产品列入“受管制清单”的决定。消息一出,不...
欧盟终结小额免税政策!7月1日... 近日,欧盟最新跨境电商进口监管改革方案正式生效,核心变革在于废除长期实施的“价值低于150欧元小包裹...
个税年度汇算,今起预约! 据国家税务总局通告,2025年度个人所得税综合所得汇算清缴办理时间为2026年3月1日至6月30日。...
智洋创新终止收购灵明光子控股权... 2月25日晚间,智洋创新(SH688191,停牌)发布公告,宣布终止筹划以发行股份、可转债或现金等方...