分页工具类PaginationHelper的设计与实现

夏佳怡2025-03-132025-03-13

背景

在日常开发中,我们经常需要处理分页查询的场景。比如从数据库分页查询数据,或者调用第三方API进行分页查询。这些分页查询的逻辑往往比较类似:

设定页码(pageIndex)和每页大小(pageSize)
循环查询直到没有更多数据
处理每一页的数据

为了避免重复编写这些模板代码,我设计了一个通用的分页工具类PaginationHelper。

核心实现

PaginationHelper的核心是一个静态方法paginateAndProcess,它接收三个参数:

fetchPageFunction: 分页查询函数,传入页码和每页大小,返回分页结果
pageSize: 每页大小
processDataFunction: 处理每页数据的函数

代码实现如下:

@Slf4j
public class PaginationHelper {
    /**
     * 通用分页遍历方法
     *
     * @param fetchPageFunction   分页查询函数，接收 pageIndex 和 pageSize，返回 PageResp<T>
     * @param pageSize            每页大小
     * @param processDataFunction 处理数据的函数，接收 List<T> 数据
     * @param <T>                 数据类型
     */
    public static <T> void paginateAndProcess(
            BiFunction<Integer, Integer, PageResp<T>> fetchPageFunction,
            int pageSize,
            Consumer<List<T>> processDataFunction
    ) {
        int pageIndex = 1;
        boolean hasMore = true;
        int totalProcessed = 0;
        while (hasMore) {
            PageResp<T> pageResp = fetchPageFunction.apply(pageIndex, pageSize);
            // 处理异常情况
            if (pageResp == null) {
                log.error("Failed to retrieve page {}, stopping pagination", pageIndex);
                return;
            }
            List<T> dataList = pageResp.getDataList();
            if (dataList == null || dataList.isEmpty()) {
                log.info("Page {} data is empty, ending pagination", pageIndex);
                hasMore = false;
                break;
            }
            // 处理数据
            processDataFunction.accept(dataList);
            totalProcessed += dataList.size();
            // 计算分页
            long total = pageResp.getTotal();
            long totalPages = (total + pageSize - 1) / pageSize;
            if (pageIndex >= totalPages) {
                hasMore = false;
            } else {
                pageIndex++;
            }
        }
        log.info("Pagination completed. Total entries processed: {}", totalProcessed);
    }
}

@Data
@NoArgsConstructor
@AllArgsConstructor
public class PageResp<T> implements Serializable {
    public static final long serialVersionUID = 1L;
    private List<T> dataList;
    private Long total;
}

使用示例

以下是一个简单的使用示例:

// 定义分页查询函数
BiFunction<Integer, Integer, PageResp<User>> fetchUsers = (pageIndex, pageSize) -> {
    return userService.queryByPage(pageIndex, pageSize);
};

// 定义数据处理函数
Consumer<List<User>> processUsers = users -> {
    users.forEach(user -> {
        // 处理每个用户数据
        System.out.println(user.getName());
    });
};

// 使用PaginationHelper进行分页处理
PaginationHelper.paginateAndProcess(fetchUsers, 20, processUsers);