Spring Boot 统一接口响应格式的正确姿势

01、背景介绍

熟悉 web 系统开发的同学可能比较熟悉，目前绝大多数的互联网软件平台基本都是前后端分离的开发模式，为了加快前后端接口对接速度，一套完善且规范的接口标准格式是非常有必要的，不仅能够提升开发效率，也会让代码看起来更加简洁、好维护。

今天这篇文章，我们一起来学习一下如何在 Spring Boot 中统一接口的返回数据格式。

02、定义数据返回格式

最常见的一种做法是封装一个工具类，在类中定义需要返回的字段信息，比如状态码、结果描述、结果数据集等，然后在接口中返回给客户端。

例如如下示例。

2.1、定义返回对象

public class ResultMsg<T> {

    /**状态码**/
    private int code;

    /**结果描述**/
    private String message;

    /**结果集**/
    private T data;

    /**时间戳**/
    private long timestamp;

    // set、get方法等...

    public ResultMsg() {
        timestamp = System.currentTimeMillis();
    }

    public static <T> ResultMsg<T> success() {
        return success(null);
    }

    public static <T> ResultMsg<T> success(T data) {
        ResultMsg<T> resultMsg = new ResultMsg<>();
        resultMsg.setCode(ReturnCode.RC200.getCode());