项目实战-统一返回数据格式

基本数据格式

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

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

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

列表：

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

分页：

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

没有返回数据：

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

失败：

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

因此，我们定义统一结果

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

创建统一结果返回类

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

2. 创建接口定义返回码

   1. **创建包com.atguigu.commonutils，创建枚举

      public enum ResponseEnum {
      
      
          /**
           * 成功（默认返回状态码）
           */
          SUCCESS(0, "SUCCESS"),
      
      
          /**
           * 错误（默认返回状态码）
           */
          ERROR(0, "ERROR"),
      
          /**
           * 全局未知异常--后台
           */
      
          REQUEST_IS_FAIL(401, "请求失败，请重新登录"),
      
          LOGIN_IS_FAIL(402, "账号名或密码错误"),
      
          NOT_LOGIN(403, "请先登录"),
      
          NO_USER(405, "没有该用户"),
      
          PASSWORD_NO_SAME(407, "两次密码输入不一致"),
      
          SEVER_ERROR(500, "服务器异常,请稍后重试"),
      
          INSERT_OPERATION_FAIL(501, "新增操作失败！"),
      
          UPDATE_OPERATION_FAIL(502, "更新操作失败！"),
      
          NOT_UPDATE_DATE(503,"允许修改的日期已过"),
      
      	Authority_IS_LOWER(507, "更新操作失败！"),
      
      
          /**
           * 错误（参数不完整） --前台
           */
          ERROR_PARAMETER(407, "缺失必要报名信息"),
      
          ERROR_CODE(408, "code无效"),
      
          ERROR_NO_OPENID(409, "没有获得该微信用户的openid"),
      
      
          ;
      
          private int code;
          private String msg;
      
      
      }
      

创建结果类

此处运用了链式编程的设计模式

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

此处运用了方法的重载技术

@Data
public class ResponseResult<T> {


    private Integer status;
    
    private String message;

    private T data;

    public ResponseResult(ResponseEnum responseEnum, T data ) {
        this.status = responseEnum.getCode();
        this.message = responseEnum.getMsg();
        this.data = data;
    }

    public ResponseResult( T data ) {
        this.status = ResponseEnum.SUCCESS.getCode();
        this.message = ResponseEnum.SUCCESS.getMsg();
        this.data = data;
    }

    public ResponseResult() {
        this.status = ResponseEnum.SUCCESS.getCode();
        this.message = ResponseEnum.SUCCESS.getMsg();
    }

    public ResponseResult( ResponseEnum responseEnum ) {
        this.status = responseEnum.getCode();
        this.message = responseEnum.getMsg();
    }


    public static ResponseResult<ResponseEnum> error (String msg ) {
        ResponseResult<ResponseEnum> responseResult = new ResponseResult<>();
        responseResult.setMessage(msg);
        responseResult.setStatus(500);
        return responseResult;
    }

    public static ResponseResult<ResponseEnum> error (Integer status, String msg ) {
        ResponseResult<ResponseEnum> responseResult = new ResponseResult<>();
        responseResult.setMessage(msg);
        responseResult.setStatus(status);
        return responseResult;
    }
    

    public static <E> ResponseResult<E> error (E data ) {
        return new ResponseResult<>(ResponseEnum.ERROR, data);
    }

    public static <E> ResponseResult<E> error (ResponseEnum responseEnum) {
        return new ResponseResult<>(responseEnum);
    }


    public static <E> ResponseResult<E> error (ResponseEnum responseEnum, E data ) {
        return new ResponseResult<>(responseEnum, data);
    }

    public static <E> ResponseResult<E> error () {
        ResponseResult result = new ResponseResult();
        result.setStatus(ResponseEnum.ERROR.getCode());
        result.setMessage(ResponseEnum.ERROR.getMsg());
        return new ResponseResult();
    }


    public static <E> ResponseResult<E> ok (ResponseEnum responseEnum, E data ) {
        return new ResponseResult<>(responseEnum, data);
    }


    public static <E> ResponseResult<E> ok (E data ) {
        return new ResponseResult<>(ResponseEnum.SUCCESS, data);
    }


    public static <E> ResponseResult<E> ok () {
        return new ResponseResult<>();
    }

  
    public static <E> ResponseResult<E> ok (ResponseEnum responseEnum) {
        return new ResponseResult<>(responseEnum);
    }



}

使用

列表

@ApiOperation(value = "所有讲师列表")
@GetMapping
public R list(){
    List<Teacher> list = teacherService.list(null);
    return R.ok().data("items", list);
}

删除

@ApiOperation(value = "根据ID删除讲师")
@DeleteMapping("{id}")
public R removeById(
    @ApiParam(name = "id", value = "讲师ID", required = true)
    @PathVariable String id){
    teacherService.removeById(id);
    return R.ok();
}