返回统一结果

梦里梦外; 2022-12-21 03:22 200阅读 0赞

## 统一返回结果 ##

@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(){ }
    
        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;
        }
    
        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;
        }
    
        public static R setResult(ResultCodeEnum resultCodeEnum){ 
            R r = new R();
            r.setSuccess(resultCodeEnum.getSuccess());
            r.setCode(resultCodeEnum.getCode());
            r.setMessage(resultCodeEnum.getMessage());
            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;
        }
    }

## 返回结果枚举类 ##

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

**使用：**

return R.ok().message("保存成功");
        return R.error().message("保存失败");