Mybatis分页插件PageHelper使用

Posted 2021-01-13 Jansens

在mybatis中我们需要实现分页功能，如果我们连接的是mysql我们就要写mysql的分页sql，连接oracle就要写oracle的sql语句，这是很不友好的，而我们针对各种不同的数据库的分页我们有一个插件PageHelper

这一定是最方便使用的分页插件。分页插件支持任何复杂的单表、多表分页。 支持常见的 12 种数据库。Oracle,MySql,MariaDB,SQLite,DB2, PostgreSQL,SqlServer 等

支持常见的RowBounds(PageRowBounds)， PageHelper.startPage 方法调用， Mapper 接口参数调用

更多用法参照请官方文档：https://pagehelper.github.io/docs/howtouse/

添加依赖

<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper</artifactId>
    <version>4.1.6</version>
</dependency>
<!--由于使用了sql 解析工具-->
<dependency>
    <groupId>com.github.jsqlparser</groupId>
    <artifactId>jsqlparser</artifactId>
    <version>0.9.6</version>
</dependency>

在mybatis-config.xml中配置插件拦截器

<!-- 插件配置 -->
    <plugins>  
        <!-- com.github.pagehelper为PageHelper类所在包名 -->  
        <plugin interceptor="com.github.pagehelper.PageHelper">  
            <!-- 4.0.0以后版本可以不设置该参数 -->  
            <!-- <property name="dialect" value="mysql"/>   -->
            <!-- 该参数默认为false -->  
            <!-- 设置为true时，会将RowBounds第一个参数offset当成pageNum页码使用 -->  
            <!-- 和startPage中的pageNum效果一样-->  
            <property name="offsetAsPageNum" value="true"/>  
            <!-- 该参数默认为false -->  
            <!-- 设置为true时，使用RowBounds分页会进行count查询 -->  
            <property name="rowBoundsWithCount" value="true"/>  
            <!-- 设置为true时，如果pageSize=0或者RowBounds.limit = 0就会查询出全部的结果 -->  
            <!-- （相当于没有执行分页查询，但是返回结果仍然是Page类型）-->  
            <property name="pageSizeZero" value="true"/>  
            <!-- 3.3.0版本可用 - 分页参数合理化，默认false禁用 -->  
            <!-- 启用合理化时，如果pageNum<1会查询第一页，如果pageNum>pages会查询最后一页 -->  
            <!-- 禁用合理化时，如果pageNum<1或pageNum>pages会返回空数据 -->  
            <property name="reasonable" value="true"/>  
            <!-- 3.5.0版本可用 - 为了支持startPage(Object params)方法 -->  
            <!-- 增加了一个`params`参数来配置参数映射，用于从Map或ServletRequest中取值 -->  
            <!-- 可以配置pageNum,pageSize,count,pageSizeZero,reasonable,orderBy,不配置映射的用默认值 -->  
            <!-- 不理解该含义的前提下，不要随便复制该配置 -->  
            <property name="params" value="pageNum=start;pageSize=limit;"/>  
            <!-- 支持通过Mapper接口参数来传递分页参数 -->  
            <property name="supportMethodsArguments" value="true"/>  
            <!-- always总是返回PageInfo类型,check检查返回类型是否为PageInfo,none返回Page -->  
            <property name="returnPageInfo" value="check"/>  
        </plugin>  
    </plugins> 

使用方式非常简单，我们只需要在执行查询直接插入PageHelper.startPage(当前页,每页多少数据)就可以完成分页，必须在执行mapper.findAll()之前插入。

 

public static void main(String[] args) throws IOException {
        InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml");
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        EmployeeMapper mapper = sqlSessionFactory.openSession().getMapper(EmployeeMapper.class);
        //设置分页参数
        PageHelper.startPage(0, 5);
        List<Employee> lists= mapper.findAll();
        //传入结果集获取分页数据
        PageInfo<Employee> info = new PageInfo<>(lists);
        System.out.println("总记录数：" + info.getTotal());
        System.out.println("当前页数：" + info.getPageNum());
        System.out.println("每页数：" + info.getPageSize());
        System.out.println("总页数：" + info.getPages());
        System.out.println("结果集：" + info.getList());
    }