SpringBoot返回统一的JSON标准格式

Posted 2022-11-27 pcdd

1. 自定义状态码枚举类
2. 封装返回结果
3. 全局异常捕获处理，使用@RestControllerAdvice注解
4. 拦截Controller方法的返回值，统一处理返回值/响应体
5. 创建Controller，准备测试
6. 请求接口，查看响应结果

近年来，随着移动互联网的发展,各种类型的客户端层出不穷。如果不统一数据接口,则会造成冗余编码,增加成本。RESTful风格的API正适合通过一套统一的接口为PC、手机APP等设备提供数据服务。

为了保障前后端数据交换的顺畅，建议规范数据的返回，并采用固定的数据格式封装。如：
返回成功信息的JSON格式如下

  "code": 200,
  "msg": "操作成功",
  "data": "hello jenkins"

返回异常信息的JSON格式如下

  "code": 500,
  "msg": "系统异常，请稍后重试：/ by zero"

实现步骤如下

1. 自定义状态码枚举类（不是HTTP状态码）

@AllArgsConstructor
@Getter
public enum StatusCodeEnum 
    SC200(200, "操作成功"),
    SC999(999, "操作失败"),
    SC401(401, "匿名用户访问权限资源时的异常"),
    SC403(403, "无访问权限，请联系管理员授予权限"),
    SC404(404, "请求的资源不存在"),
    SC500(500, "系统异常，请稍后重试"),
    // ...略
    private final Integer code;
    private final String msg;

2. 封装返回结果

类名可任意取，可根据个人习惯或项目编码规约选择。比如Result、ResultXxx、R、ApiResult、Response、ResponseXxx等等，这里命名为ApiResult

@Data
public class ApiResult<T> implements Serializable 
    private Integer code;
    private String msg;
    private T data;

    public static <T> ApiResult<T> success(T data) 
        return ApiResult.success(StatusCodeEnum.SC200.getMsg(), data);
    

    public static <T> ApiResult<T> success(String msg, T data) 
        ApiResult<T> apiResult = new ApiResult<>();
        apiResult.setCode(StatusCodeEnum.SC200.getCode());
        apiResult.setMsg(msg);
        apiResult.setData(data);
        return apiResult;
    

    public static <T> ApiResult<T> fail(Integer code, String msg) 
        ApiResult<T> apiResult = new ApiResult<>();
        apiResult.setCode(code);
        apiResult.setMsg(msg);
        return apiResult;
    

3. 全局异常捕获处理，使用@RestControllerAdvice注解。

@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler 
    /**
     * 捕获其他异常
     */
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ExceptionHandler(Exception.class)
    public ApiResult<String> handle(Exception e) 
        log.error("全局异常信息：", e.getMessage());
        return ApiResult.fail(StatusCodeEnum.SC500.getCode(), StatusCodeEnum.SC500.getMsg() + "：" + e.getMessage());
    

注解	功能
@RestControllerAdvice	RestController的增强类，可用于实现全局异常处理器
@ExceptionHandler	统一处理某一类异常，从而减少代码重复率和复杂度，比如要获取自定义异常可以@ExceptionHandler(BusinessException.class)
@ResponseStatus	指定客户端收到的http状态码

注：请求进来 会按照 filter -> interceptor -> controllerAdvice -> aspect -> controller的顺序调用，
404异常（NoHandlerFoundException）是无法通过这种方式捕获的，因为在Filter层发生的异常都会到Spring默认的异常处理。如果你在配置文件配置了server.error.path的话，就会使用你配置的异常处理地址，如果没有就会使用你配置的error.path路径地址，如果还是没有，默认使用/error来作为发生异常的处理地址。如果想要替换默认的非Controller异常处理直接实现Spring提供的ErrorController接口就行了。

第四步是重点

4. 拦截Controller方法的返回值，统一处理返回值/响应体。

因为我们后面每写一个接口都需要调用ApiResult.success()这行代码对结果进行包装，重复劳动，浪费体力，我们只需要实现SpringBoot提供的ResponseBodyAdvice接口即可解决这一问题。

@RestControllerAdvice
public class ApiResultWrapper implements ResponseBodyAdvice<Object> 

    /**
     * 是否支持advice功能
     */
    @Override
    public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) 
        return true;
    

    /**
     * 对返回的数据进行处理
     */
    @Override
    public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) 
        if (o instanceof String) 
            return JSON.toJSONString(ApiResult.success(o));
        
        // 这个判断的作用：防止全局异常处理后返回的结果（类型为ApiResult）再次被包装
        if (o instanceof ApiResult) 
            return o;
        
        return ApiResult.success(o);
    
    

5. 创建Controller，定义两个方法，让第二个方法抛异常

实现ResponseBodyAdvice接口后，方法的返回值类型就可以不再是先前统一的ApiResult了。

@RestController
public class TestController 

    @GetMapping("/test1")
    public String test1() 
        return "当前时间：" + LocalDateTime.now().format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
    

    @GetMapping("/test2")
    public Integer test2() 
        System.out.println(1 / 0);
        return Integer.MAX_VALUE;
    
    

6. 测试

分别请求http://localhost:8080/test1、http://localhost:8080/test2，结果如下

在全局异常处理类中写了一行代码

log.error("全局异常信息：", e.getMessage());

所以调用test2方法时控制台打印异常信息如下