update [重磅更新] 重构分页 简化使用

疯狂的狮子li

2021-12-15 3f97d19381449b09898a9462e9289904696736c4

 ruoyi-common/src/main/java/com/ruoyi/common/utils/PageUtils.java

@@ -1,11 +1,16 @@
package com.ruoyi.common.utils;

import cn.hutool.core.util.ObjectUtil;
import cn.hutool.http.HttpStatus;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.core.metadata.OrderItem;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.ruoyi.common.core.domain.PageQuery;
import com.ruoyi.common.core.page.PagePlus;
import com.ruoyi.common.core.page.TableDataInfo;
import com.ruoyi.common.utils.sql.SqlUtil;
import lombok.AccessLevel;
import lombok.NoArgsConstructor;

import java.util.List;

@@ -13,45 +18,58 @@
 * 分页工具
 *
 * @author Lion Li
 * @deprecated 3.6.0 删除 请使用 {@link PageQuery} 与 {@link TableDataInfo}
 */
@Deprecated
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public class PageUtils {

    /**
     * 当前记录起始索引
     */
    @Deprecated
    public static final String PAGE_NUM = "pageNum";

    /**
     * 每页显示记录数
     */
    @Deprecated
    public static final String PAGE_SIZE = "pageSize";

    /**
     * 排序列
     */
    @Deprecated
    public static final String ORDER_BY_COLUMN = "orderByColumn";

    /**
     * 排序的方向 "desc" 或者 "asc".
     */
    @Deprecated
    public static final String IS_ASC = "isAsc";

    /**
     * 当前记录起始索引 默认值
     */
    @Deprecated
    public static final int DEFAULT_PAGE_NUM = 1;

    /**
     * 每页显示记录数 默认值 默认查全部
     */
    @Deprecated
    public static final int DEFAULT_PAGE_SIZE = Integer.MAX_VALUE;

    /**
     * 构建 plus 分页对象
     *
     * @param <T> domain 实体
     * @param <K> vo 实体
     * @return 分页对象
     * @deprecated 3.6.0 删除 请使用 {@link PageQuery#build()}
     * 由于使用 Servlet 获取只能从 param 获取 灵活性降低 故将传参操作交给用户
     */
    @Deprecated
    public static <T, K> PagePlus<T, K> buildPagePlus() {
        Integer pageNum = ServletUtils.getParameterToInt(PAGE_NUM, DEFAULT_PAGE_NUM);
        Integer pageSize = ServletUtils.getParameterToInt(PAGE_SIZE, DEFAULT_PAGE_SIZE);
@@ -62,19 +80,26 @@
        }
        PagePlus<T, K> page = new PagePlus<>(pageNum, pageSize);
        OrderItem orderItem = buildOrderItem(orderByColumn, isAsc);
        page.addOrder(orderItem);
        if (ObjectUtil.isNotNull(orderItem)) {
            page.addOrder(orderItem);
        }
        return page;
    }

   public static <T> Page<T> buildPage() {
      return buildPage(null, null);
   }
    @Deprecated
    public static <T> Page<T> buildPage() {
        return buildPage(null, null);
    }

    /**
     * 构建 MP 普通分页对象
     *
     * @param <T> domain 实体
     * @return 分页对象
     * @deprecated 3.6.0 删除 请使用 {@link PageQuery#build()}
     * 由于使用 Servlet 获取只能从 param 获取 灵活性降低 故将传参操作交给用户
     */
    @Deprecated
    public static <T> Page<T> buildPage(String defaultOrderByColumn, String defaultIsAsc) {
        Integer pageNum = ServletUtils.getParameterToInt(PAGE_NUM, DEFAULT_PAGE_NUM);
        Integer pageSize = ServletUtils.getParameterToInt(PAGE_SIZE, DEFAULT_PAGE_SIZE);
@@ -85,7 +110,9 @@
        }
        Page<T> page = new Page<>(pageNum, pageSize);
        OrderItem orderItem = buildOrderItem(orderByColumn, isAsc);
        page.addOrder(orderItem);
        if (ObjectUtil.isNotNull(orderItem)) {
            page.addOrder(orderItem);
        }
        return page;
    }

@@ -98,8 +125,8 @@
        }
        if (StringUtils.isNotBlank(orderByColumn)) {
            String orderBy = SqlUtil.escapeOrderBySql(orderByColumn);
         orderBy = StringUtils.toUnderScoreCase(orderBy);
         if ("asc".equals(isAsc)) {
            orderBy = StringUtils.toUnderScoreCase(orderBy);
            if ("asc".equals(isAsc)) {
                return OrderItem.asc(orderBy);
            } else if ("desc".equals(isAsc)) {
                return OrderItem.desc(orderBy);
@@ -108,6 +135,15 @@
        return null;
    }

    /**
     * 构建 MP 普通分页对象
     *
     * @param <T> domain 实体
     * @return 分页对象
     * @deprecated 3.6.0 删除 请使用 {@link PageQuery#build()}
     * 由于使用 Servlet 获取只能从 param 获取 灵活性降低 故将传参操作交给用户
     */
    @Deprecated
    public static <T, K> TableDataInfo<K> buildDataInfo(PagePlus<T, K> page) {
        TableDataInfo<K> rspData = new TableDataInfo<>();
        rspData.setCode(HttpStatus.HTTP_OK);
@@ -117,6 +153,10 @@
        return rspData;
    }

    /**
     * @deprecated 3.6.0 删除 请使用 {@link TableDataInfo#build(IPage)}
     */
    @Deprecated
    public static <T> TableDataInfo<T> buildDataInfo(Page<T> page) {
        TableDataInfo<T> rspData = new TableDataInfo<>();
        rspData.setCode(HttpStatus.HTTP_OK);
@@ -126,6 +166,10 @@
        return rspData;
    }

    /**
     * @deprecated 3.6.0 删除 请使用 {@link TableDataInfo#build(List)}
     */
    @Deprecated
    public static <T> TableDataInfo<T> buildDataInfo(List<T> list) {
        TableDataInfo<T> rspData = new TableDataInfo<>();
        rspData.setCode(HttpStatus.HTTP_OK);
@@ -135,4 +179,15 @@
        return rspData;
    }

    /**
     * @deprecated 3.6.0 删除 请使用 {@link TableDataInfo#build()}
     */
    @Deprecated
    public static <T> TableDataInfo<T> buildDataInfo() {
        TableDataInfo<T> rspData = new TableDataInfo<>();
        rspData.setCode(HttpStatus.HTTP_OK);
        rspData.setMsg("查询成功");
        return rspData;
    }

}