SpringBoot 异常处理机制
文章目录
- SpringBoot 异常处理机制
- 1. SpringBoot的默认异常机制
- 2. 自定义错误视图
- 3. 自定义异常处理
- 3.1 @ControllerAdvice+@ExceptionHandler处理全局异常
- 3.2 @ResponseStatus+自定义异常类
- 3.3 自定义实现 HandlerExceptionResolver 处理异常
1. SpringBoot的默认异常机制
如果访问到了不存在的页面,或者服务器内出现了异常,SpringBoot会返回默认的错误页面。
可以将自定义的错误页面放到SpringBoot的默认规则下的路径。
默认规则:
- 默认情况下,Spring Boot提供
/error
处理所有错误的映射
- 也就是我们在
/error
目录下放置的页面可以处理对应的错误映射。例如:4xx.html处理4xx错误,5xx.html处理5xx错误。
- 对于机器客户端,它将生成JSON响应,其中包含错误,HTTP状态和异常消息的详细信息。
- 对于浏览器客户端,响应一个“ whitelabel”错误视图,以HTML格式呈现相同的数据
2. 自定义错误视图
注意: 当前使用的模板引擎是Thymeleaf。
错误视图被放置在templates/error
目录中。
启动SpringBoot主程序,访问一个不存在的页面:
编写一个Controller方法模拟错误:
@RequestMapping("/testError")
public String testError() {
int i = 10 / 0;
return "main.jsp";
}
3. 自定义异常处理
共有三种方式:
3.1 @ControllerAdvice+@ExceptionHandler处理全局异常
- 实现方式是自定义一个异常处理类,只需要在该类上标记
@ControllerAdvice
即可。 - 同时要在执行异常处理的方法上标记
@ExceptionHandler
。这样在发生了指定异常时可以找到响应的异常处理方法进行处理。 - 底层是 ExceptionHandlerExceptionResolver 支持的
代码演示:
/**
* 处理整个web controller的异常
*/
@Slf4j
@ControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler({ArithmeticException.class}) // 可以处理多种异常
public String handleArithmeticException() {
log.info("处理异常");
// 也可以返回ModelAndView类型对象,因为在处理异常相关源码中最后也会渲染视图转化为ModelAndView
return "error";
}
@ExceptionHandler({NullPointerException.class})
public String handleNullPointerException(Exception e) {
log.info("处理异常");
return "error";
}
}
@ControllerAdvice 注解的原理是SpringAOP提供的,是将Controller层的方法作为切面,从而对Controller层方法进行拦截处理。
如果是前后端分离的项目也可以使用 @RestControllerAdvice 注解。
3.2 @ResponseStatus+自定义异常类
- 通过这个方式可以将我们自定义的异常的状态码和信息返回。
/**
* 表示该异常最后会返回一个状态码信息
* value: 状态码
* reason: 原因
*/
@ResponseStatus(value = HttpStatus.FORBIDDEN, reason = "xxx原因")
public class CustomerException extends RuntimeException {
public CustomerException() {
}
public CustomerException(String message) {
super(message);
}
}
- 测试:
@RequestMapping("/testCustomerError")
public String testCustomerError() {
if (true) {
throw new CustomerException();
}
return "main";
}
- 错误界面展示:
3.3 自定义实现 HandlerExceptionResolver 处理异常
- 可以作为默认的全局异常处理规则(注意:设置为最高优先级会顶替掉SpringBoot原生的异常处理规则)
// SpringBoot底层会优先调用SpringBoot定义的异常处理器(ExceptionResolver)
// 使用@Order注解可以定义ExceptionResolver异常处理器的优先级
// 值越小,优先级越高
// Ordered.HIGHEST_PRECEDENCE ===> Integer.MIN_VALUE;
@Order(value = Ordered.HIGHEST_PRECEDENCE)
@Component
public class CustomerHandlerExceptionResolver implements HandlerExceptionResolver {
@Override
public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
try {
response.sendError(511, "xxx错误");
} catch (IOException e) {
e.printStackTrace();
}
ModelAndView modelAndView = new ModelAndView();
return modelAndView;
}
}