4统一返回数据格式

统一返回数据格式

为了多人开发时，所有接口返回相同格式数据

一般用json数据格式,前端(iOS Android, Web)对数据的操作更一致、轻松

我们定义统一结果

这里很重要，注意理解统一的思想！

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

所有模块都要用到返回结果，所以我们把类放在common里面

建一个common_utils类

创建接口定义返回码

我们可以定义枚举类和常量类（学一学）

定义数据返回状态码

*成功20000

*失败20001

创建包com.atguigu.commonutils，

创建接口interface：ResultCode.java**

package com.atguigu.commonutils;

public interface ResultCode {

    public static Integer SUCCESS = 20000;

    public static Integer ERROR = 20001;
}

定义返回数据格式

定义一个返回类（个人理解）

我们这里创建一个结果类 R.java

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;
    }
}

在settings里面的plugins插件商店安装lombok，不然会报错

以上的做法就是为了做到一个操作：链式编程

里面的值可以被调用到

这里我们说一下链式编程

R.ok（）.code().message().methods()等等

这就是链式编程写法

我们写这些要在controller类里面用到。

下面我们用一下。