SpringBoot 无侵入式实现 API 接口统一 JSON 格式返回

点击上方 一个优秀的废人 ，选择设为星标

优质文章，及时送达

来源：blog.csdn.net/qq_34347620/article/details/102239179

无侵入式统一返回 JSON 格式

其实本没有没打算写这篇博客的，但还是要写一下写这篇博客的起因是因为，现在呆着的这家公司居然没有统一的 API 返回格式？，询问主管他居然告诉我用 HTTP 状态码就够用了（fxxk），天哪 HTTP 状态码真的够用吗？

在仔细的阅读了项目源码后发现，在 API 请求的是居然没有业务异常（黑人问号）。好吧居然入坑了只能遵照项目风格了，懒得吐槽了。

因为项目已经开发了半年多了，要是全部接口都做修改工作量还是挺大的，只能用这种无侵入式的方案来解决.

❝

项目源代码: https://github.com/469753862/galaxy-blogs/tree/master/code/responseResult

❞

定义返回 JSON 格式

后端返回给前端一般情况下使用 JSON 格式，定义如下

`{
    "code": 200,
    "message": "OK",
    "data": {

}
}
`

code: 返回状态码
message: 返回信息的描述
data: 返回值

定义状态码枚举类

`@ToString
@Getter
public enum ResultStatus {

    SUCCESS(HttpStatus.OK, 200, "OK"),
    BAD_REQUEST(HttpStatus.BAD_REQUEST, 400, "Bad Request"),
    INTERNAL_SERVER_ERROR(HttpStatus.INTERNAL_SERVER_ERROR, 500, "Internal Server Error"),;

    /** 返回的HTTP状态码,  符合http请求 /
    private HttpStatus httpStatus;
    /* 业务异常码 /
    private Integer code;
    /* 业务异常信息描述 */
    private String message;

    ResultStatus(HttpStatus httpStatus, Integer code, String message) {
        this.httpStatus = httpStatus;
        this.code = code;
        this.message = message;
    }
}
`

状态码和信息以及 http 状态码就能一一对应了便于维护，有同学有疑问了为什么要用到 http 状态码呀，因为我要兼容项目以前的代码，没有其他原因，当然其他同学不喜欢 http 状态码的可以吧源码中 HttpStatus 给删除了

定义返回体类

`@Getter
@ToString
public class Result {
    /** 业务错误码 /
    private Integer code;
    /* 信息描述 /
    private String message;
    /* 返回参数 */
    private T data;

    private Result(ResultStatus resultStatus, T data) {
        this.code = resultStatus.getCode();
        this.message = resultStatus.getMessage();
        this.data = data;
    }

    /** 业务成功返回业务代码和描述信息 */
    public static Result success() {
        return new Result(ResultStatus.SUCCESS, null);
    }

    /** 业务成功返回业务代码,描述和返回的参数 */
    public static  Result success(T data) {
        return new Result(ResultStatus.SUCCESS, data);
    }

    /** 业务成功返回业务代码,描述和返回的参数 */
    public static  Result success(ResultStatus resultStatus, T data) {
        if (resultStatus == null) {
            return success(data);
        }
        return new Result(resultStatus, data);
    }

    /** 业务异常返回业务代码和描述信息 */
    public static  Result failure() {
        return new Result(ResultStatus.INTERNAL_SERVER_ERROR, null);
    }

    /** 业务异常返回业务代码,描述和返回的参数 */
    public static  Result failure(ResultStatus resultStatus) {
        return failure(resultStatus, null);
    }

    /** 业务异常返回业务代码,描述和返回的参数 */
    public static  Result failure(ResultStatus resultStatus, T data) {
        if (resultStatus == null) {
            return new Result(ResultStatus.INTERNAL_SERVER_ERROR, null);
        }
        return new Result(resultStatus, data);
    }
}
`

因为使用构造方法进行创建对象太麻烦了，我们使用静态方法来创建对象这样简单明了

Result 实体返回测试

`@RestController
@RequestMapping("/hello")
public class HelloController {

private static final HashMap<String, Object> INFO;

    static {
        INFO = new HashMap<>();
        INFO.put("name", "galaxy");
        INFO.put("age", "70");
    }

    @GetMapping("/hello")
    public Map<String, Object> hello() {
        return INFO;
    }

    @GetMapping("/result")
    @ResponseBody
    public Result<Map<String, Object>> helloResult() {
        return Result.success(INFO);
    }
}
`

到这里我们已经简单的实现了统一 JSON 格式了，但是我们也发现了一个问题了，想要返回统一的 JSON 格式需要返回 Result<Object> 才可以，我明明返回 Object 可以了，为什么要重复劳动，有没有解决方法，当然是有的啦，下面我们开始优化我们的代码吧

统一返回 JSON 格式进阶 - 全局处理 (@RestControllerAdvice)

我师傅经常告诉我的一句话: “你就是一个小屁孩，你遇到的问题都已经不知道有多少人遇到过了，你会想到的问题，已经有前辈想到过了。你准备解决的问题，已经有人把坑填了”。是不是很鸡汤，是不是很励志，让我对前辈们充满着崇拜，事实上他对我说的是: “自己去百度”, 这五个大字，其实这五个大字已经说明上明的 B 话了，通过不断的百度和 Google 发现了很多的解决方案.

我们都知道使用 @ResponseBody 注解会把返回 Object 序列化成 JSON 字符串，就先从这个入手吧，大致就是在序列化前把 Object 赋值给 Result<Object> 就可以了，大家可以观摩 org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice 和 org.springframework.web.bind.annotation.ResponseBody