SpringBoot返回统一的JSON标准格式实现步骤

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

@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;
}

@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;
    }

}

@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());
    }
}

@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);
    }

}

@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;
    }
}

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