springboot中对于异常的处理——返回json

异常处理——返回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
}

1. 定义返回值结构信息

@Data
public class ResultMsg {
    private boolean result;
    private int code;
    private String message;
    private Map<String,Object> data = new HashMap<>();

    private ResultMsg() {}

    //成功静态方法
    public static ResultMsg ok(){
        ResultMsg result = new ResultMsg();
        result.setResult(true);
        result.setCode(ResultCode.SUCCESS);//设置状态码
        result.setMessage("成功");//设置消息
        return result;
    }

    //失败静态方法
    public static ResultMsg error(){
        ResultMsg result = new ResultMsg();
        result.setResult(false);
        result.setCode(ResultCode.ERROR);
        result.setMessage("失败");
        return result;
    }

    public ResultMsg result(Boolean result){
        this.setResult(result);
        return this;
    }

    public ResultMsg message(String message){
        this.setMessage(message);
        return this;
    }

    public ResultMsg code(Integer code){
        this.setCode(code);
        return this;
    }

    public ResultMsg data(String key,Object value){
        this.data.put(key,value);
        return this;
    }

    public ResultMsg data(Map<String,Object> map){
        this.setData(map);
        return this;
    }
}

2. 定义返回值和对应code的信息

public interface ResultCode {
    public static Integer SUCCESS = 20000;//成功
    public static Integer ERROR = 20001;//失败
}

3. 自定义异常UserDefinedException

@Data
@AllArgsConstructor//有参构造
@NoArgsConstructor//无参构造
public class UserDefinedException extends RuntimeException{
    private Integer code;//状态码
    private String msg;//异常信息

}

4. RestControllerAdvice来捕获全局异常

@RestControllerAdvice都是对Controller进行增强的,RestControllerAdvice = ControllerAdvice + ResponseBody
@ExceptionHandler(value = Exception.class)
ExceptionHandler的作用是用来捕获指定的异常。

@ControllerAdvice
@Slf4j
public class GlobalExceptionHandler {
    //指定出现什么异常处理这个方法
    @ExceptionHandler(Exception.class)
    @ResponseBody//为了返回数据
    public ResultMsg error(Exception e){
        log.error("当前异常信息为：{}",e);
        return ResultMsg.error().message("执行了全局异常处理...");
    }
    @ExceptionHandler(ArithmeticException.class)
    @ResponseBody
    public ResultMsg error(ArithmeticException e){
        log.error("当前异常信息为：{}",e);
        return ResultMsg.error().message("执行了ArithmeticException异常处理...");
    }

    //自定义异常,想要捕获，需要在catch中 主动抛出
    @ExceptionHandler(UserDefinedException.class)
    @ResponseBody
    public ResultMsg error(UserDefinedException e){
        log.error("当前异常信息为：{}",e);
        return ResultMsg.error().code(e.getCode()).message(e.getMsg());
    }
}

controller中使用：

链式编程

@GetMapping("pageTeacher/{current}/{limit}")
public ResultMsg pageListTeacher(@PathVariable("current") long current,
                         @PathVariable("limit") long limit){
    Page<Teacher> page = new Page<>(current, limit);
    teacherService.page(page, null);
    long total = page.getTotal();//总记录数
    List<Teacher> records = page.getRecords();//数据集合
    return ResultMsg.ok().data("total",total).data("records",records);//另一种方式是将结果都封装到一个map里，一起返回
}

---

2022-04-03 10:19:18 星期日