返回标准格式 3大标配 code:由后端统一定义的状态码,
message:本次接口调用的结果描述,
data:本次返回的数据,
timestamp:调用接口的时间 时间戳
1.建 状态码枚举类:步骤 :举值,构造,遍历
2.建 统一定义返回对象Result:
3.Controller层通过 return Result.success(【需要返回给前端的数据】) 返回结果进行包装返回给前端
1.枚举类:
@Getter
public enum ReturnCodeEnum {
//1举值
/**操作失败 罗列出枚举值每一个code对应的消息是什么**/
RC999("999","操作XXX失败"),
/**操作成功**/
RC200("200","success"),
/**服务降级**/
RC201("201","服务开启降级保护,请稍后再试!"),
/**热点参数限流**/
RC202("202","热点参数限流,请稍后再试!"),
/**系统规则不满足**/
RC203("203","系统规则不满足要求,请稍后再试!"),
/**授权规则不通过**/
RC204("204","授权规则不通过,请稍后再试!"),
/**access_denied**/
RC403("403","无访问权限,请联系管理员授予权限"),
/**access_denied**/
RC401("401","匿名用户访问无权限资源时的异常"),
RC404("404","404页面找不到的异常"),
/**服务异常**/
RC500("500","系统异常,请稍后重试"),
RC375("375","数学运算异常,请稍后重试"),
INVALID_TOKEN("2001","访问令牌不合法"),
ACCESS_DENIED("2003","没有权限访问该资源"),
CLIENT_AUTHENTICATION_FAILED("1001","客户端认证失败"),
USERNAME_OR_PASSWORD_ERROR("1002","用户名或密码错误"),
BUSINESS_ERROR("1004","业务逻辑异常"),
UNSUPPORTED_GRANT_TYPE("1003", "不支持的认证模式");
//2.构造
private final String code;
private final String messgee;
ReturnCodeEnum(String code, String messgee) {
this.code = code;
this.messgee = messgee;
}
//3.遍历
//3.1 传统版
public static ReturnCodeEnum getReturnCodeEnumV1(String code){
for (ReturnCodeEnum value : ReturnCodeEnum.values()) {
if(value.getCode().equalsIgnoreCase(code))
{
return value;
}
}
return null;
}
//3.2 Stream版本计算版
public static ReturnCodeEnum getReturnCodeEnumV2(String code){
return Arrays.stream(ReturnCodeEnum.values()).filter(x->x.getCode().equalsIgnoreCase(code)).findFirst().orElse(null);
}
}
2.统一返回对象Result
@Data
@Accessors(chain = true) //生成set方法 并运行链式调用
public class ResultData<T> {
private String code;/** 结果状态 ,具体状态码参见枚举类ReturnCodeEnum.java*/
private String message;
private T data;
private long timestamp ;
public ResultData (){
this.timestamp = System.currentTimeMillis();
}
public static <T> ResultData<T> success(T data) {
ResultData<T> resultData = new ResultData<>();
resultData.setCode(ReturnCodeEnum.RC200.getCode());
resultData.setMessage(ReturnCodeEnum.RC200.getMessage());
resultData.setData(data);
return resultData;
}
public static <T> ResultData<T> fail(String code, String message) {
ResultData<T> resultData = new ResultData<>();
resultData.setCode(code);
resultData.setMessage(message);
return resultData;
}
}
// 但是,由于我们使用了@Accessors(chain = true),
// 生成的setter方法将返回当前对象的引用,允许链式调用。
// 例如:new ResultData().message("Hello").timestamp(System.currentTimeMillis());
// 注意:上面的链式调用示例实际上是不必要的,因为timestamp已经在构造函数中设置了。
// 这只是为了展示链式调用的用法。