springboot 封装api统一格式返回值

最新推荐文章于 2025-04-24 21:46:10 发布

原创最新推荐文章于 2025-04-24 21:46:10 发布 · 4k 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#openAPI 返回值统一格式封装

后台开发专栏收录该内容

3 篇文章

订阅专栏

本文介绍了一种在前后端分离项目中统一返回值的设计方案，通过创建CommonReturn类实现状态和数据的标准化返回，便于前端开发和错误提示。文章详细展示了CommonReturn类的实现方式，并提供了业务调用成功与失败时的返回示例。

现在大多数项目采用前后分离的模式进行开发。统一返回方便前段进行开发和提醒用户操作出现错误原因。

约定返回值格式为

{
  "status":"success/fail" ,
   "data":{
        //成功时 status时success 且data域中的值为VO对象
        //业务调用失败或者出现错误时  status为fail，且data域中为 errCode errMsg
}

}

创一个一个CommonReturnType.class

/***
 *  统一返回值格式
 */
@Data
public class CommonReturn {
    private String status;
    private Object data;


    public static CommonReturn create(Object data){
        return CommonReturn.create(data,"success");
    }

    public static CommonReturn create(Object data, String status) {
        CommonReturn commonReturn = new CommonReturn();
        commonReturn.setStatus(status);
        commonReturn.setData(data);
        return commonReturn;
    }

}

之后再业务层进行开发时 controller层业务处理返回的值为我们定义的CommonResultType类型

到此通过postMan进行测试业务调用失败结果为：

{
    "status": "fail",
    "data": {
        "errCode": 10001,
        "errMsg": "姓名不能为空"
    }
}

业务调用成功返回示例：

{
    "status": "success",
    "data": {
        "id": 20181230011845,
        "name": "张三",
        "age": 18
    }
}