SpringBoot結果集包裝類

1、前言

在SpringBoot項目中、看了一部分代碼、發現一般的接口以JSON形式返回最佳、接口規范遵照RESTFUL風格來寫、返回的結果集呢、借助包裝類來包裝、這樣有利於前后端的交互、寫出來的代碼得到了規范。
注：
閱讀量有100多、想想我還是寫的太粗糙了、重新更新一下、規范了代碼。
2021/5/5日

2、結構樹

3、四個需要的類

1、CommonPage.java

import com.github.pagehelper.PageInfo;

import java.util.List;

/**
 * 分頁數據封裝類
 */
public class CommonPage<T> {
    private Integer pageNum;
    private Integer pageSize;
    private Integer totalPage;
    private Long total;
    private List<T> list;

    /**
     * 將PageHelper分頁后的list轉為分頁信息
     */
    public static <T> CommonPage<T> restPage(List<T> list) {
        CommonPage<T> result = new CommonPage<T>();
        PageInfo<T> pageInfo = new PageInfo<T>(list);
        result.setTotalPage(pageInfo.getPages());
        result.setPageNum(pageInfo.getPageNum());
        result.setPageSize(pageInfo.getPageSize());
        result.setTotal(pageInfo.getTotal());
        result.setList(pageInfo.getList());
        return result;
    }

    public Integer getPageNum() {
        return pageNum;
    }

    public void setPageNum(Integer pageNum) {
        this.pageNum = pageNum;
    }

    public Integer getPageSize() {
        return pageSize;
    }

    public void setPageSize(Integer pageSize) {
        this.pageSize = pageSize;
    }

    public Integer getTotalPage() {
        return totalPage;
    }

    public void setTotalPage(Integer totalPage) {
        this.totalPage = totalPage;
    }

    public List<T> getList() {
        return list;
    }

    public void setList(List<T> list) {
        this.list = list;
    }

    public Long getTotal() {
        return total;
    }

    public void setTotal(Long total) {
        this.total = total;
    }
}

---

2、CommonResult.java

/**
 * 通用返回對象
 */
public class CommonResult<T> {
    private long code;
    private String message;
    private T data;

    protected CommonResult() {
    }

    protected CommonResult(long code, String message, T data) {
        this.code = code;
        this.message = message;
        this.data = data;
    }

    /**
     * 成功返回結果
     *
     * @param data 獲取的數據
     */
    public static <T> CommonResult<T> success(T data) {
        return new CommonResult<T>(ResultCode.SUCCESS.getCode(), ResultCode.SUCCESS.getMessage(), data);
    }

    /**
     * 成功返回結果
     *
     * @param data 獲取的數據
     * @param  message 提示信息
     */
    public static <T> CommonResult<T> success(T data, String message) {
        return new CommonResult<T>(ResultCode.SUCCESS.getCode(), message, data);
    }

    /**
     * 失敗返回結果
     * @param errorCode 錯誤碼
     */
    public static <T> CommonResult<T> failed(IErrorCode errorCode) {
        return new CommonResult<T>(errorCode.getCode(), errorCode.getMessage(), null);
    }

    /**
     * 失敗返回結果
     * @param message 提示信息
     */
    public static <T> CommonResult<T> failed(String message) {
        return new CommonResult<T>(ResultCode.FAILED.getCode(), message, null);
    }

    /**
     * 失敗返回結果
     */
    public static <T> CommonResult<T> failed() {
        return failed(ResultCode.FAILED);
    }

    /**
     * 參數驗證失敗返回結果
     */
    public static <T> CommonResult<T> validateFailed() {
        return failed(ResultCode.VALIDATE_FAILED);
    }

    /**
     * 參數驗證失敗返回結果
     * @param message 提示信息
     */
    public static <T> CommonResult<T> validateFailed(String message) {
        return new CommonResult<T>(ResultCode.VALIDATE_FAILED.getCode(), message, null);
    }

    /**
     * 未登錄返回結果
     */
    public static <T> CommonResult<T> unauthorized(T data) {
        return new CommonResult<T>(ResultCode.UNAUTHORIZED.getCode(), ResultCode.UNAUTHORIZED.getMessage(), data);
    }

    /**
     * 未授權返回結果
     */
    public static <T> CommonResult<T> forbidden(T data) {
        return new CommonResult<T>(ResultCode.FORBIDDEN.getCode(), ResultCode.FORBIDDEN.getMessage(), data);
    }

    public long getCode() {
        return code;
    }

    public void setCode(long code) {
        this.code = code;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }
}

---

3、IErrorCode.java

/**
 * 封裝API的錯誤碼
 */
public interface IErrorCode {
    long getCode();

    String getMessage();
}

---

4、ResultCode.java

package org.feng.study.common.api;


/**
 * 枚舉了一些常用API操作碼
 */
public enum ResultCode implements IErrorCode {
    // 此處錯誤碼可以自己DIY
    SUCCESS(200, "操作成功"),
    FAILED(500, "操作失敗"),
    VALIDATE_FAILED(404, "參數檢驗失敗"),
    UNAUTHORIZED(401, "暫未登錄或token已經過期"),
    FORBIDDEN(403, "沒有相關權限");
    private long code;
    private String message;

    private ResultCode(long code, String message) {
        this.code = code;
        this.message = message;
    }

    public long getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }
}

4、為什么

關於為什么這樣來寫、准確來說是為了更好的前后端交互、對於數據有一個統一的格式、如果隨便返回一些亂七八糟的話、后期很難維護項目是一方面、時間成本溝通成本增加更是一方面、所以統一返回格式、每次寫代碼遵循好這些規范、再也不用擔心自己寫出的代碼可讀性較差的問題了。

5、總結

借助包裝類、很好的對代碼進行規范、以及對於接口返回的數據得到了一定的格式、無規矩不成方圓、有了格式、自己看、別人看都能看懂、減少溝通成本、提升了的代碼的效率。useful coding 😃