分页工具类 - PageUtil

简介

PageUtil 是 Hutool 提供的一个分页工具类，用于在手动分页时进行页码和位置的转换。它可以帮助开发者在不同的分页方式之间进行转换，避免在分页过程中出现边界问题，确保分页操作的准确性。

1. 将页数和每页条目数转换为开始位置和结束位置

PageUtil 提供了 transToStartEnd 方法，用于将页码和每页条目数转换为开始位置和结束位置。这在数据库分页或其他需要基于位置的分页操作中非常有用。

import cn.hutool.core.util.PageUtil;

public class PageUtilExample {
    public static void main(String[] args) {
        // 页码为0，每页10条记录
        int[] startEnd1 = PageUtil.transToStartEnd(0, 10);
        System.out.println("页码 0, 每页 10 -> 开始位置: " + startEnd1[0] + ", 结束位置: " + startEnd1[1]);

        // 页码为1，每页10条记录
        int[] startEnd2 = PageUtil.transToStartEnd(1, 10);
        System.out.println("页码 1, 每页 10 -> 开始位置: " + startEnd2[0] + ", 结束位置: " + startEnd2[1]);
    }
}

• transToStartEnd(int page, int countPerPage)：将页数和每页条目数转换为开始位置和结束位置。

  • page：页码，从 0 开始。
  • countPerPage：每页的条目数。
  • 返回值：包含开始位置和结束位置的数组。

  作用： 进行页码到位置的转换，适用于数据库分页或其他基于位置的分页操作。

  实际开发场景： 当需要通过开始和结束位置来进行分页查询时，可以使用此方法进行页码到位置的转换。

2. 计算总页数

PageUtil 提供了 totalPage 方法，用于根据总条目数和每页条目数计算总页数。

import cn.hutool.core.util.PageUtil;

public class PageUtilExample {
    public static void main(String[] args) {
        // 总条目数为20，每页3条记录
        int totalPage = PageUtil.totalPage(20, 3);
        System.out.println("总页数: " + totalPage);
    }
}

• totalPage(int totalCount, int countPerPage)：根据总条目数和每页条目数计算总页数。

  • totalCount：总条目数。
  • countPerPage：每页的条目数。
  • 返回值：总页数。

  作用： 计算分页操作中的总页数，确保分页结果的准确性。

  实际开发场景： 当需要根据总条目数来显示总页数时，可以使用此方法进行计算。

3. 分页彩虹算法

PageUtil 提供了 rainbow 方法，用于生成一个分页彩虹，这个彩虹算法可以在页面上显示下一页时，显示当前页的前 N 页和后 N 页，方便用户进行分页操作。

import cn.hutool.core.util.PageUtil;

public class PageUtilExample {
    public static void main(String[] args) {
        // 当前页为5，总页数为20，显示6个页码
        int[] rainbow = PageUtil.rainbow(5, 20, 6);
        
        System.out.print("分页彩虹: ");
        for (int page : rainbow) {
            System.out.print(page + " ");
        }
    }
}

• rainbow(int currentPage, int totalPages, int displayPages)：生成分页彩虹。

  • currentPage：当前页码。
  • totalPages：总页数。
  • displayPages：每屏显示的页码数量。
  • 返回值：一个包含要显示的页码的数组。

  作用： 生成分页彩虹，使得在分页导航中显示前后页码更加美观。

  实际开发场景： 当需要在分页导航中显示当前页的前后页码时，可以使用此方法生成页码数组。

4. 计算指定页码的起始索引

PageUtil 提供了 getStartIndex 方法，用于计算指定页码的起始索引。

import cn.hutool.core.util.PageUtil;

public class PageUtilExample {
    public static void main(String[] args) {
        // 页码为2，每页10条记录
        int startIndex = PageUtil.getStartIndex(2, 10);
        System.out.println("页码 2 的起始索引: " + startIndex);
    }
}

• getStartIndex(int page, int countPerPage)：计算指定页码的起始索引。

  • page：页码，从 0 开始。
  • countPerPage：每页的条目数。
  • 返回值：起始索引。

  作用： 获取指定页码的起始索引，用于数据库查询中的分页操作。

  实际开发场景： 当需要手动计算数据库分页查询的起始索引时，可以使用此方法。

5. 根据当前页码计算前一页的页码

PageUtil 提供了 getPrePage 方法，用于计算当前页码的前一页页码。

import cn.hutool.core.util.PageUtil;

public class PageUtilExample {
    public static void main(String[] args) {
        // 当前页码为5
        int prePage = PageUtil.getPrePage(5);
        System.out.println("当前页码 5 的前一页: " + prePage);
    }
}

• getPrePage(int page)：根据当前页码计算前一页的页码。

  • page：当前页码，从 0 开始。
  • 返回值：前一页的页码。

  作用： 计算前一页的页码，用于分页导航。

  实际开发场景： 当需要在分页导航中显示前一页时，可以使用此方法计算前一页的页码。

6. 根据当前页码计算下一页的页码

PageUtil 提供了 getNextPage 方法，用于计算当前页码的下一页页码。

import cn.hutool.core.util.PageUtil;

public class PageUtilExample {
    public static void main(String[] args) {
        // 当前页码为5，总页数为10
        int nextPage = PageUtil.getNextPage(5, 10);
        System.out.println("当前页码 5 的下一页: " + nextPage);
    }
}

• getNextPage(int page, int totalPage)：根据当前页码计算下一页的页码。

  • page：当前页码，从 0 开始。
  • totalPage：总页数。
  • 返回值：下一页的页码。

  作用： 计算下一页的页码，用于分页导航。

  实际开发场景： 当需要在分页导航中显示下一页时，可以使用此方法计算下一页的页码。

---

总结

PageUtil 工具类在处理分页操作方面提供了强大且简洁的工具方法。它适用于各种需要手动分页的场景，帮助开发者更高效地进行分页处理，提高开发效率。