SpringBoot统一接口返回和全局异常处理

用户7741497

发布于 2022-02-28 10:27:54

6580

发布于 2022-02-28 10:27:54

文章被收录于专栏：hml_知识记录

一般用法

项目中最常见到的是封装一个工具类，类中定义需要返回的字段信息，把需要返回前端的接口信息，通过该类进行封装，这样就可以解决返回格式不统一的现象了。

public enum ResultMsgEnum {

    SUCCESS(0, "成功"),
    FAIL(-1, "失败"),
    AUTH_ERROR(502, "授权失败!"),
    SERVER_BUSY(503, "服务器正忙，请稍后再试!");

    private int code;
    private String message;
    ResultMsgEnum(int code, String message) {
        this.code = code;
        this.message = message;
    }
    public int getCode() {
        return this.code;
    }
    public String getMessage() {
        return this.message;
    }

}

public class Result<T> {
    private int code;
    private String message;
    private T data;
    public Result() {
    }
    public Result(int code, String message) {
        this.code = code;
        this.message = message;
    }
    /**
     * 成功
     */
    public static <T> Result<T> success(T data) {
        Result<T> result = new Result<T>();
        result.setCode(ResultMsgEnum.SUCCESS.getCode());
        result.setMessage(ResultMsgEnum.SUCCESS.getMessage());
        result.setData(data);
        return result;
    }
    /**
     * 失败
     */
    public static <T> Result<T> error(int code, String message) {
        return new Result(code, message);
    }
}

调用示例

    @RequestMapping("/loginSuccess")
    @ResponseBody
    public Result loginSuccess() {
        HashMap<Object, Object> map = new HashMap<>();
        map.put("user", "zhangsan");
        return Result.success(map);
    }

{
  "code": 0,
  "message": "成功",
  "data": {
    "user": "zhangsan"
  }
}

    @RequestMapping("/loginError")
    @ResponseBody
    public Result loginError() {
        HashMap<Object, Object> map = new HashMap<>();
        map.put("user", "zhangsan");
        int i = 1/0;
        return Result.success(map);
    }

{
  "timestamp": "2021-12-10T06:11:05.159+00:00",
  "status": 500,
  "error": "Internal Server Error",
  "path": "/basic/loginError"
}

通过上面两个例子，我们发现当程序正常返回时已经没有问题了，但是当程序发生异常时，返回的格式很不友好。不处理好这些事情，会严重影响自己在前端小姐姐心中的高大形象的，这是决不能容忍的。

进阶用法

解决这个问题需要两步：

自定义返回数据，统一封装数据返回格式 ResponseBodyAdvice：该接口是SpringMVC 4.1提供的，它允许在执行 @ResponseBody后自定义返回数据，用来封装统一数据格式返回；
全局捕获抛出的异常 @RestControllerAdvice：该注解是对Controller进行增强的，可以全局捕获抛出的异常。

show code

@RestControllerAdvice
public class ResponseAdvice implements ResponseBodyAdvice<Object> {

    @Autowired
    private ObjectMapper objectMapper;

    /**
     * 是否开启功能 true：是
     */
    @Override
    public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
        return true;
    }

    /**
     * 处理返回结果
     */
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        //处理字符串类型数据
        if (body instanceof String) {
            try {
                return objectMapper.writeValueAsString(Result.success(body));
            } catch (JsonProcessingException e) {
                e.printStackTrace();
            }
        }
        //返回类型是否已经封装
        if(body instanceof Result){
            return body;
        }
        return Result.success(body);
    }
}

@RestControllerAdvice
@Slf4j
public class CustomerExceptionHandler {

    /**
     * 自定义异常处理 ServerBusyException
     */
    @ExceptionHandler(ServerBusyException.class)
    public String ErrorHandler(ServerBusyException e) {
        log.error("服务器正忙，请稍后再试!！", e);
        return Result.error(ResultMsgEnum.SERVER_BUSY.getCode(),ResultMsgEnum.SERVER_BUSY.getMessage());
    }

    /**
     * 统一未知异常处理
     */
    @ExceptionHandler(Exception.class)
    public Result Execption(Exception e) {
        log.error("未知异常！", e);
        return Result.error(ResultMsgEnum.FAIL.getCode(),ResultMsgEnum.FAIL.getMessage());
    }

}

测试代码如下：

    @RequestMapping("/loginSuccess")
    @ResponseBody
    public String loginSuccess() {
        return "hello world!";
    }
    返回值：
    {"code":0,"message":"成功","data":"hello world!"}

    @RequestMapping("/loginSuccessMap")
    @ResponseBody
    public Map loginSuccessMap() {
        Map<String, String> map = new HashMap();
        map.put("user", "zhangsan");
        return map;
    }
   返回值：
    {
      "code": 0,
      "message": "成功",
      "data": {
        "user": "zhangsan"
      }
    }

    @RequestMapping("/loginError")
    @ResponseBody
    public Map loginError() {
        HashMap<Object, Object> map = new HashMap<>();
        map.put("user", "zhangsan");
        int i = 1/0;
        return map;
    }
    返回值：
    {
      "code": -1,
      "message": "失败",
      "data": null
    }