Java 封装通用 web 服务端响应客户端数据的结果类
文章归档：https://www.yuque.com/u27599042/coding_star/
ResponseCodeEnum
响应状态码枚举类
依赖
- lombok
<parent>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-parentartifactId>
<version>3.1.3version>
parent>
<dependency>
<groupId>org.projectlombokgroupId>
<artifactId>lombokartifactId>
dependency>
源码
/**
* 响应状态码枚举类
*/
@Getter
public enum ResponseCodeEnum {
/**
* 成功
*/
OK(200, "成功"),
/**
* 客户端请求错误
*/
ERROR(400, "客户端请求错误"),
/**
* 无法找到相应资源
*/
NOT_FOUND(404, "找不到相应资源"),
/**
* 服务器错误
*/
SERVER_ERROR(500, "服务端错误");
/**
* 响应状态码
*/
private final Integer code;
/**
* 响应描述信息
*/
private final String message;
/**
* 响应状态码枚举类构造器
*
* @param code 响应状态码
*/
private ResponseCodeEnum(Integer code, String message) {
this.code = code;
this.message = message;
}
}
BaseResponseResult
用于封装响应客户端数据的基本结果类
依赖
- StringUtil：https://www.yuque.com/u27599042/coding_star/st621zwyepp3yyee
- lombok
<parent>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-parentartifactId>
<version>3.1.3version>
parent>
<dependency>
<groupId>org.projectlombokgroupId>
<artifactId>lombokartifactId>
dependency>
源码
import java.io.Serial;
import java.io.Serializable;
/**
* 用于封装响应客户端数据的基本结果类
*
* @param 结果数据类型
*/
@Getter
@Setter
public class BaseResponseResult<T> implements Serializable {
@Serial
private static final long serialVersionUID = 1L;
/**
* 响应状态码
*/
private Integer code;
/**
* 响应信息
*/
private String message;
/**
* 响应结果数据
*/
private T data;
/**
* 构造响应结果对象
*/
public BaseResponseResult() {
}
/**
* 构造指定状态码的响应结果对象
*
* @param code 响应状态码
*/
public BaseResponseResult(Integer code) {
this.code = code;
}
/**
* 构造指定状态码和响应信息的结果对象
*
* @param code 响应状态码
* @param msg 响应信息
*/
public BaseResponseResult(Integer code, String msg) {
this.code = code;
this.message = msg;
}
/**
* 构造指定状态码和响应数据的结果对象
*
* @param code 响应状态码
* @param data 响应数据
*/
public BaseResponseResult(Integer code, T data) {
this.code = code;
this.data = data;
}
/**
* 构造指定状态码、响应信息和响应数据的结果对象
*
* @param code 响应状态码
* @param message 响应信息
* @param data 响应数据
*/
public BaseResponseResult(Integer code, String message, T data) {
this.code = code;
this.message = message;
this.data = data;
}
/**
* 响应结果
*
* @param code 响应状态码
* @param message 响应信息
* @param data 响应数据
* @return 响应结果对象
*/
public static BaseResponseResult<Object> responseResult(Integer code, String message, Object data) {
BaseResponseResult<Object> baseResponseResult = new BaseResponseResult<>(code);
if (!StringUtil.isNull(message)) baseResponseResult.setMessage(message);
if (data != null) baseResponseResult.setData(data);
return baseResponseResult;
}
}
OkResponseResult
用于封装成功响应结果的响应结果类
依赖
- ResponseCodeEnum：https://www.yuque.com/u27599042/coding_star/yxmiq0yidih0wqsu
- StringUtil：https://www.yuque.com/u27599042/coding_star/st621zwyepp3yyee
源码
/**
* 用于封装成功响应结果的响应结果类
*/
public class OkResponseResult extends BaseResponseResult {
/**
* 成功响应
*
* @return 成功响应对象
*/
public static BaseResponseResult<Object> okResult() {
return new BaseResponseResult<>(ResponseCodeEnum.OK.getCode(), ResponseCodeEnum.OK.getMessage());
}
/**
* 成功响应
*
* @param okMessage 成功响应信息
* @return 成功响应对象
*/
public static BaseResponseResult<Object> okResult(String okMessage) {
BaseResponseResult<Object> baseResponseResult = okResult();
if (!StringUtil.isNull(okMessage)) baseResponseResult.setMessage(okMessage);
return baseResponseResult;
}
/**
* 成功响应
*
* @param data 响应数据
* @return 成功响应对象
*/
public static BaseResponseResult<Object> okResult(Object data) {
BaseResponseResult<Object> baseResponseResult = okResult();
if (data != null) baseResponseResult.setData(data);
return baseResponseResult;
}
/**
* 成功响应
*
* @param message 成功响应信息
* @param data 响应数据
* @return 成功响应对象
*/
public static BaseResponseResult<Object> okResult(String message, Object data) {
BaseResponseResult<Object> baseResponseResult = okResult();
if (!StringUtil.isNull(message)) baseResponseResult.setMessage(message);
if (data != null) baseResponseResult.setData(data);
return baseResponseResult;
}
}
ClientErrorResponseResult
用于封装由于客户端导致的失败响应结果的响应结果类
依赖
- ResponseCodeEnum：https://www.yuque.com/u27599042/coding_star/yxmiq0yidih0wqsu
- StringUtil：https://www.yuque.com/u27599042/coding_star/st621zwyepp3yyee
源码
/**
* 用于封装由于客户端导致的失败响应结果的响应结果类
*/
public class ClientErrorResponseResult extends BaseResponseResult {
/**
* 由于客户端导致的失败响应
*
* @return 失败响应对象
*/
public static BaseResponseResult<Object> errorResult() {
return new BaseResponseResult<>(ResponseCodeEnum.ERROR.getCode(), ResponseCodeEnum.ERROR.getMessage());
}
/**
* 由于客户端导致的失败响应
*
* @param errorMessage 失败响应信息
* @return 失败响应对象
*/
public static BaseResponseResult<Object> errorResult(String errorMessage) {
BaseResponseResult<Object> baseResponseResult = errorResult();
if (!StringUtil.isNull(errorMessage)) baseResponseResult.setMessage(errorMessage);
return baseResponseResult;
}
/**
* 由于客户端导致的失败响应
*
* @param data 响应数据
* @return 失败响应对象
*/
public static BaseResponseResult<Object> errorResult(Object data) {
BaseResponseResult<Object> baseResponseResult = errorResult();
if (data != null) baseResponseResult.setData(data);
return baseResponseResult;
}
/**
* 由于客户端导致的失败响应
*
* @param message 失败响应信息
* @param data 响应数据
* @return 失败响应对象
*/
public static BaseResponseResult<Object> errorResult(String message, Object data) {
BaseResponseResult<Object> baseResponseResult = errorResult();
if (!StringUtil.isNull(message)) baseResponseResult.setMessage(message);
if (data != null) baseResponseResult.setData(data);
return baseResponseResult;
}
}
ServerErrorResponseResult
用于封装由于服务端导致的失败响应结果的响应结果类
依赖
- ResponseCodeEnum：https://www.yuque.com/u27599042/coding_star/yxmiq0yidih0wqsu
- StringUtil：https://www.yuque.com/u27599042/coding_star/st621zwyepp3yyee
源码
/**
* 用于封装由于服务端导致的失败响应结果的响应结果类
*/
public class ServerErrorResponseResult extends BaseResponseResult {
/**
* 由于服务端导致的失败响应
*
* @return 失败响应对象
*/
public static BaseResponseResult<Object> errorResult() {
return new BaseResponseResult<>(ResponseCodeEnum.SERVER_ERROR.getCode(), ResponseCodeEnum.SERVER_ERROR.getMessage());
}
/**
* 由于服务端导致的失败响应
*
* @param errorMessage 失败响应信息
* @return 失败响应对象
*/
public static BaseResponseResult<Object> errorResult(String errorMessage) {
BaseResponseResult<Object> baseResponseResult = errorResult();
if (!StringUtil.isNull(errorMessage)) baseResponseResult.setMessage(errorMessage);
return baseResponseResult;
}
/**
* 由于服务端导致的失败响应
*
* @param data 响应数据
* @return 失败响应对象
*/
public static BaseResponseResult<Object> errorResult(Object data) {
BaseResponseResult<Object> baseResponseResult = errorResult();
if (data != null) baseResponseResult.setData(data);
return baseResponseResult;
}
/**
* 由于服务端导致的失败响应
*
* @param message 失败响应信息
* @param data 响应数据
* @return 失败响应对象
*/
public static BaseResponseResult<Object> errorResult(String message, Object data) {
BaseResponseResult<Object> baseResponseResult = errorResult();
if (!StringUtil.isNull(message)) baseResponseResult.setMessage(message);
if (data != null) baseResponseResult.setData(data);
return baseResponseResult;
}
}