spring中的统一异常处理方式

BillyYang      2022-04-28     632

关键词:

源自:https://segmentfault.com/a/1190000016236188

 

  在具体的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机制,做统一异常处理。

 

springmvc统一异常处理(返回异常数据而不是跳转到某个页面的方法)

关于SpringMVC统一异常处理的问题,网搜一大把。网上搜的关于如何进行统一异常处理不外乎如下三种方式:SpringMVC处理异常有3种方式:(1)使用SpringMVC提供的简单异常处理器SimpleMappingExceptionResolver;(2)实现Spring的异... 查看详情

springmvc异常统一处理方式

springMVC提供的异常处理主要有两种方式,一种是直接实现自己的HandlerExceptionResolver,另一种是使用注解的方式实现一个专门用于处理异常的Controller——ExceptionHandler。 1、实现自己的HandlerExceptionResolver,HandlerExceptionResolver是一... 查看详情

spring的异常处理

出自于:https://blog.csdn.net/he90227/article/details/46309297  ---- 利用Spring进行统一异常处理的两种方式。 原文:https://blog.csdn.net/he90227/article/details/46309297?utm_source=copy1.实现接口HandlerExcept 查看详情

spring@async的异常处理

...文章中,分别介绍了Java子线程中通用的异常处理,以及Springweb应用中的异常处理。链接如下:Java子线程中的异常处理(通用)Springweb引用中的异常处理今天,要写的是被Spring@Async注解的方法中的异常处理方法。 通常,如果... 查看详情

spring的@exceptionhandler和@controlleradvice统一处理异常

之前敲代码的时候,避免不了各种try..catch,如果业务复杂一点,就会发现全都是try…catchtry..........catch(Exception1e)..........catch(Exception2e)...........catch(Exception3e)...........这样其实代码既不简洁好看,我们敲着也烦,一般我们可能想到用... 查看详情

替代trycatch处理异常的优雅方式

...,而且还影响代码的可读性。一、什么是统一异常处理?Spring在3.2版本增加了一个注解​​@ControllerAdvice​​,可以与​​@ExceptionHandler​​、​ 查看详情

Spring Boot 中的生产级异常处理

】SpringBoot中的生产级异常处理【英文标题】:ProductionlevelExceptionhandlinginspringboot【发布时间】:2018-08-1701:01:14【问题描述】:我有一个场景:UI<--->Springbootmicro-serviceRESTAPI<--->server现在,有一种情况我想处理自定义异常(... 查看详情

springboot中的统一异常处理

请查看@ControllerAdvice、@ExceptionHandler和@RestControllerAdvice的注释 https://www.cnblogs.com/goloving/p/9142222.htmlhttps://yq.aliyun.com/articles/647428 查看详情

springmvc学习07springmvc中的统一异常处理

  我们知道,系统中异常包括:编译时异常和运行时异常RuntimeException,前者通过捕获异常从而获取异常信息,后者主要通过规范代码开发、测试通过手段减少运行时异常的发生。在开发中,不管是dao层、service层还是controller层... 查看详情

springboot统一参数校验统一异常统一响应,这才是优雅的处理方式!(代码片段)

前言本篇主要要介绍的就是controller层的处理,一个完整的后端请求由4部分组成:接口地址(也就是URL地址)请求方式(一般就是get、set,当然还有put、delete)请求数据(request,有head跟body)响应数据(response)本篇将解决以... 查看详情

Spring Boot + 调度程序 + Spring Data JPA + Oracle 中的异常处理

】SpringBoot+调度程序+SpringDataJPA+Oracle中的异常处理【英文标题】:ExceptionHandlinginSpringBoot+Schedulers+SpringDataJPA+Oracle【发布时间】:2022-01-1212:58:10【问题描述】:我正在尝试找出所有异常可以被处理/捕获和处理的其他方式,例如将... 查看详情

springboot全局异常统一处理(代码片段)

统一处理机制spring系统异常:@ControllerAdvice&@ExceptionHandlerhttp异常ErrorControllerServlet异常Filter1.SpringBoot默认错误统一处理机制在基于SpringBoot的Web应用中,对于Http请求处理过程中发生的各种错误,如常见的400、404... 查看详情

自定义异常(代码片段)

在SpringBoot项目中,异常统一处理,可以使用Spring中@ControllerAdvice来统一处理,也可以自己来定义异常处理方案。SpringBoot中,对异常的处理有一些默认的策略,我们分别来看。默认情况下,SpringBoot中的异常页面是这样的:我们从... 查看详情

spring定时任务事务回滚并且对异常进行统一处理

参考技术A/***定时任务配置*@authorcongyiqun*@since2021-05-31*/@Slf4j@Configuration@EnableScheduling//开启定时任务publicclassSchedulingConfimplementsSchedulingConfigurerprivatefinalThreadPoolTaskSchedulertaskScheduler;publicSchedulingConf()       ... 查看详情

java中的全局异常处理(代码片段)

Java中的全局异常处理全局异常处理SpringBoot的全局异常处理@ControllerAdvice注解全局异常处理ErrorController接口和@ControllerAdvice注解比较:相同点:两者都是Spring项目中的全局异常处理方式不同点:捕获异常位置不同:ErrorController接口... 查看详情

java中的全局异常处理(代码片段)

Java中的全局异常处理全局异常处理SpringBoot的全局异常处理@ControllerAdvice注解全局异常处理ErrorController接口和@ControllerAdvice注解比较:相同点:两者都是Spring项目中的全局异常处理方式不同点:捕获异常位置不同:ErrorController接口... 查看详情

java中的全局异常处理(代码片段)

Java中的全局异常处理全局异常处理SpringBoot的全局异常处理@ControllerAdvice注解全局异常处理ErrorController接口和@ControllerAdvice注解比较:相同点:两者都是Spring项目中的全局异常处理方式不同点:捕获异常位置不同:ErrorController接口... 查看详情

c#中异步编程多个异常的处理方式(代码片段)

...直是件麻烦的事情,所以接下来给大家介绍一下异步编程中的错误处理方式单个异常的捕获publicstaticasyncTaskThrowExcrptionAsync(intms,stringmessage) 查看详情