• 极客专栏正式上线!欢迎访问 https://www.jikewenku.com/topic.html
  • 极客专栏正式上线!欢迎访问 https://www.jikewenku.com/topic.html

Spring中的统一异常处理方式

技术杂谈 勤劳的小蚂蚁 3个月前 (01-29) 70次浏览 已收录 0个评论 扫描二维码
在具体的SSM项目开发中,由于Controller层为处于请求处理的最顶层,再往上就是框架代码的。
因此,肯定需要在Controller捕获所有异常,并且做适当处理,返回给前端一个友好的错误码。
不过,Controller一多,我们发现每个Controller里都有大量重复的、冗余的异常处理代码,很是啰嗦。
能否将这些重复的部分抽取出来,这样保证Controller层更专注于业务逻辑的处理,同时能够使得异常的处理有一个统一的控制中心点。
一、全局异常处理

1、HandlerExceptionResolver接口

使用全局异常处理器只需要两步:
1)实现HandlerExceptionResolver接口。
2)将实现类作为Spring Bean,这样Spring就能扫描到它并作为全局异常处理器加载。
在resolveException中实现异常处理逻辑。
从参数上,可以看到,不仅能够拿到发生异常的函数和异常对象,还能够拿到HttpServletResponse对象,从而控制本次请求返回给前端的行为。
此外,函数还可以返回一个ModelAndView对象,表示渲染一个视图,比方说错误页面。
不过,在前后端分离为主流架构的今天,这个很少用了。如果函数返回的视图为空,则表示不需要视图。

2、使用示例

来看一个例子:
逻辑很显然,在发生异常时,将ResponseDTO序列化为json给前端。

3、Controller局部异常处理

1)使用示例

这种异常处理只局部于某个Controller内,如:
  • 所有Controller方法(即被RequestMapping注解的方法)抛出的异常,会被该异常处理方法处理。
  • 使用上,在Controller内部,用@ExceptionHandler注解的方法,就会作为该Controller内部的异常处理方法。
  • 并且,它的参数中可以注入如WebRequest、NativeWebRequest等,用来拿到请求相关的数据。
  • 它可以返回String代表一个view名称,也可以返回一个对象并且用@ResponseBody修饰,由框架的其它机制帮你序列化。
    此外,它还能够对异常类型进行细粒度的控制,通过注解可以有选择的指定异常处理方法应用的异常类型:
虽然说全局异常处理HandlerExceptionResolver通过条件判断也能做到,
但是使用这种注解方式明显更具有可读性。

2)一个问题

刚才说到异常处理函数可以用@ResponseBody修饰,就像一般的Controller方法一样。
然而,非常遗憾的是,如果使用自定义的HandlerMethodReturnValueHandler,却不生效。
比如:
不知道是我的使用姿势不对,还是什么情况?各种Google后无果。
所以,目前的解决方案是,如果能够控制@JsonResponse注解相关的定义代码,将处理返回值这部分逻辑抽取出来,然后在异常处理函数中手动调用。

4、ControllerAdvice

1)使用示例

刚才介绍的是Controller局部的异常处理,用于处理该Controller内部的特有的异常处理十分有用。
首先,定义一个存放异常处理函数的类,并使用@ControllerAdvice修饰。
@ExceptionHanlder修饰的方法的写法和Controller内的异常处理函数写法是一样的。

2)控制生效的Controller范围

注意到,我是这样编写注解的:
它用来限定这些异常处理函数起作用的Controller的范围。如果不写,则默认对所有Controller有效。
这也是ControllerAdvice进行统一异常处理的优点,它能够细粒度的控制该异常处理器针对哪些Controller有效,这样的好处是:
  • 一个系统里就能够存在不同的异常处理器,Controller也可以有选择的决定使用哪个,更加灵活。
  • 不同的业务模块可能对异常处理的方式不同,通过该机制就能做到。
  • 设想一个一开始并未使用全局异常处理的系统,如果直接引入全局范围内生效的全局异常处理,势必可能会改变已有Controller的行为,有侵入性。
    也就是说,如果不控制生效范围,即默认对所有Controller生效。如果控制生效范围,则默认对所有Controller不生效,降低侵入性。
如刚才示例中的例子,只针对实现了GlobalExceptionHandlerMixin接口的类有效:
ControllerAdvice支持的限定范围:
  • 按注解:@ControllerAdvice(annotations = RestController.class)
  • 按包名:@ControllerAdvice(“org.example.controllers”)
  • 按类型:@ControllerAdvice(assignableTypes = {ControllerInterface.class, AbstractController.class})
二、总结
以上几种方式是Spring专门为异常处理设计的机制。
就我个人而言,由于ControllerAdvice具有更细粒度的控制能力,所以我更偏爱于在系统中使用ControllerAdvice进行统一异常处理。
除了用异常来传递系统中的意外错误,也会用它来传递处于接口行为一部分的业务错误。
这也是异常的优点之一,如果接口的实现比较复杂,分多层函数实现,如果直接传递错误码,那么到Controller的路径上的每一层函数都需要检查错误码,退回到了C语言那种可怕的“写一行语句检查一下错误码”的模式。
当然,理论上,任何能够给Controller加切面的机制都能变相的进行统一异常处理。比如:
1、在拦截器内捕获Controller的异常,做统一异常处理。
2、使用Spring的AOP机制,做统一异常处理。

丨极客文库, 版权所有丨如未注明 , 均为原创丨
本网站采用知识共享署名-非商业性使用-相同方式共享 3.0 中国大陆许可协议进行授权
转载请注明原文链接:Spring中的统一异常处理方式
喜欢 (0)
[247507792@qq.com]
分享 (0)
勤劳的小蚂蚁
关于作者:
温馨提示:本文来源于网络,转载文章皆标明了出处,如果您发现侵权文章,请及时向站长反馈删除。

您必须 登录 才能发表评论!

  • 精品技术教程
  • 编程资源分享
  • 问答交流社区
  • 极客文库知识库

客服QQ


QQ:2248886839


工作时间:09:00-23:00