统一结果封装解决方案
之所以这么做，想必凡是工作过的后端程序员应该都是了解的，为了前后端交互简单，统一格式返回便于前端解析。
一 、表现层与前端数据传输协议定义
大体分两类一种是分页返回、非分页返回。
1.1、非分页返回大体实现思路
（可以按需所取，没必要全部都有）
为了封装返回的结果数据:创建结果模型类，封装数据到data属性中
为了封装返回的数据是何种操作及是否操作成功:封装操作结果到code属性中
操作失败后为了封装返回的错误信息:封装特殊消息到message(msg)属性中
操作失败后为了便于排查问题封装返回的debug错误信息:封装特殊消息到debugMessage(debugMsg)属性中
为了记录封装返回元数据信息:封装元数据信息到metadata属性中
1.2、分页返回大体实现思路
（可以按需所取，没必要全部都有）
为了封装返回的当前页码:pageNum
为了封装返回的页大小:pageSize
为了封装返回的总记录条数:total
为了封装返回的结果数据:list
二、 表现层与前端数据传输协议实现
2.1、非分页实现之–使用Object：
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import org.springframework.http.HttpStatus;
import java.io.Serializable;
import java.util.Map;
/**
* @author ：
* @date ：Created in 2022/04/23
* @description ：返回结果信息
* @version: 1.0
*/
@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
public class Result implements Serializable {
/**
* 返回结果，true为成功，false为失败
*/
private Integer code;
/**
* 返回结果信息
*/
private String message;
/**
* 返回debug信息
*/
private String debugMsg;
/**
* 元数据
*/
private Map<?, ?> metadata;
/**
* 返回结果数据
*/
private Object data;
public Result(Boolean status, String message) {
this.code = status ? HttpStatus.OK.value() : HttpStatus.INTERNAL_SERVER_ERROR.value();
this.message = message;
}
public Result(Boolean status, String message, Object data) {
this.code = status ? HttpStatus.OK.value() : HttpStatus.INTERNAL_SERVER_ERROR.value();
this.message = message;
this.data = data;
}
public Result(HttpStatus httpStatus, String message, Object data) {
this.code = httpStatus.value();
this.message = message;
this.data = data;
}
public Result(Integer code, String message) {
this.code = code;
this.message = message;
}
}
2.2、非分页实现之–使用泛型：
注;缺少异常code枚举类导包ExceptionCodeEnum（可以去我写的通用异常解决方案文章里面去复制）
import com.google.common.base.Strings;
import lombok.Data;
import javax.annotation.Nullable;
import java.util.Map;
/**
* @author ：
* @date ：Created in 2022/04/23
* @description ：返回结果信息
* @version: 1.0
*/
@Data
public final class Result<T> {
/**
* 响应码
*/
private final int code;
/**
* 具体内容
*/
private final T data;
/**
* 消息
*/
private final String message;
/**
* 元数据
*/
private final Map<?, ?> metadata;
/**
* debug错误信息
*/
private String debugMessage;
public Result(int code, T data, String message, Map<?, ?> metadata, String debugMessage) {
this.code = code;
this.data = data;
this.message = message;
this.metadata = metadata;
this.debugMessage = debugMessage;
}
private Result(int code, @Nullable String message, @Nullable T data, @Nullable Map<?, ?> metadata) {
this.code = code;
this.message = message;
this.data = data;
this.metadata = metadata;
}
public static <Response> Result<Response> of(int code, String message, Response data, Map<?, ?> metadata) {
return new Result<>(code, message, data, metadata);
}
public static <Response> Result<Response> of(int code, String message) {
return new Result<>(code, message, null, null);
}
public static <Response> Result<Response> of(ExceptionCodeEnum retCode) {
return new Result<>(retCode.getCode(), retCode.getDesc(), null, null);
}
public static <Response> Result<Response> of(ExceptionCodeEnum retCode, String message) {
if (Strings.isNullOrEmpty(message)) {
message = retCode.getDesc();
}
return new Result<>(retCode.getCode(), message, null, null);
}
public static <Response> Result<Response> of(ExceptionCodeEnum retCode, @Nullable String message, Response data) {
if (Strings.isNullOrEmpty(message)) {
message = retCode.getDesc();
}
return new Result<>(retCode.getCode(), message, data, null);
}
public static <Response> Result<Response> of(ExceptionCodeEnum retCode, Response data) {
return new Result<>(retCode.getCode(), retCode.getDesc(), data, null);
}
public static <Response> Result<Response> success(Response data) {
return new Result<>(ExceptionCodeEnum.SUCCESS.getCode(), ExceptionCodeEnum.SUCCESS.getDesc(), data, null);
}
public static <Response> Result<Response> success() {
return new Result<>(ExceptionCodeEnum.SUCCESS.getCode(), ExceptionCodeEnum.SUCCESS.getDesc(), null, null);
}
public static <Response> Result<Response> nestedOf(ExceptionCodeEnum retCode, Result<?> nestedResult) {
String msg = (Strings.isNullOrEmpty(nestedResult.message) ? retCode.getDesc() : nestedResult.message);
return new Result<>(retCode.getCode(), msg, null, null);
}
}
2.3、分页实现之–使用总记录条数和当前页：
import java.io.Serializable;
import java.util.List;
/**
* @author ：
* @date ：Created in 2022/04/28
* @description ：分页结果实体类
* @version: 1.0
*/
public class PageResult implements Serializable {
/**
* 总记录条数
*/
private Long total;
/**
* 当前页结果
*/
private List rows;
public PageResult(Long total, List rows) {
super();
this.total = total;
this.rows = rows;
}
public Long getTotal() {
return total;
}
public void setTotal(Long total) {
this.total = total;
}
public List getRows() {
return rows;
}
public void setRows(List rows) {
this.rows = rows;
}
}
2.4、分页实现之–使用Pagehelper：
import com.github.pagehelper.Page;
import com.github.pagehelper.PageInfo;
import lombok.Data;
import javax.annotation.Nullable;
import javax.validation.constraints.NotNull;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
/**
* @author ：
* @date ：Created in 2022/04/28
* @description ：分页结果实体类
* @version: 1.0
*/
@Data
public final class PageResult<T> {
/**
* 当前页码
*/
private final Integer pageNum;
/**
* 页大小
*/
private final Integer pageSize;
/**
* 总记录条数
*/
private final Long total;
/**
* 存放数据
*/
private final List<T> list;
private PageResult(@NotNull Integer pageNum, @NotNull Integer pageSize, @NotNull Long total, @Nullable List<T> list) {
this.pageNum = pageNum;
this.pageSize = pageSize;
this.total = total;
this.list = list;
}
public static <T> PageResult<T> restPage(@NotNull Integer pageNum, @NotNull Integer pageSize, @NotNull Long total, @Nullable List<T> list) {
return new PageResult<>(pageNum, pageSize, total, Optional.ofNullable(list).orElse(Collections.emptyList()));
}
/**
* 分页结果转化为通用结果
*/
public static <T> PageResult<T> restPage(@NotNull Page<T> page) {
return new PageResult<>(page.getPageNum(), page.getPageSize(), page.getTotal(), page.getResult());
}
/**
* 分页结果转化为通用结果
*/
public static <T> PageResult<T> restPage(@NotNull PageInfo<T> page) {
return new PageResult<>(page.getPageNum(), page.getPageSize(), page.getTotal(), page.getList());
}
/**
* 将Jpa分页结果转化为通用结果
*/
public static <T> PageResult<T> restPage(@NotNull org.springframework.data.domain.Page<T> page) {
return new PageResult<>(page.getNumber()+1, page.getSize(), page.getTotalElements(), page.getContent());
}
}
2.5、定义返回码Code类
/**
* @author ：
* @date ：Created in 2022/04/29
* @description ：状态码
* @version: 1.0
*/
public class Code {
public static final Integer SAVE_OK = 20011;
public static final Integer DELETE_OK = 20021;
public static final Integer UPDATE_OK = 20031;
public static final Integer GET_OK = 20041;
public static final Integer SAVE_ERR = 20010;
public static final Integer DELETE_ERR = 20020;
public static final Integer UPDATE_ERR = 20030;
public static final Integer GET_ERR = 20040;
}
注意: code类中的常量设计也不是固定的，可以根据需要自行增减，例如将查询再进行细分为GET_OK,GET_ALL_OK,GET_PAGE_OK等。
497
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
