文章目录提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档
- 创建SpringBoot API 状态码类以及返回信息工具类
- 前言
- 一、包结构如下
- 二、代码
- 1.IErrorCode 接口类:
- 2.ResultCode 枚举类:
- 3.返回对象泛型类
前言
提示:这里可以添加本文要记录的大概内容:
创建SpringBoot API 状态码类以及返回信息工具类,用到直接CV
提示:以下是本篇文章正文内容,下面案例可供参考
一、包结构如下 二、代码 1.IErrorCode 接口类:代码如下(示例):
public interface IErrorCode {
String getCode();
String getMessage();
}
2.ResultCode 枚举类:
@SuppressWarnings 去除枚举类型字段必须要有注释说明的警告!
代码如下(示例):
@SuppressWarnings("AlibabaEnumConstantsMustHaveComment")
public enum ResultCode implements IErrorCode {
SUCCESS(200, "操作成功!"),
FAILED(500, "操作失败!"),
VALIDATE_FAILED(400, "参数检验失败"),
UNAUTHORIZED(401, "暂未登录或token已经过期"),
FORBIDDEN(403, "没有相关权限");
private final long code;
private final String message;
ResultCode(long code, String message) {
this.code = code;
this.message = message;
}
@Override
public String getCode() {
return String.valueOf(code);
}
@Override
public String getMessage() {
return message;
}
}
3.返回对象泛型类
@AllArgsConstructor使用后添加一个构造函数,该构造函数含有所有已声明字段属性参数
@Data
@AllArgsConstructor
public class CommonResult implements Serializable {
private String code;
private String msg;
private Object data;
public static CommonResult success(Object data){
return new CommonResult(ResultCode.SUCCESS.getCode(),ResultCode.SUCCESS.getMessage(),data);
}
public static CommonResult success(Object data,String msg){
return new CommonResult(ResultCode.SUCCESS.getCode(),ResultCode.SUCCESS.getMessage() + msg,data);
}
public static CommonResult success() {
return new CommonResult(ResultCode.SUCCESS.getCode(),ResultCode.SUCCESS.getMessage(),null);
}
public static CommonResult fail(String msg){
return new CommonResult(ResultCode.VALIDATE_FAILED.getCode(),msg,null);
}
public static CommonResult loginFail(){
return new CommonResult(ResultCode.UNAUTHORIZED.getCode(),ResultCode.UNAUTHORIZED.getMessage(),null);
}
public static CommonResult fail(String msg, Object data){
return new CommonResult(ResultCode.VALIDATE_FAILED.getCode(),msg,data);
}
public static CommonResult businessFail(String msg){
return new CommonResult(ResultCode.FAILED.getCode(),msg,null);
}
}



