1.ResponseVO:专门用于响应返回给前端的
一般位于entity包下面
@Data
public class ResponseVO<T> {
private Integer code;
private String message;
private T data;
public ResponseVO(ResultEnum resultEnum) {
this.code = resultEnum.getCode();
this.message = resultEnum.getMessage();
}
public ResponseVO(Integer code, String message) {
this.code = code;
this.message = message;
}
public ResponseVO(Integer code, String message, T data) {
this.code = code;
this.message = message;
this.data = data;
}
public ResponseVO(T data) {
this.data = data;
}
}
2.ResponseEnum :返回的枚举类型,包括状态码和响应信息
一般位于constant.enums包下面
@AllArgsConstructor
@Getter
public enum ResponseEnum {
SUCCESS(200,"成功"),
FAILURE(500,"服务器错误"),
FILE_SIZE_ERROR(500, "文件大小异常");
private Integer code;
private String message;
}
3.ResultUtil:里面封装的静态方法,主要用于返回ResponseVO
一般位于utils包下面,
注意:成功一般不用传入code,默认为ResponseEnum.SUCCESS.getCode,即200,
失败一般不需要传入data,只需要告诉失败的状态码code和失败的错误信息message即可
/**
* 结果工具类
*
* @author daz
* @date 2024/6/10
*/
public class ResultUtil {
/**
* 成功:返回值结果不包含数据
*/
public static ResponseVO success() {
return new ResponseVO(ResponseEnum.SUCCESS);
}
/**
* 成功:返回结果包含数据
*/
public static <T> ResponseVO<T> success(T data) {
return new ResponseVO(data);
}
/**
* 成功:返回结果不包含数据,自定义成功消息
*/
public static ResponseVO success(String message) {
return new ResponseVO(ResponseEnum.SUCCESS.getCode(), message);
}
/**
* 成功:返回结果包含数据,自定义成功的消息
*/
public static <T> ResponseVO<T> success(String message, T data) {
return new ResponseVO(ResponseEnum.SUCCESS.getCode(), message, data);
}
/**
* 失败:默认是500,服务器错误
*/
public static ResponseVO fail() {
return new ResponseVO(ResponseEnum.FAILURE);
}
/**
* 失败:传入定义的失败枚举
*/
public static ResponseVO fail(ResponseEnum resultEnum) {
return new ResponseVO(resultEnum);
}
/**
* 失败:自定义失败的消息
*/
public static ResponseVO fail(String message) {
return new ResponseVO(ResponseEnum.FAILURE.getCode(), message);
}
/**
* 失败:自定义失败码和消息
*/
public static ResponseVO fail(Integer code, String message) {
return new ResponseVO(code, message);
}
}
4.测试及结果
public static void main(String[] args) {
Student student = new Student(1, "zhangsan", 20);
//成功测试
System.out.println(ResultUtil.success());
System.out.println(ResultUtil.success("修改成功"));
System.out.println(ResultUtil.success(student));
System.out.println(ResultUtil.success("数据获取成功",student));
//失败测试
System.out.println(ResultUtil.fail());
System.out.println(ResultUtil.fail("token已过期"));
System.out.println(ResultUtil.fail(ResponseEnum.FILE_SIZE_ERROR));
System.out.println(ResultUtil.fail(404,"错误请求"));
}
5.注解解释:
@Data:默认包含setter和getter方法,但是不提供有参构造
@AllArgsConstructor:有参构造
@Getter:提供getter方法