Springboot 全局异常处理+统一后端响应(附源码)

前言

本文主要介绍SpringBoot前后端分离开发模式下，如何友好与前端进行交互。包含controller层统一返回处理，全局异常捕获。

统一后端响应

定义返回格式

@Getter
@AllArgsConstructor
@NoArgsConstructor
public class ResultVo {

    private int code;

    private String msg;

    private Object data;


    // 默认返回成功状态码，数据对象
    public ResultVo(Object data) {
        this.code = ResultCode.SUCCESS.getCode();
        this.msg = ResultCode.SUCCESS.getMsg();
        this.data = data;
    }

    // 返回指定状态码，数据对象
    public ResultVo(StatusCode statusCode, Object data) {
        this.code = statusCode.getCode();
        this.msg = statusCode.getMsg();
        this.data = data;
    }

    public ResultVo(ResultCode status, String msg, Object data) {
        this.code = status.getCode();
        this.msg = msg;
        this.data = data;
    }

    public static ResultVo success(Object data) {
        return new ResultVo(ResultCode.SUCCESS, data);
    }

    public static ResultVo fail(ResultCode status, String msg, Object data) {
        return new ResultVo(status, msg, data);
    }
}

统一状态码

@Getter
public enum ResultCode implements StatusCode {
    SUCCESS(1, "请求成功"),
    FAIL(-1, "操作失败"),

    ERROR_500(500, "服务器未知错误"),
    ERROR_400(400, "错误请求");

    private int code;
    private String msg;

    ResultCode(int code, String msg) {
        this.code = code;
        this.msg = msg;
    }
}

测试代码

    @GetMapping("/response/demo")
    public ResultVo paramValid() {
        return new ResultVo(User.builder().id("1234").accountId("LS998").name("ls").build());
    }

至此，后端返回基本完成，效果如图

问题：如此配置，每次都需要后端开发new ResultVo()，重复工作太多。

解决：Springboot提供了@RestControllerAdvice注解进行控制器全局配置，默认控制全部controller，可通过参数basePackages进行某个包路径下controller控制。

@RestControllerAdvice(basePackages = "com.ls.code.valid")
public class BaseResponseBodyAdvice implements ResponseBodyAdvice<Object> {
    
    @Override
    public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> converterType) {
        return true;
    }

    @Override
    @SneakyThrows
    public Object beforeBodyWrite(Object data, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        return ResultVo.success(data);
    }
}

测试代码：

    @GetMapping("/response/demo")
    public User paramValid() {
        return User.builder().id("1234").accountId("LS998").name("ls").build();
    }

效果如图，自动封装返回结构

问题1：如果某些开发，在此配置下，又在控制器里写了new Result(),会如何？

测试代码

    @GetMapping("/response/demo")
    public ResultVo paramValid() {
        return new ResultVo(User.builder().id("10086").name("ls").build());
    }

效果如图:显然需要对这种情况再次处理，因为没法保证所有开发都和你一样懒

问题2：如果返回String类型会如何

测试代码

    @GetMapping("/response/demo")
    public String paramValid() {
        return "测试代码";
    }

效果如图：内部报错为java.lang.ClassCastException: com.ls.code.valid.common.ResultVo cannot be cast to java.lang.String，显然需要对String类型的返回值进行处理。

问题3：业务中是否有需求为 只返回一个字符串，并不需要和前端交互。如：各种中间件的探活等。只需要返回字符串即可。

解决方案为 将探活接口controller放在全局控制器RestControllerAdvice外。但是不建议这样做，不优美。更好的做法为定义注解。对不需要控制的接口进行单独处理。

最终控制类代码如下：

@RestControllerAdvice(basePackages = "com.ls.code.valid")
public class BaseResponseBodyAdvice implements ResponseBodyAdvice<Object> {

    @Autowired
    private ObjectMapper objectMapper;


    /**
     * @param methodParameter 方法返回的类型
     * @param converterType   参数类型装换
     * @return 返回true 则调用 beforeBodyWrite方法
     */
    @Override
    public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> converterType) {
        //返回类型为ResultVo 或者带有IgnoreResponseAdvice注解 则不进行包装
        return !(methodParameter.getParameterType().isAssignableFrom(ResultVo.class)
                || methodParameter.hasMethodAnnotation(IgnoreResponseAdvice.class));
    }

    @Override
    @SneakyThrows
    public Object beforeBodyWrite(Object data, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        //String类型返回值单独处理
        if (data instanceof String) {
            return objectMapper.writeValueAsString(new ResultVo(data));
        }
        return ResultVo.success(data);
    }
}

 全局异常处理

Springboot提供@ControllerAdvice注解，可以进行全局异常定制

我们所需处理的异常无非三种类型

1：各种参数校验异常，例：账号密码不能为空等 代码以spring-boot-starter-validation为例

如果不进行处理，效果如图

系统内部报错异常为BindException，对BindException异常进行处理。

代码如下：

@ControllerAdvice
@ResponseBody
public class ControllerExceptionAdvice {
    /**
     * 参数校验异常捕获
     *
     * @param e
     * @return
     */
    @ExceptionHandler({BindException.class})
    public ResultVo MethodArgumentNotValidExceptionHandler(BindException e) {
        // 从异常对象中拿到ObjectError对象
        ObjectError objectError = e.getBindingResult().getAllErrors().get(0);
        return new ResultVo(ResultCode.ERROR_400, objectError.getDefaultMessage());
    }
}

效果如图

2：自定义业务异常，开发中，经常要对用户的错误操作进行提示等，需要我们自定义异常，并给出相应的提示 例：商品已下架等

自定义异常代码

@Getter
public class BusinessException extends RuntimeException {
    private Integer code;
    private String msg;

    public BusinessException(ResultCode resultCode, String message) {
        //设置错误详情
        super(message);
        this.code = resultCode.getCode();
        this.msg = resultCode.getMsg();
    }

    public BusinessException(String message) {
        super(message);
        this.code = ResultCode.FAIL.getCode();
        this.msg = ResultCode.FAIL.getMsg();
    }
}

对自定义异常进行响应封装

    /**
     * 业务异常捕获
     *
     * @param e
     * @return
     */
    @ExceptionHandler({BusinessException.class})
    public ResultVo MethodArgumentNotValidExceptionHandler(BusinessException e) {
        return new ResultVo(e.getCode(), e.getMsg(), e.getMessage());
    }

3：服务器异常，例：空指针  。由于异常种类众多，我们不能对每一种异常都做定制化，所以只对Exception进行封装，异常由开发自己保证，而且这些异常返回给前端并没有什么意义。

代码如下：

    @ExceptionHandler({Exception.class})
    public ResultVo MethodArgumentNotValidExceptionHandler(Exception e) {
        log.error(Throwables.getStackTrace(e));
        return ResultVo.fail(ResultCode.ERROR_500, ResultCode.ERROR_500.getMsg(), e.getMessage());
    }

源代码已经上传：https://gitee.com/liushuai2716/code.git