后端给前端统一返回结果

分手后的思念是犯贱 2021-07-24 11:17 805阅读 0赞

# 一 统一返回数据格式 #

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

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

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

1 列表

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

2 分页

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

3 没有返回数据

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

4 失败

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

分析上面4种情况，我们定义统一结果如下

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

# 二 定义统一返回结果 #

1 创建返回码定义枚举类

在 common\_util 中

创建包：[com.atguigu.guli.common.base.result][]

创建枚举类： ResultCodeEnum.java

@Getter
    @ToString
    public enum ResultCodeEnum {
    
        SUCCESS(true, 20000, "成功"),
        UNKNOWN_REASON(false, 20001, "未知错误"),
    
        BAD_SQL_GRAMMAR(false, 21001, "sql语法错误"),
        JSON_PARSE_ERROR(false, 21002, "json解析异常"),
        PARAM_ERROR(false, 21003, "参数不正确"),
    
        FILE_UPLOAD_ERROR(false, 21004, "文件上传错误"),
        FILE_DELETE_ERROR(false, 21005, "文件刪除错误"),
        EXCEL_DATA_IMPORT_ERROR(false, 21006, "Excel数据导入错误"),
    
        VIDEO_UPLOAD_ALIYUN_ERROR(false, 22001, "视频上传至阿里云失败"),
        VIDEO_UPLOAD_TOMCAT_ERROR(false, 22002, "视频上传至业务服务器失败"),
        VIDEO_DELETE_ALIYUN_ERROR(false, 22003, "阿里云视频文件删除失败"),
        FETCH_VIDEO_UPLOADAUTH_ERROR(false, 22004, "获取上传地址和凭证失败"),
        REFRESH_VIDEO_UPLOADAUTH_ERROR(false, 22005, "刷新上传地址和凭证失败"),
        FETCH_PLAYAUTH_ERROR(false, 22006, "获取播放凭证失败"),
    
        URL_ENCODE_ERROR(false, 23001, "URL编码失败"),
        ILLEGAL_CALLBACK_REQUEST_ERROR(false, 23002, "非法回调请求"),
        FETCH_ACCESSTOKEN_FAILD(false, 23003, "获取accessToken失败"),
        FETCH_USERINFO_ERROR(false, 23004, "获取用户信息失败"),
        LOGIN_ERROR(false, 23005, "登录失败"),
    
        COMMENT_EMPTY(false, 24006, "评论内容必须填写"),
    
        PAY_RUN(false, 25000, "支付中"),
        PAY_UNIFIEDORDER_ERROR(false, 25001, "统一下单错误"),
        PAY_ORDERQUERY_ERROR(false, 25002, "查询支付结果错误"),
    
        ORDER_EXIST_ERROR(false, 25003, "课程已购买"),
    
        GATEWAY_ERROR(false, 26000, "服务不能访问"),
    
        CODE_ERROR(false, 28000, "验证码错误"),
    
        LOGIN_PHONE_ERROR(false, 28009, "手机号码不正确"),
        LOGIN_MOBILE_ERROR(false, 28001, "账号不正确"),
        LOGIN_PASSWORD_ERROR(false, 28008, "密码不正确"),
        LOGIN_DISABLED_ERROR(false, 28002, "该用户已被禁用"),
        REGISTER_MOBLE_ERROR(false, 28003, "手机号已被注册"),
        LOGIN_AUTH(false, 28004, "需要登录"),
        LOGIN_ACL(false, 28005, "没有权限"),
        SMS_SEND_ERROR(false, 28006, "短信发送失败"),
        SMS_SEND_ERROR_BUSINESS_LIMIT_CONTROL(false, 28007, "短信发送过于频繁");
    
    
        private Boolean success;
    
        private Integer code;
    
        private String message;
    
        ResultCodeEnum(Boolean success, Integer code, String message) {
            this.success = success;
            this.code = code;
            this.message = message;
        }
    }

2 创建结果类

[com.atguigu.guli.common.base.result][] 中创建类 R.java

/**
     * @className: R
     * @description: 全局统一返回结果
     * @date: 2020/11/16
     * @author: cakin
     */
    @Data
    @ApiModel(value = "全局统一返回结果")
    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>();
    
        public R(){}
    
        /**
         * 功能描述：成功返回
         *
         * @author cakin
         * @date 2020/11/16
         * @return R 成功返回结果
         * @description:
         */
        public static R ok(){
            R r = new R();
            r.setSuccess(ResultCodeEnum.SUCCESS.getSuccess());
            r.setCode(ResultCodeEnum.SUCCESS.getCode());
            r.setMessage(ResultCodeEnum.SUCCESS.getMessage());
            return r;
        }
    
        /**
         * 功能描述：失败返回
         *
         * @author cakin
         * @date 2020/11/16
         * @return R 失败返回结果
         */
        public static R error(){
            R r = new R();
            r.setSuccess(ResultCodeEnum.UNKNOWN_REASON.getSuccess());
            r.setCode(ResultCodeEnum.UNKNOWN_REASON.getCode());
            r.setMessage(ResultCodeEnum.UNKNOWN_REASON.getMessage());
            return r;
        }
    
        /**
         * 功能描述：设置返回结果
         *
         * @author cakin
         * @date 2020/11/16
         * @param resultCodeEnum 结果枚举
         * @return R 返回给前端的结果
         */
        public static R setResult(ResultCodeEnum resultCodeEnum){
            R r = new R();
            r.setSuccess(resultCodeEnum.getSuccess());
            r.setCode(resultCodeEnum.getCode());
            r.setMessage(resultCodeEnum.getMessage());
            return r;
        }
    
        /**
         * 功能描述：设置success状态
         *
         * @author cakin
         * @date 2020/11/16
         * @param success 值为true或false
         * @return R 返回给前端的数据
         */
        public R success(Boolean success){
            this.setSuccess(success);
            return this;
        }
    
        /**
         * 功能描述：设置message内容
         *
         * @author cakin
         * @date 2020/11/16
         * @param message 消息内容
         * @return R 返回给前端的数据
         */
        public R message(String message){
            this.setMessage(message);
            return this;
        }
    
        /**
         * 功能描述：设置code内容
         *
         * @author cakin
         * @date 2020/11/16
         * @param code 返回码
         * @return R 返回给前端的数据
         */
        public R code(Integer code){
            this.setCode(code);
            return this;
        }
    
        /**
         * 功能描述：单值设置数据
         *
         * @author cakin
         * @date 2020/11/16
         * @param key 键
         * @param value 值
         * @return R 返回给前端的数据
         */
        public R data(String key, Object value){
            this.data.put(key, value);
            return this;
        }
    
        /**
         * 功能描述：多值设置数据
         *
         * @author cakin
         * @date 2020/11/16
         * @param map 集合
         * @return R 返回给前端的数据
         */
        public R data(Map<String, Object> map){
            this.setData(map);
            return this;
        }
    }

3 修改Controller中的返回结果

修改service\_edu的TeacherController

// @ApiOperation:定义在方法上
        @ApiOperation("所有讲师列表")
        @GetMapping("list")
        public R listAll() {
            List<Teacher> list = teacherService.list();
            return R.ok().data("items", list);
        }
    
        // @ApiOperation:定义在方法上
        @ApiOperation(value = "根据ID删除讲师", notes = "根据ID删除讲师，逻辑删除")
        @DeleteMapping("remove/{id}")
        // @ApiParam：定义在参数上
        public R removeById(@ApiParam(value = "讲师ID", required = true) @PathVariable String id) {
            boolean result = teacherService.removeById(id);
            if (result) {
                return R.ok().message("删除成功");
            } else {
                return R.error().message("数据不存在");
            }
        }

4 重启测试

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5ncWl1bWluZw_size_16_color_FFFFFF_t_70][]

[com.atguigu.guli.common.base.result]: http://com.atguigu.guli.common.base.result/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5ncWl1bWluZw_size_16_color_FFFFFF_t_70]: /images/20210724/6c4db3e993d44beeae2d333572fb9b21.png