关键词:
在具体的SSM项目开发中,由于Controller层为处于请求处理的最顶层,再往上就是框架代码的。因此,肯定需要在Controller捕获所有异常,并且做适当处理,返回给前端一个友好的错误码。
不过,Controller一多,我们发现每个Controller里都有大量重复的、冗余的异常处理代码,很是啰嗦。能否将这些重复的部分抽取出来,这样保证Controller层更专注于业务逻辑的处理,同时能够使得异常的处理有一个统一的控制中心点。
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.
- <p>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. 使用示例br/>来看一个例子:
@Component
@Slf4j
public class CustomHandlerExceptionResolver implements HandlerExceptionResolver {br/>@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 内,如:br/>@Controller
@Slf4jbr/>@RequestMapping("/api/demo")
public class DemoController {br/>@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 修饰,由框架的其它机制帮你序列化。
此外,它还能够对异常类型进行细粒度的控制,通过注解可以有选择的指定异常处理方法应用的异常类型:
[email protected]({BusinessException.class, DataBaseError.class })
虽然说全局异常处理HandlerExceptionResolver通过条件判断也能做到,但是使用这种注解方式明显更具有可读性。
1.3.2. 一个问题
刚才说到异常处理函数可以用 @ResponseBody 修饰,就像一般的Controller方法一样。
然而,非常遗憾的是,如果使用自定义的 HandlerMethodReturnValueHandler,却不生效。比如:br/>@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 {br/>@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范围
注意到,我是这样编写注解的:
[email protected](assignableTypes = {GlobalExceptionHandlerMixin.class})
它用来限定这些异常处理函数起作用的 Controller 的范围。如果不写,则默认对所有 Controller 有效。
这也是 ControllerAdvice 进行统一异常处理的优点,它能够细粒度的控制该异常处理器针对哪些 Controller 有效,这样的好处是:
一个系统里就能够存在不同的异常处理器,Controller 也可以有选择的决定使用哪个,更加灵活。
不同的业务模块可能对异常处理的方式不同,通过该机制就能做到。
设想一个一开始并未使用全局异常处理的系统,如果直接引入全局范围内生效的全局异常处理,势必可能会改变已有 Controller 的行为,有侵入性。
也就是说,如果不控制生效范围,即默认对所有 Controller 生效。如果控制生效范围,则默认对所有 Controller 不生效,降低侵入性。
如刚才示例中的例子,只针对实现了 GlobalExceptionHandlerMixin 接口的类有效:br/>@Controller
@Slf4jbr/>@RequestMapping("/api/demo")
public class DemoController implements GlobalExceptionHandlerMixin {
}
ControllerAdvice 支持的限定范围
按注解:@ControllerAdvice(annotations = RestController.class)br/>按包名:@ControllerAdvice("org.example.controllers")
按类型:@ControllerAdvice(assignableTypes = {ControllerInterface.class, AbstractController.class})
总结a
以上几种方式是 Spring 专门为异常处理设计的机制。就我个人而言,由于 ControllerAdvice 具有更细粒度的控制能力,所以我更偏爱于在系统中使用 ControllerAdvice 进行统一异常处理。除了用异常来传递系统中的意外错误,也会用它来传递处于接口行为一部分的业务错误。这也是异常的优点之一,如果接口的实现比较复杂,分多层函数实现,如果直接传递错误码,那么到 Controller 的路径上的每一层函数都需要检查错误码,退回到了C语言那种可怕的“写一行语句检查一下错误码”的模式。
当然,理论上,任何能够给 Controller 加切面的机制都能变相的进行统一异常处理。比如:
在拦截器内捕获 Controller 的异常,做统一异常处理。
使用 Spring 的 AOP 机制,做统一异常处理。
spring的@exceptionhandler和@controlleradvice统一处理异常
之前敲代码的时候,避免不了各种try..catch,如果业务复杂一点,就会发现全都是try…catchtry..........catch(Exception1e)..........catch(Exception2e)...........catch(Exception3e)...........这样其实代码既不简洁好看,我们敲着也烦,一般我们可能想到用... 查看详情
springboot中的统一异常处理
请查看@ControllerAdvice、@ExceptionHandler和@RestControllerAdvice的注释 https://www.cnblogs.com/goloving/p/9142222.htmlhttps://yq.aliyun.com/articles/647428 查看详情
springmvc学习07springmvc中的统一异常处理
我们知道,系统中异常包括:编译时异常和运行时异常RuntimeException,前者通过捕获异常从而获取异常信息,后者主要通过规范代码开发、测试通过手段减少运行时异常的发生。在开发中,不管是dao层、service层还是controller层... 查看详情
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() ... 查看详情
spring的异常处理
出自于:https://blog.csdn.net/he90227/article/details/46309297 ---- 利用Spring进行统一异常处理的两种方式。 原文:https://blog.csdn.net/he90227/article/details/46309297?utm_source=copy1.实现接口HandlerExcept 查看详情
springboot中关于自定义异常处理的套路!
在SpringBoot项目中,异常统一处理,可以使用Spring中@ControllerAdvice来统一处理,也可以自己来定义异常处理方案。SpringBoot中,对异常的处理有一些默认的策略,我们分别来看。默认情况下,SpringBoot中的异常页面是这样的:我们从... 查看详情
@controlleradvice拦截异常并统一处理(代码片段)
在spring3.2中,新增了@ControllerAdvice 注解,可以用于定义@ExceptionHandler、@InitBinder、@ModelAttribute,并应用到所有@RequestMapping中。参考:@ControllerAdvice文档一、介绍创建MyControllerAdvice,并添加@ControllerAdvice注解。packagecom.sam 查看详情
@controlleradvice拦截异常并统一处理(代码片段)
在spring3.2中,新增了@ControllerAdvice注解,可以用于定义@ExceptionHandler、@InitBinder、@ModelAttribute,并应用到所有@RequestMapping中。参考:@ControllerAdvice文档一、介绍创建MyControllerAdvice,并添加@ControllerAdvice注解。packagecom.sam 查看详情
springmvc统一异常处理(返回异常数据而不是跳转到某个页面的方法)
关于SpringMVC统一异常处理的问题,网搜一大把。网上搜的关于如何进行统一异常处理不外乎如下三种方式:SpringMVC处理异常有3种方式:(1)使用SpringMVC提供的简单异常处理器SimpleMappingExceptionResolver;(2)实现Spring的异... 查看详情
springboot2系列教程(十四)|统一异常处理
...,今天介绍SpringBoot是如何统一处理全局异常的。SpringBoot中的全局异常处理主要起作用的两个注解是@ControllerAdvice和@ExceptionHandler,其中@ControllerAdvice是组件注解,添加了这个注解的类能够拦截Controller的请求,而ExceptionHandler注解... 查看详情
@controlleradvice自定义异常统一处理(代码片段)
...用户。比如用户的某些操作不被允许,需要给用户提示。Spring提供了@ControllerAdvice这个注解,这个注解可以实现全局异常处理,全局数据绑定,全局数据预处理,这里主要说下使用这个注解实现全局异常处理。1.定义我们自己的... 查看详情
springboot统一功能处理(用户登录权限效验-拦截器异常处理数据格式返回)(代码片段)
...目录1.统一用户登录权限效验1.1最初用户登录权限效验1.2SpringAOP统一用户登录验证1.3Spring拦截器1.4练习:登录拦截器1.5拦截器实现原理1.6统一访问前缀添加2.统一异常处理3.统一数据格式返回3.1统一数据格式返回的实现3.2@Co... 查看详情
统一异常处理@controlleradvice+@exceptionhandler全局处理controller层异常(代码片段)
1.利用springmvc注解对Controller层异常全局处理对于与数据库相关的SpringMVC项目,我们通常会把事务配置在Service层,当数据库操作失败时让Service层抛出运行时异常,Spring事物管理器就会进行回滚。如此一来,我们的Controller层就不得... 查看详情
spring@async的异常处理
...文章中,分别介绍了Java子线程中通用的异常处理,以及Springweb应用中的异常处理。链接如下:Java子线程中的异常处理(通用)Springweb引用中的异常处理今天,要写的是被Spring@Async注解的方法中的异常处理方法。 通常,如果... 查看详情
在 Spring 中的 @Transactional 方法期间处理异常
】在Spring中的@Transactional方法期间处理异常【英文标题】:Handlingexceptionsduringa@TransactionalmethodinSpring【发布时间】:2018-10-1312:11:48【问题描述】:我试图找出如何结合Spring的@Transactional最好地处理持久性(以及可能的其他)异常。... 查看详情
Spring GenericFilterBean 中的异常处理
】SpringGenericFilterBean中的异常处理【英文标题】:ExceptionhandlinginSpringGenericFilterBean【发布时间】:2015-10-0809:08:33【问题描述】:我已经实现了基于令牌的身份验证(没有弹簧安全性)。所以在GenericFilterBean中,它会检查并声明令... 查看详情