当前位置：首页 > news >正文

设计后端返回给前端的返回体

news 来源：原创 2025/5/25 5:32:28

1、为什么要设计返回体？

2、返回体包含哪些内容（如何设计）？

举例

3、总结

1、为什么要设计返回体？

在设计后端返回给前端的返回体时，通常需要遵循一定的规范，以确保前后端交互的清晰性、可维护性和可扩展性。

2、返回体包含哪些内容（如何设计）？

返回体通常包含以下内容：

code: 状态码，用于表示请求的处理结果（如成功、失败、异常等）。
message: 消息描述，用于对状态码的补充说明（如错误原因、成功提示等）。
data: 返回的具体数据，可以是对象、数组或其他数据类型。
timestamp: 时间戳，表示返回体的生成时间（可选，用于调试或日志记录）。（可选）

举例

在utils工具包下，新建一个类：Result。

此类专门用来生成对象，返回给前端。

@Data//lombok提供的一个注解，自动生成get、set方法
public class Result<T> {
    //属性
    private int code;//状态码，如：404代表资源未找到
    private String message;//描述消息，如：前端请求成功是，message为“操作成功”
    private T data;//返回的具体数据,用泛型可以接收各类的对象

    //提供几种构造器，以应对不同的场景
    //无参构造
    public Result() {
    }
    //code + message  举例：前端请求失败时，返回401 + “用户未登录”
    public Result(int code, String message) {
        this.code = code;
        this.message = message;
    }
    //code + data
    public Result(int code, T data) {
        this.code = code;
        this.data = data;
    }
    //全参构造器
    public Result(int code, String message, T data) {
        this.code = code;
        this.message = message;
        this.data = data;
    }
}

3、总结

一个良好的返回体设计应具备以下特点：

结构清晰：明确区分状态码、消息和数据。
状态码规范：使用 HTTP 状态码或自定义状态码。
消息友好：提供明确的成功或错误提示。
数据灵活：根据业务需求返回不同类型的数据。
异常处理：对异常情况提供明确的错误信息。

通过遵循这些原则，可以显著提高前后端协作的效率和质量。