项目中统一返回数据格式

原文链接：https://blog.csdn.net/wang_hahah/article/details/110306367

项目中我们会将响应封装成Json返回，一般我们会将所有接口的数据格式统一， 使前端(iOS Android, Web)对数据的操作更一致、轻松。

一般情况下，统一返回数据格式没有固定的格式，只要能描述清楚返回的数据状态以及要返回的具体数据就可以。但是一般会包含状态码、返回消息、数据这几部分内容
例如，我们的系统要求返回的基本数据格式如下：

一般的格式：

    private Boolean success;//成功与否的状态

    private Integer code;//状态码

    private String message;//解释信息

    private Map<String,Object> data = new HashMap<>();//数据体

其中注意事项：

列表:关键字——items

{
  "success": true,
  "code": 20000,
  "message": "成功",
  "data": {
    "items": [
      {
        "id": "1",
        "name": "刘德华",
        "intro": "毕业于师范大学数学系，热爱教育事业，执教数学思维6年有余"
      }
    ]
  }
}

分页:关键字——total、rows

{
  "success": true,
  "code": 20000,
  "message": "成功",
  "data": {
    "total": 17,
    "rows": [
      {
        "id": "1",
        "name": "刘德华",
        "intro": "毕业于师范大学数学系，热爱教育事业，执教数学思维6年有余"
      }
    ]
  }
}

此外需要统一公共代码

public class ResultCode {

    public static Integer SUCCESS = 20000;

    public static Integer ERROR = 40004;
}

最后，我使用的代码则如下，大家可直接CV

package com.libv.rescue.dto;

import com.libv.rescue.common.ResultCode;

import java.util.HashMap;
import java.util.Map;

public class Result {

    private Boolean success;//成功与否的状态

    private Integer code;//状态码

    private String message;//解释信息

    private Map<String,Object> data = new HashMap<>();//数据体

    //返回静态成功方法
    public static Result ok(){
        Result result = new Result();
        result.setSuccess(true);
        result.setCode(ResultCode.SUCCESS);
        result.setMessage("成功");
        return result;
    }

    //返回静态失败方法
    public static Result error(){
        Result result=new Result();
        result.setSuccess(false);
        result.setCode(ResultCode.ERROR);
        result.setMessage("失败");
        return result;
    }

    private Result(){};

    //为了使用链式编程，以下方法返回值用this
    //Result.ok().data()...

    public Result success(Boolean success){
        this.setSuccess(success);
        return this;
    }

    public Result message(String message){
        this.setMessage(message);
        return this;
    }

    public Result code(Integer code){
        this.setCode(code);
        return this;
    }

    public Result data(String key, Object value){
        this.data.put(key, value);
        return this;
    }

    public Result data(Map<String, Object> map){
        this.setData(map);
        return this;
    }

    public Boolean getSuccess() {
        return success;
    }

    public void setSuccess(Boolean success) {
        this.success = success;
    }

    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public Map<String, Object> getData() {
        return data;
    }

    public void setData(Map<String,Object> data) {
        this.data = data;
    }
}