Spring 如何实现:统一异常处理

1. 全局异常处理

1.1. HandlerExceptionResolver接口

public interface HandlerExceptionResolver {

/**

* Try to resolve the given exception that got thrown during on handler execution,

* returning a ModelAndView that represents a specific error page if appropriate.

*

The returned ModelAndView may be {@linkplain ModelAndView#isEmpty() empty}

* to indicate that the exception has been resolved successfully but that no view

* should be rendered, for instance by setting a status code.

* @param request current HTTP request

* @param response current HTTP response

* @param handler the executed handler, or {@code null} if none chosen at the

* time of the exception (for example, if multipart resolution failed)

* @param ex the exception that got thrown during handler execution

* @return a corresponding ModelAndView to forward to,

* or {@code null} for default processing

*/

ModelAndView resolveException(

HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex);

}

使用全局异常处理器只需要两步:

实现HandlerExceptionResolver接口。

将实现类作为Spring Bean,这样Spring就能扫描到它并作为全局异常处理器加载。

在resolveException中实现异常处理逻辑。

从参数上,可以看到,不仅能够拿到发生异常的函数和异常对象,还能够拿到HttpServletResponse对象,从而控制本次请求返回给前端的行为。

此外,函数还可以返回一个ModelAndView对象,表示渲染一个视图,比方说错误页面。

不过,在前后端分离为主流架构的今天,这个很少用了。如果函数返回的视图为空,则表示不需要视图。

1.2. 使用示例

来看一个例子:

@Component

@Slf4j

public class CustomHandlerExceptionResolver implements HandlerExceptionResolver {

@Override

public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {

Method method = null;

if (handler != null && handler instanceof HandlerMethod) {

method = ((HandlerMethod) handler).getMethod();

}

log.error("[{}] system error", method, ex);

ResponseDTO response = ResponseDTO.builder()

.errorCode(ErrorCode.SYSTEM_ERROR)

.build();

byte[] bytes = JSON.toJSONString(response).getBytes(StandardCharsets.UTF_8));

try {

FileCopyUtils.copy(bytes, response.getOutputStream());

} catch (IOException e) {

log.error("error", e);

throw new RuntimeException(e);

}

return new ModelAndView();

}

}

逻辑很显然,在发生异常时,将ResponseDTO序列化为json给前端。

1.3. Controller局部异常处理

1.3.1. 使用示例

这种异常处理只局部于某个Controller内,如:

@Controller

@Slf4j

@RequestMapping("/api/demo")

public class DemoController {

@ExceptionHandler(Exception.class)

@ResponseBody

public ResponseDTO exceptionHandler(Exception e) {

log.error("[{}] system error", e);

return ResponseDTO.builder()

.errorCode(ErrorCode.SYSTEM_ERROR)

.build();

}

}

所有Controller方法(即被RequestMapping注解的方法)抛出的异常,会被该异常处理方法处理。

使用上,在Controller内部,用@ExceptionHandler注解的方法,就会作为该Controller内部的异常处理方法。

并且,它的参数中可以注入如WebRequest、NativeWebRequest等,用来拿到请求相关的数据。

它可以返回String代表一个view名称,也可以返回一个对象并且用@ResponseBody修饰,由框架的其它机制帮你序列化。

此外,它还能够对异常类型进行细粒度的控制,通过注解可以有选择的指定异常处理方法应用的异常类型:

@ExceptionHandler({BusinessException.class, DataBaseError.class })

虽然说全局异常处理HandlerExceptionResolver通过条件判断也能做到,

但是使用这种注解方式明显更具有可读性。

1.3.2. 一个问题

刚才说到异常处理函数可以用@ResponseBody修饰,就像一般的Controller方法一样。

然而,非常遗憾的是,如果使用自定义的HandlerMethodReturnValueHandler,却不生效。

比如:

@ExceptionHandler(Exception.class)

@JsonResponse

public ResponseDTO exceptionHandler(Exception e) {

log.error("[{}] system error", e);

return ResponseDTO.builder()

.errorCode(ErrorCode.SYSTEM_ERROR)

.build();

}

不知道是我的使用姿势不对,还是什么情况?各种google后无果。

所以,目前的解决方案是,如果能够控制@JsonResponse注解相关的定义代码,将处理返回值这部分逻辑抽取出来,然后在异常处理函数中手动调用。

1.4. ControllerAdvice

1.4.1. 使用示例

刚才介绍的是Controller局部的异常处理,用于处理该Controller内部的特有的异常处理十分有用。

首先,定义一个存放异常处理函数的类,并使用@ControllerAdvice修饰。

@ControllerAdvice(assignableTypes = {GlobalExceptionHandlerMixin.class})

public class ExceptionAdvice {

@ExceptionHandler(ErrorCodeWrapperException.class)

@ResponseBody

public ResponseDTO exceptionHandler(ErrorCodeWrapperException e) {

if ((errCodeException.getErrorCode().equals(ErrorCode.SYSTEM_ERROR))) {

log.error(e);

}

return ResponseDTO.ofErroCodeWrapperException(errCodeException);

}

}

@ExceptionHanlder修饰的方法的写法和Controller内的异常处理函数写法是一样的。

1.4.2. 控制生效的Controller范围

注意到,我是这样编写注解的:

@ControllerAdvice(assignableTypes = {GlobalExceptionHandlerMixin.class})

它用来限定这些异常处理函数起作用的Controller的范围。如果不写,则默认对所有Controller有效。

这也是ControllerAdvice进行统一异常处理的优点,它能够细粒度的控制该异常处理器针对哪些Controller有效,这样的好处是:

一个系统里就能够存在不同的异常处理器,Controller也可以有选择的决定使用哪个,更加灵活。

不同的业务模块可能对异常处理的方式不同,通过该机制就能做到。

设想一个一开始并未使用全局异常处理的系统,如果直接引入全局范围内生效的全局异常处理,势必可能会改变已有Controller的行为,有侵入性。

也就是说,如果不控制生效范围,即默认对所有Controller生效。如果控制生效范围,则默认对所有Controller不生效,降低侵入性。

如刚才示例中的例子,只针对实现了GlobalExceptionHandlerMixin接口的类有效:

@Controller

@Slf4j

@RequestMapping("/api/demo")

public class DemoController implements GlobalExceptionHandlerMixin {

}

ControllerAdvice支持的限定范围:

按注解:@ControllerAdvice(annotations = RestController.class)

按包名:@ControllerAdvice("org.example.controllers")

按类型:@ControllerAdvice(assignableTypes = {ControllerInterface.class, AbstractController.class})

2. 总结

以上几种方式是Spring专门为异常处理设计的机制。

就我个人而言,由于ControllerAdvice具有更细粒度的控制能力,所以我更偏爱于在系统中使用ControllerAdvice进行统一异常处理。

除了用异常来传递系统中的意外错误,也会用它来传递处于接口行为一部分的业务错误。

这也是异常的优点之一,如果接口的实现比较复杂,分多层函数实现,如果直接传递错误码,那么到Controller的路径上的每一层函数都需要检查错误码,退回到了C语言那种可怕的“写一行语句检查一下错误码”的模式。

当然,理论上,任何能够给Controller加切面的机制都能变相的进行统一异常处理。比如:

在拦截器内捕获Controller的异常,做统一异常处理。

使用Spring的AOP机制,做统一异常处理。

小编这里整理了更多的Java相关学习资料和 spring源码视频

关注我 转发文章; ++我VX bmaaa01

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,335评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,895评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,766评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,918评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,042评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,169评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,219评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,976评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,393评论 1 304
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,711评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,876评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,562评论 4 336
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,193评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,903评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,142评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,699评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,764评论 2 351

推荐阅读更多精彩内容