在线教育项目--讲师模块（六）----统一返回数据格式

一、统一返回数据格式

项目中我们会将响应封装成json返回，一般我们会将所有接口的数据格式统一， 使前端(iOS Android, Web)对数据的操作更一致、轻松。
一般情况下，统一返回数据格式没有固定的格式，只要能描述清楚返回的数据状态以及要返回的具体数据就可以。但是一般会包含状态码、返回消息、数据这几部分内容
例如，我们的系统要求返回的基本数据格式如下：
列表：

{
  "success": true,
  "code": 20000,
  "message": "成功",
  "data": {
    "items": [
      {
        "id": "1",
        "name": "张三",
        "intro": "近年主持国家自然科学基金（6项）、江苏省重大科技成果转化项目（5项）、江苏省产学研前瞻性联合研究项目（3项）、省工业科技支撑、省高技术、省自然科学基金等省部级及其企业的主要科研项目40多个，多个项目在企业成功转化，产生了较好的经济、社会和环境效益。积极开展产学研科技合作，并与省内16家企业建立了江苏省研究生工作站，其中6家为江苏省优秀研究生工作站",
        "career": "高级",
        "level": 1,
        "avatar": "https://guli-file-190513.oss-cn-beijing.aliyuncs.com/avatar/default.jpg",
        "sort": 0,
        "isDeleted": false,
        "gmtCreate": "2019-10-30 14:18:46",
        "gmtModified": "2019-11-12 13:36:36"
      },
      {
        "id": "1189389726308478977",
        "name": "晴天",
        "intro": "高级讲师简介",
        "career": "高级讲师资历",
        "level": 2,
        "avatar": "https://online-teach-file.oss-cn-beijing.aliyuncs.com/teacher/2019/10/30/de47ee9b-7fec-43c5-8173-13c5f7f689b2.png",
        "sort": 1,
        "isDeleted": false,
        "gmtCreate": "2019-10-30 11:53:03",
        "gmtModified": "2019-10-30 11:53:03"
      },
      {
        "id": "1189390295668469762",
        "name": "李刚",
        "intro": "高级讲师简介",
        "career": "高级讲师",
        "level": 2,
        "avatar": "https://online-teach-file.oss-cn-beijing.aliyuncs.com/teacher/2019/10/30/b8aa36a2-db50-4eca-a6e3-cc6e608355e0.png",
        "sort": 2,
        "isDeleted": false,
        "gmtCreate": "2019-10-30 11:55:19",
        "gmtModified": "2019-11-12 13:37:52"
      },
      {
        "id": "1189426437876985857",
        "name": "王二",
        "intro": "高级讲师简介",
        "career": "高级讲师",
        "level": 1,
        "avatar": "https://online-teach-file.oss-cn-beijing.aliyuncs.com/teacher/2019/11/08/e44a2e92-2421-4ea3-bb49-46f2ec96ef88.png",
        "sort": 0,
        "isDeleted": false,
        "gmtCreate": "2019-10-30 14:18:56",
        "gmtModified": "2019-11-12 13:37:35"
      },
      {
        "id": "1189426464967995393",
        "name": "王五",
        "intro": "高级讲师简介",
        "career": "高级讲师",
        "level": 1,
        "avatar": "https://online-teach-file.oss-cn-beijing.aliyuncs.com/teacher/2019/10/30/65423f14-49a9-4092-baf5-6d0ef9686a85.png",
        "sort": 0,
        "isDeleted": false,
        "gmtCreate": "2019-10-30 14:19:02",
        "gmtModified": "2019-11-12 13:37:18"
      },
      {
        "id": "1192249914833055746",
        "name": "李四",
        "intro": "高级讲师简介",
        "career": "高级讲师",
        "level": 1,
        "avatar": "https://online-teach-file.oss-cn-beijing.aliyuncs.com/teacher/2019/11/07/91871e25-fd83-4af6-845f-ea8d471d825d.png",
        "sort": 0,
        "isDeleted": false,
        "gmtCreate": "2019-11-07 09:18:25",
        "gmtModified": "2019-11-12 13:37:01"
      }
    ]
  }
}

没有返回数据：

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

失败：

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

因此，我们定义统一结果

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

二、创建统一结果返回类

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

2、创建接口定义返回码

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

package com.atguigu.commonutils;

public interface ResultCode {
    public static Integer SUCCESS = 20000;//成功

    public static Integer ERROR = 20001;//失败
}

3、创建结果类

创建类 R.java

package com.atguigu.commonutils;


import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

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

//统一返回结果的类
@Data
public class R {
    @ApiModelProperty(value = "是否成功")
    private Boolean success;

    @ApiModelProperty(value = "返回码")
    private Integer code;

    @ApiModelProperty(value = "返回消息")
    private String message;

    @ApiModelProperty(value = "返回数据")
    private Map<String, Object> data = new HashMap<String, Object>();

    //把构造方法私有
    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;

    }
}

二、统一返回结果使用

1、在service模块中添加依赖

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

2、修改Controller中的返回结果

列表

@Api(description = "讲师管理")
@RestController
@RequestMapping("/edu/teacher")
public class TeacherController {

    //访问地址：http://localhost:8001/edu/teacher/findAll

    //先把service注入进来

    @Autowired
    private TeacherService teacherService;

    //1、查询表中所有数据
    //rest风格
    @ApiOperation(value = "所有讲师列表")
    @GetMapping("findAll")
    public R findAll(){
        //调用Service中的方法做查询操作
        List<Teacher> teachers=teacherService.list(null);
        return R.ok().data("items",teachers);
    }

删除

@Api(description = "讲师管理")
@RestController
@RequestMapping("/edu/teacher")
public class TeacherController {

    //访问地址：http://localhost:8001/edu/teacher/findAll

    //先把service注入进来

    @Autowired
    private TeacherService teacherService;

    //2、逻辑删除讲师方法
    @ApiOperation(value = "逻辑删除讲师")
    @DeleteMapping("{id}")
    //id表示需要通过路径传递值
    public  R removeTeacher(@ApiParam(name="id",value="讲师ID",required = true)@PathVariable String id){
        boolean flag=teacherService.removeById(id);
        if(flag){
            return R.ok();
        }else {
            return R.error();
        }