spring boot统一返回数据形式

一、统一返回数据格式

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

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

 

例如，我们的系统要求返回的基本数据格式如下：

 

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

因此，我们定义统一结果

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

二、创建统一结果返回类

1、在common模块下创建子模块common-utils

由于后面所有的后端接口都需要用到统一结果返回类 我们将他放在common模块下的子模块common-utils

2、创建接口定义返回码

创建包com.atguigu.commonutils，创建接口 ResultCode.java

public interface ResultCode {
    public static Integer SUCCESS = 20000;//成功
    public static Integer ERROR = 20001;//失败
}

3、创建结果类

创建类 R.java 用于返回结果

package com.atguigu.commonutils;

import 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<>(); //返回数据

    private R(){} //构造方法私有化

    public static R ok(){ //成功的静态方法
        R r = new R();
        r.setSuccess(true);
        r.setCode(ResultCode.SUCCESS);
        r.setMessage("成功");
        return r;
    }
    public static R error(){ //失败的静态方法
        R r = new R();
        r.setSuccess(false);
        r.setCode(ResultCode.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;
    }
}

4 在service模块中添加依赖

我们需要使用 common_utils模块下的工具类 所以需要引入

<dependency>
    <groupId>com.atguigu</groupId>
    <artifactId>common_utils</artifactId>
    <version>0.0.1-SNAPSHOT</version>
</dependency>

5 Controller中的返回结果

controller向前端返回数据时 方法统一返回R类型