利用ControllerAdvice + ExceptionHandler实现统一异常处理
自定义全局异常处理类并加上@ControllerAdvice注解
通过在自定义类上加 @ControllerAdvice
注解,这样能为Controller做一些增强的功能,并在自定义方法上加 @ExceptionHandler
,使得该方法可以捕获到Controller层抛出的所有异常,如下代码示例:
@ControllerAdvice
public class SysGlobalExceptionHandler {
private static final Logger logger = LoggerFactory.getLogger(SysGlobalExceptionHandler.class);
@ExceptionHandler(BusinessException.class)
public ModelAndView businessExceptionHandler(BusinessException e, HttpServletRequest request) {
logger.error(request.getRequestURL().toString(), e);
ModelAndView modelAndView = new ModelAndView("businessException");
modelAndView.addObject("errorMsg", e.getMessage());
return modelAndView;
}
@ExceptionHandler(Exception.class)
@ResponseBody
public Playload exceptionHandler(Exception e, HttpServletRequest request) {
logger.error(request.getRequestURL().toString(), e);
return Playload.error(RespCode.OTHER_EX.getCode(), e.getMessage());
}
}
总结步骤如下:
1、自定义一个SysGlobalExceptionHandler
作为系统全局异常处理器,并且加上 @ControllerAdvice
注解
2、自定义方法上加上@ExceptionHandler
,同时可以指定要处理的异常类型,SysGlobalExceptionHandler
会根据捕获到的异常的类型,决定要执行哪一个带了 @ExceptionHandler
注解的方法
(注意:ExceptionHandler
只能识别到同类型的异常或者是子类异常,并且不能同时在 SysGlobalExceptionHandler
中定义两个相同的异常类型,否则项目启动会报错)
3、在方法中统一对异常进行处理,打印信息和异常堆栈。根据异常的类型和项目需求决定将要返回的结果是模型视图ModelAndView
还是 JSON
数据。
在上一篇介绍的HandlerExceptionResolver方案中虽然也能返回模型视图或者JSON数据,但其实不太直观,处理不同的异常类型的逻辑也扎堆在同一个方法中。所以,推荐使用 ControllerAdvice + ExceptionHandler 的统一处理异常的方案,处理方式更加直观、灵活。