前言
- 我们日常的开发中，不管是对底层数据库操作，还是业务层或控制层操作，都会不可避免地遇到各种可预知的、不可预知的异常需要处理。
- 如果每个过程都单独处理异常，那么系统的代码耦合度高，工作量大且不好统一，以后维护的工作量也很大。
- 如果能将所有类型的异常处理从各层中解耦出来，这样既保证了相关处理过程的功能单一，又实现了异常信息的统一处理和维护。
上面阐述的问题，我们在使用SpringBoot之后都能解决，我们可以使用如下3种方式处理异常：
- 使用@ExceptionHandler注解
- 实现HandlerExceptionResolver接口
- 使用@ControllerAdvice注解+@ExceptionHandler注解
1. 使用@ExceptionHandler注解
假设前端发送请求后端，然后后端处理的时候发生异常，这时可以有三种方式通知前端：
- 返回异常页面(不包含错误信息)。下面返回"exception"为异常视图名称(我们自己编写的异常页面)。
@Controller
public class ExceptionHandlerController {
@ExceptionHandler(RuntimeException.class)
public String exception(Exception e){
e.printStackTrace();
return "exception";
}
@RequestMapping("/exception")
public void exception(){
int i = 5/0;
}
}
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>exception</title>
</head>
<body>
正在处理中，请稍等...
</body>
</html>
- 返回ModelAndView。既返回视图，也返回异常信息。
@ExceptionHandler(RuntimeException.class)
public ModelAndView exception(RuntimeException e){
ModelAndView mv = new ModelAndView();
mv.addObject("msg",e.getMessage());
mv.setViewName("/exception");
e.printStackTrace();
return mv;
}
@RequestMapping("/exception")
public void exception(){
int i = 5/0;
}
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.w3.org/1999/xhtml">
<head>
<meta charset="UTF-8">
<title>exception</title>
</head>
<body>
<div th:text="${msg}">正在处理中，请稍等...</div>
</body>
</html>
在上面我们把异常信息存储在Model，然后在异常页面显示异常信息。
在这里插入图片描述
- 返回JSON格式数据。在前后端分离的情况下，大多都是返回JSON格式数据，这里我们规定如果出现异常，也返回JSON格式数据。
响应实体类
@Data
public class MyResponse<T> {
private Long statusCode; //响应状态码
private T data; //响应数据
}
@ExceptionHandler(RuntimeException.class)
//表示返回JSON格式数据
@ResponseBody
public MyResponse<String> exception(RuntimeException e){
//在控制台打印
e.printStackTrace();
MyResponse<String> response = new MyResponse();
//出现的异常都返回500状态码
response.setStatusCode(500);
response.setData(e.getMessage());
return response;
}
@RequestMapping("/exception")
public void exception(){
int i = 5/0;
}
这样我们在发生异常的时候，也能返回JSON数据了。
在这里插入图片描述
注意点
- 使用@ExceptionHandler注解有一个不好的地方就是：进行异常处理的方法必须与出错的方法在同一个Controller里面。
- 这种方式不能实现全局异常处理。
2.实现HandlerExceptionResolver接口
- 这种方式可以实现全局的异常控制，只要在系统运行中发生异常，它都会捕获到。
- 实现该接口，必须重写resolveException方法，该方法就是异常处理逻辑，只能返回ModelAndView 对象。
@Component
public class MyGlobalException implements HandlerExceptionResolver {
@Override
public ModelAndView resolveException(HttpServletRequest httpServletRequest,
HttpServletResponse httpServletResponse, Object o, Exception e) {
ModelAndView mv = new ModelAndView();
mv.addObject("msg",e.getMessage());
mv.setViewName("/exception");
e.printStackTrace();
return mv;
}
}
3.使用@ControllerAdvice注解+@ExceptionHandler注解
- 上面说到@ExceptionHandler需要进行异常处理的方法必须与出错的方法在同一个Controller里面。那么当代码加入了 @ControllerAdvice，则不需要必须在同一个controller中了。
- 从名字上可以看出大体意思是控制器增强。 也就是说，@controlleradvice+@ExceptionHandler也可以实现全局的异常捕捉。
@Data
@AllArgsConstructor
@NoArgsConstructor
public class ExceptionResponse<T> {
private T data;
}
@ControllerAdvice
@ResponseBody
@Slf4j
public class GlobalExceptionHandle {
/**
* 捕获404异常
* @return
*/
@ResponseStatus(HttpStatus.NOT_FOUND)
@ExceptionHandler(NoHandlerFoundException.class)
public ExceptionResponse notFoundException(NoHandlerFoundException e){
log.error("资源未找到",e);
return new ExceptionResponse<>("你好，你要的资源找不到！");
}
/**
* 400——Bad Request
*/
@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler(HttpMessageNotReadableException.class)
public ExceptionResponse handleHttpMessageNotReadableException(HttpMessageNotReadableException e) {
log.error("参数解析失败", e);
return new ExceptionResponse<>("bad request");
}
/**
* 405——Method Not Allowed
* @param e
* @return
*/
@ResponseStatus(HttpStatus.METHOD_NOT_ALLOWED)
@ExceptionHandler(HttpRequestMethodNotSupportedException.class)
public ExceptionResponse<String> handleHttpRequestMethodNotSupportedException(HttpRequestMethodNotSupportedException e){
log.error("不支持当前请求方法",e);
return new ExceptionResponse<>("request_method_not_supported");
}
/**
* 415——Unsupported Media Type
* @param e
* @return
*/
@ResponseStatus(HttpStatus.UNSUPPORTED_MEDIA_TYPE)
@ExceptionHandler(HttpMediaTypeNotSupportedException.class)
public ExceptionResponse handleHttpMediaTypeNotSupportedException(HttpMediaTypeNotSupportedException e){
log.error("不支持当前媒体",e);
return new ExceptionResponse("content_type_not_supported");
}
/**
* 500：服务器内部异常
* @param e
* @return
*/
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
@ExceptionHandler
public ExceptionResponse internalServerError(Exception e){
log.error("服务器内部异常",e);
return new ExceptionResponse("你好，请稍等会...");
}
}
- 在上面代码中，定义了捕获各种异常处理方法，不同的类型异常由不同的异常处理方法进行处理。
- 需要注意一点，就是SpringBoot默认不支持捕获404异常，需要添加下面两行配置才能使捕获404异常生效。
#出现错误时, 直接抛出异常
spring.mvc.throw-exception-if-no-handler-found=true
#不要为我们工程中的资源文件建立映射
spring.resources.add-mappings=false
测试404异常以及500异常
- 在浏览器中输入：http://localhost:8888/exception/404exception，就会报404异常，由上面定义的异常处理方法捕获
在这里插入图片描述 - 在浏览器输入：http://localhost:8888/exception，就会报500异常，也是由上面定义的异常处理方法捕获
在这里插入图片描述
上面我们是具体的异常类型分别定义异常捕获方法，我们也可以不那样做，不区分类型捕获全部异常
@ControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler
@ResponseBody
String globalHandleException(Exception e){
return "Exception Deal! " + e.getMessage();
}
}
上面的全局异常处理方法我们都是返回JSON数据。我们只需要把方法返回值修改为ModelAndView，也能返回视图域与模型数据了。
这样介绍完了SpringBoot全局异常处理机制，上面所说的几乎包含了开发中常见的异常处理方式。
如果大家觉得不错的话，可以👍或者关注一下博主我。
