💬接口统一返回对象

> 规范的返回对象有利于减少前后端的摩擦

常规返回对象

{
    "code": 10000,
    "message": "hi js",
    "data": null,
    "ts": 1639114482236,
    "traceId": "9708403571429440",
    "success": false
}

💥code

状态码，标识接口的错误类型，为Integer类型

🤼‍♂️message

消息，接口提示消息，为String类型

🚎data

具体数据，对象，字符串，布尔都可以

⌛ts

调用时间戳 ，为 Long类型

🏃traceId

链路追踪的ID，用于追踪接口的调用过程，利于问题的排除，为String类型

👌success

跟code的相似，表示成功失败的状态，但是没有code表示的类型多，为布尔类型

public class ResultVO<T> implements Serializable {

    private static final long serialVersionUID = -7719394736046024902L;

    /**
     * 返回结果状态码
     */
    @ApiModelProperty(value = "返回结果状态码")
    private Integer code;

    /**
     * 返回消息
     */
    @ApiModelProperty(value = "返回消息")
    private String message;

    /**
     * 数据
     */
    @ApiModelProperty(value = "数据")
    private T data;

    /**
     * 时间戳
     */
    @ApiModelProperty(value = "时间戳")
    private Long ts;

    /**
     * traceId
     */
    @ApiModelProperty(value = "skywalking_traceId")
    @JsonInclude(JsonInclude.Include.NON_EMPTY)
    private String traceId;
}

分页返回对象

跟常规相比 T data变成了 ResourcePage<T> data;

public class ResultPageVO<T> implements Serializable {

    private static final long serialVersionUID = -7719394736046024902L;

    /**
     * 返回结果状态码
     */
    @ApiModelProperty(value = "返回结果状态码")
    private Integer code;

    /**
     * 返回消息
     */
    @ApiModelProperty(value = "返回消息")
    private String message;

    /**
     * 数据
     */
    @ApiModelProperty(value = "数据")
    private ResourcePage<T> data;

    /**
     * 时间戳
     */
    @ApiModelProperty(value = "时间戳")
    private Long ts;
}