MyBatis分页插件PageHelper深度解析与实践指南

<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper</artifactId>
    <version>5.3.2</version> <!-- 使用最新版本 -->
</dependency>

<plugins>
    <plugin interceptor="com.github.pagehelper.PageInterceptor">
        <!-- 配置方言，默认会自动检测 -->
        <property name="helperDialect" value="mysql"/>
        <!-- 分页合理化，页码<=0时查询第一页，>=最大页时查询最后一页 -->
        <property name="reasonable" value="true"/>
        <!-- 支持通过Mapper接口参数来传递分页参数 -->
        <property name="supportMethodsArguments" value="true"/>
        <!-- 总是返回PageInfo类型,默认检查到Page参数不再处理 -->
        <property name="returnPageInfo" value="check"/>
    </plugin>
</plugins>

# PageHelper配置
pagehelper.helper-dialect=mysql
pagehelper.reasonable=true
pagehelper.support-methods-arguments=true
pagehelper.params=count=countSql

// 设置分页参数，查询第1页，每页10条
PageHelper.startPage(1, 10);
// 紧跟着的第一个select方法会被分页
List<User> users = userMapper.selectAll();
// 用PageInfo对结果进行包装
PageInfo<User> pageInfo = new PageInfo<>(users);

// 当前页
pageInfo.getPageNum();
// 每页的数量
pageInfo.getPageSize();
// 当前页的数量
pageInfo.getSize();
// 总记录数
pageInfo.getTotal();
// 总页数
pageInfo.getPages();
// 结果集
pageInfo.getList();
// 是否为第一页
pageInfo.isIsFirstPage();
// 是否为最后一页
pageInfo.isIsLastPage();

// 接口方法
List<User> selectByPage(@Param("name") String name, 
                       @Param("pageNum") int pageNum,
                       @Param("pageSize") int pageSize);

// 调用方式
userMapper.selectByPage("张三", 1, 10);

RowBounds rowBounds = new RowBounds(0, 10);
List<User> users = userMapper.selectByRowBounds(null, rowBounds);

<select id="selectUserWithRole" resultMap="userWithRoleMap">
    select u.*, r.role_name from user u left join role r on u.role_id = r.id
</select>

<!-- 自定义count查询 -->
<select id="selectUserWithRole_COUNT" resultType="long">
    select count(1) from user u
</select>

// 确保调用模式正确
PageHelper.startPage(1, 10);
List<User> list = userMapper.selectAll();

// 错误的排序方式
PageHelper.startPage(1, 10);
PageHelper.orderBy("id desc"); // 这行不会生效

// 正确的排序方式
PageHelper.startPage(1, 10, "id desc");

@Bean
@ConfigurationProperties(prefix = "pagehelper")
public Properties pageHelperProperties() {
    return new Properties();
}

@Bean(name = "pageHelperInterceptor")
public PageInterceptor pageHelperInterceptor() {
    PageInterceptor pageInterceptor = new PageInterceptor();
    pageInterceptor.setProperties(pageHelperProperties());
    return pageInterceptor;
}

// 为每个SqlSessionFactory添加插件
@Bean
public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
    SqlSessionFactoryBean factory = new SqlSessionFactoryBean();
    factory.setDataSource(dataSource);
    // 添加其他配置...
    factory.setPlugins(new Interceptor[]{pageHelperInterceptor()});
    return factory.getObject();
}