异常处理——返回json
对于日常开发而言,因是否采用前后端分离的方式,异常信息的处理也将分为两类,
- 返回html页面,
- 直接返回json数据
本文主要介绍返回json的方式
底层原理
对于在doDispatch执行过程中产生的异常(404除外,算是特殊情况),在执行视图解析的过程中,会对产生的异常逐一通过各种异常解析器进行解析,异常解析器默认有两种,一种是默认用于给默认信息赋值的,没什么用,另一个是系统自带的HandlerExceptionResolverComposite,在它里面藏了三个异常解析器,如下图所示
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-C25ZfLw3-1648952978308)(http://www.chajianbao.store:8001/upload-images/2022/04/03/1648952347929.png “图片title”)]
- ExceptionHandlerExceptionResolver:基于@ControllerAdvice和@ExceptionHandler注解的解析器,返回值和controller类似,最后都会封装成ModelAndView对象,因此可以指定异常数据显示的视图地址(例如放到error/error.html),或者和下面两个一样,手动调用一下response.sendError()
- ResponseStatusExceptionResolver:基于@ResponseStatus的解析器,一般和自定义的异常类一起使用,该方法内部会根据@ResponseStatus注解的信息请求转发到/error中(底层是调用了response.sendError(statusCode,resolvedReason))
- DefaultHandlerExceptionResolen:springboot中提供的在框架运行过程中可能出现异常进行的处理的默认异常处理器,同样的根据异常请求转发到/error中
基于@ControllerAdvice和@ExceptionHandler注解方法
返回值格式:
- 请求处理是否成功:result
- 处理结果编码:code
- 编码对应的文本信息:message
- 返回值数据:data
如下图
{
"result": true,
"code": 20000,
"message": "成功",
"data": {
"lantian": 17,
"qingfen": 16,
"baiyun": 18
}
}
因此,对于发生异常的情况,我们希望返回的格式也是这种,因此要对异常处理器进行设置,例如如下形式
{
"result": false,
"code": 20001,
"message": "失败",
"data": null
}
- 定义返回值结构信息
@Data
public class ResultMsg {
private boolean result;
private int code;
private String message;
private Map<String,Object> data