Skip to content

3.响应数据统一 ​

在项目开发中会涉及到很多的接口,这些接口涉及到增、删、改、查各种各样的操作,如果这些操作,给前端响应的结果的格式没有一个统一固定的格式,项目将变得难以维护和管理。因此在前后端交互时,所有的增、删、改、查的接口,无论是请求成功,还是失败,均响应统一格式的结果。

我们可以在服务端定义一个统一响应结果的封装类 Result ,最终我们只需要将这三项数据封装到Result这个类中就可以了

Result属于项目开发中涉及到的通用组件,引入存放在 qk-common 这个模块中。创建包 com.cghbh.common (包名根据自己的需求取即可,推荐做法:包名尽量和 groupId 保持一致)。

Result类代码如下:

java
package com.cghbh.common;

import lombok.Data;

/**
 * 后端统一返回结果
 */
@Data
public class Result {

    private Integer code; // 编码:1成功,0为失败
    private String msg; // 错误信息
    private Object data; // 数据

    public static Result success() {
        Result result = new Result();
        result.code = 1;
        result.msg = "success";
        return result;
    }

    public static Result success(Object object) {
        Result result = new Result();
        result.data = object;
        result.code = 1;
        result.msg = "success";
        return result;
    }

    public static Result error(String msg) {
        Result result = new Result();
        result.msg = msg;
        result.code = 0;
        return result;
    }
}