PageHelper：上手教程（最详细）-白红宇

PageHelper：上手教程（最详细）

阅读量：793 次

发布时间：2023-02-26

本文共 1685 字，大约阅读时间需要 5 分钟。

PageHelper 是一款基于 MyBatis 的分页插件，旨在简化分页查询逻辑的编写，支持多种分页方式以及结果集的排序、筛选等操作。本文将详细介绍 PageHelper 的主要特点、使用步骤以及高级功能。

PageHelper 的主要特点和功能

无侵入性

使用 PageHelper 进行分页处理时，不需要修改原有的 SQL 语句、Mapper 接口和 XML 文件，保持了 MyBatis 的原有使用习惯。

易用性

通过引入相关依赖和简单的配置，即可实现分页功能，无需编写复杂的分页逻辑代码。

强大功能

支持多种数据库，能够处理复杂的分页查询功能，如排序、聚合查询、连表查询等。

高度自定义

提供了丰富的配置选项和自定义拦截器，可以根据实际需要进行灵活的设置。

PageHelper 的使用步骤

1. 添加依赖

首先，你需要在你的项目中添加 PageHelper 的依赖。如果你使用的是 Maven，可以在 pom.xml 文件中添加如下依赖：


       
    
     com.github.pagehelper
        
    
     pagehelper
        
    
     最新版本

如果你的项目是基于 Spring Boot 的，可以使用 Spring Boot 启动器：


       
    
     com.github.pagehelper
        
    
     pagehelper-spring-boot-starter
        
    
     最新版本

2. 配置 MyBatis

在 MyBatis 的配置文件中（例如 mybatis-config.xml），你需要添加 PageHelper 作为一个插件：

3. 使用 PageHelper

在你的服务层或数据访问层代码中，你可以使用 PageHelper 来执行分页查询。PageHelper 提供了 startPage 方法来指定分页参数：

import com.github.pagehelper.PageHelper;import com.github.pagehelper.PageInfo;// 在查询之前调用 startPage 方法PageHelper.startPage(pageNum, pageSize);// 执行你的查询List
   
     list = yourMapper.selectByExample(new YourExample());// 将结果封装到 PageInfo 对象中PageInfo
    
      pageInfo = new PageInfo<>(list);// PageInfo 对象包含了分页信息，如总记录数、总页数、当前页码等int total = pageInfo.getTotal();int pages = pageInfo.getPages();// 获取列表数据List
     
       list = pageInfo.getList();

4. 高级用法

排序

可以通过 PageHelper.orderBy 方法指定排序字段。

合理化分页

设置 reasonable 属性为 true 时，当 pageNum 大于最大页码时，自动跳转到最大页码。

计数

有时你可能只需要获取总数而不需要查询结果，这时可以使用 PageHelper.count 方法。

注意事项

PageHelper 需要在 MyBatis 查询方法之前调用 startPage 方法。

PageHelper 支持多种数据库，但需要确保你的数据库方言正确设置（如果默认的不符合你的需求）。

PageHelper 支持与 Spring 集成，可以自动配置，简化了使用过程。

通过以上步骤，你可以在你的项目中轻松集成 PageHelper 并实现分页功能。

转载地址：http://pjvfk.baihongyu.com/

你可能感兴趣的文章