1.创建Api返回码接口
/**
* Api返回码接口
*/
public interface ICode {
Integer getCode();
String getMessage();
}
2.实现ICode接口
/**
* API返回码封装类
*/
@AllArgsConstructor
public enum ResultCode implements ICode {
SUCCESS(200, "成功"),
FAILED(500, "失败"),
VALIDATE_FAILED(400, "参数验证失败"),
UNAUTHORIZED(401, "没有登陆"),
FORBIDDEN(403, "没有相关权限");
private final Integer code;
private final String message;
@Override
public Integer getCode() {
return code;
}
@Override
public String getMessage() {
return message;
}
}
3.最后是统一结果封装类
/**
* 统一返回结果封装类
*/
@Data
@Schema(description = "统一结果处理器")
public class Result<T> implements Serializable {
/**
* 状态码
*/
private Integer code;
/**
* 提示信息
*/
private String message;
/**
* 数据封装
*/
private T data;
/**
* 成功返回结果
*/
public static <T> Result<T> success() {
return result(ResultCode.SUCCESS, null);
}
/**
* 成功返回结果
*
* @param data 获取的数据
*/
public static <T> Result<T> success(T data) {
return result(ResultCode.SUCCESS, data);
}
/**
* 失败返回结果
*/
public static <T> Result<T> failed() {
return result(ResultCode.FAILED, null);
}
/**
* 失败返回结果
*
* @param message 提示信息
*/
public static <T> Result<T> failed(String message) {
return result(ResultCode.FAILED.getCode(), message, null);
}
/**
* 失败返回结果
*
* @param code 错误码
*/
public static <T> Result<T> failed(ICode code) {
return result(code, null);
}
/**
* 失败返回结果
*
* @param code 错误码
* @param message 错误信息
*/
public static <T> Result<T> failed(ICode code, String message) {
return result(code.getCode(), message, null);
}
/**
* 参数验证失败返回结果
*/
public static <T> Result<T> validateFailed() {
return failed(ResultCode.VALIDATE_FAILED);
}
/**
* 参数验证失败返回结果
*
* @param message 提示信息
*/
public static <T> Result<T> validateFailed(String message) {
return failed(ResultCode.VALIDATE_FAILED, message);
}
/**
* 未登录返回结果
*/
public static <T> Result<T> unauthorized() {
return failed(ResultCode.UNAUTHORIZED);
}
/**
* 未授权返回结果
*/
public static <T> Result<T> forbidden() {
return failed(ResultCode.FORBIDDEN);
}
private static <T> Result<T> result(ICode code, T data) {
return result(code.getCode(), code.getMessage(), data);
}
private static <T> Result<T> result(Integer code, String message, T data) {
Result<T> result = new Result<>();
result.setCode(code);
result.setMessage(message);
result.setData(data);
return result;
}
}