前情回顾:
首先明确,当你的代码遇到bug时会报错,那报错后不处理就会程序停止运行。
那就需要异常捕获了,两种方法:
一、try...catch...直接自己处理
二、throws 将异常抛给调用者
在spring的框架中,要求就是简洁,在大量的代码中有try..catch会导致很臃肿。所以大部分会采取抛异常的方法。但controller就是最高级别的调用了,由于 Controller 层为处于请求处理的最顶层,再往上就是框架代码的。所以需要在这一层处理异常。
当然你不处理,tomcat也不会停机,至于为什么,如下:
Tomcat默认异常处理: Tomcat有一个默认的异常处理机制,可以捕获未捕获的异常,输出异常信息到控制台,并继续运行。这是为了防止一个异常导致整个Tomcat服务器崩溃。如果你希望在发生异常时停止Tomcat,可以配置Tomcat的
catalina.sh
或catalina.bat
文件,在启动脚本中加入-Dorg.apache.catalina.STOP.ON_FAIL=true
参数。
由此,引出spring的异常统一处理:
一、在controller内中局部处理异常
这个只会处理当前controller的异常
@Slf4j
@Controller
@RequestMapping("/class")
@ResponseBody
public class ClassController {
@Autowired
IClassService classService;
@ExceptionHandler
@ResponseBody
public Result exceptionHandler(Exception e) {
log.error("[{}] system error", e);
return Result.fail("错误信息"+e.getCause().getMessage());
}
}
所有 Controller 方法(即被 RequestMapping 注解的方法)抛出的异常,会被该异常处理方法处理。
使用上,在 Controller 内部,用
@ExceptionHandler
注解的方法,就会作为该 Controller 内部的异常处理方法。并且,它的参数中可以注入如 WebRequest、NativeWebRequest 等,用来拿到请求相关的数据。
它可以返回 String 代表一个 视图 view 名称,也可以返回一个对象并且用
@ResponseBody
修饰,由框架的其它机制帮你序列化。
此外,它还能够对异常类型进行细粒度的控制,通过注解可以有选择的指定异常处理方法应用的异常类型:
@ExceptionHandler({BusinessException.class, DataBaseError.class })
虽然说全局异常处理 HandlerExceptionResolver 通过条件判断也能做到,但是使用这种注解方式明显更具有可读性。
二、在在全局的异常统一处理
第一种方法用在局部有效,但全局的处理却比较繁琐,那看下面的方法
首先,定义一个存放异常处理函数的类,并使用@ControllerAdvice
修饰。
@Slf4j
@RestControllerAdvice(value = "com.aqiuo.controller")
public class HandlerError {
@ExceptionHandler
public Result exceptionHandler(Exception e) {
log.error("[{}] system error", e);
return Result.fail("错误信息"+e.getCause().getMessage());
}
}
注意到,我是这样编写注解的:
@ControllerAdvice(value = "com.aqiuo.controller")
它用来限定这些异常处理函数起作用的 Controller 的范围。如果不写,则默认对所有 Controller 有效。
这也是 ControllerAdvice 进行统一异常处理的优点,它能够细粒度的控制该异常处理器针对哪些 Controller 有效,这样的好处是:
一个系统里就能够存在不同的异常处理器,Controller 也可以有选择的决定使用哪个,更加灵活。
不同的业务模块可能对异常处理的方式不同,通过该机制就能做到。
设想一个一开始并未使用全局异常处理的系统,如果直接引入全局范围内生效的全局异常处理,势必可能会改变已有 Controller 的行为,有侵入性。也就是说,如果不控制生效范围,即默认对所有 Controller 生效。如果控制生效范围,则默认对所有 Controller 不生效,降低侵入性。
ControllerAdvice 支持的限定范围:
按注解:
@ControllerAdvice(annotations = RestController.class)
按包名:
@ControllerAdvice("org.example.controllers")
文章来源:https://www.toymoban.com/news/detail-765319.html按类型:
@ControllerAdvice(assignableTypes = {ControllerInterface.class, AbstractController.class})
文章来源地址https://www.toymoban.com/news/detail-765319.html
到了这里,关于spring的异常统一处理的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!