Java统一返回数据格式

一、统一返回数据格式

前端调用接口返回数据格式没有固定的格式，只要能描述清楚返回的数据状态以及要返回的具体数据就可以。但是在项目中应该包含状态码、返回消息、数据这几部分内容

因此，我们定义统一结果

{
  "success": 布尔, //响应是否成功
  "code": 数字, //响应码
  "message": 字符串, //返回消息
  "data": HashMap //返回数据，放在键值对中
}

1、列表

{
  "success": true,
  "code": 20000,
  "message": "成功",
  "data": {
    "user": [
      {
        "id": "145784548",
        "name": "张国荣",
        "intro": "明星"
      }
    ]
  }
}

2、分页

{
  "success": true,
  "code": 20000,
  "message": "成功",
  "data": {
    "total": 17,
    "rows": [
      {
        "id": "14645121",
        "name": "张国荣",
        "intro": "明星"
      }
    ]
  }
}

3、没有返回数据

{
  "success": true,
  "code": 20000,
  "message": "成功",
  "data": {}
}

4、失败

{
  "success": false,
  "code": 20001,
  "message": "失败",
  "data": {}
}

二、创建统一返回数据格式工具类

1、创建接口定义返回码

public interface ReturnCode {

    //成功状态码
    public static Integer SUCCESS = 200;

    //失败状态码
    public static Integer ERROR = 404;
    
}

2、创建结果类

mport lombok.Data;

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

@Data
public class R {

    //是否成功
    private Boolean success;

    //返回码
    private Integer code;

    //返回消息
    private String message;

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

    private R(){}

    public static R ok(){
        R r = new R();
        r.setSuccess(true);
        r.setCode(ReturnCode.SUCCESS);
        r.setMessage("成功");
        return r;
    }

    public static R error(){
        R r = new R();
        r.setSuccess(false);
        r.setCode(ReturnCode.ERROR);
        r.setMessage("失败");
        return r;
    }

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

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

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

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

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

三、测试