MyBatis三剑客之分页插件的应用

  数据分页功能是软件系统中必备的功能，在持久层使用mybatis的情况下，pageHelper实现后台分页是我们常用的一个选择。

一、pageHelper的使用

1、在pom.xml中导入相应的依赖

<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper</artifactId>
    <version>最新版本</version>
</dependency>

2、添加Plugin

在MyBatis的全局配置文件中进行配置，如下：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration
		PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
		"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>

	<plugins>
		<!-- com.github.pagehelper为PageHelper类所在包名 -->
		<plugin interceptor="com.github.pagehelper.PageHelper">
		    <!-- 设置数据库类型Oracle、mysql、MariaDB、SQLite、Hsqldb、PostgreSQL-->
			<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="false" />
			<!-- 3.5.0版本可用 - 为了支持startPage(Object params)方法 -->
			<!-- 增加了一个`params`参数来配置参数映射，用于从Map或ServletRequest中取值 -->
			<!-- 可以配置pageNum,pageSize,count,pageSizeZero,reasonable,不配置映射的用默认值 -->
			<!-- 不理解该含义的前提下，不要随便复制该配置 -->
			<property name="params" value="pageNum=start;pageSize=limit;" />
			<!-- always总是返回PageInfo类型,check检查返回类型是否为PageInfo,none返回Page -->
			<property name="returnPageInfo" value="check" />
			<!-- 设置数据库类型 Oracle,Mysql,MariaDB,SQLite,Hsqldb,PostgreSQL六种数据库-->        
            <property name="dialect" value="mysql"/>
		</plugin>
	</plugins>
</configuration>

3、在Java工程中使用分页插件

public class Test {
    private static SqlSessionFactory sqlSessionFactory;
    @BeforeClass
    public static void init() {
        try {
            Reader reader=Resources.getResourceAsReader("Mybatis-Config.xml");
            sqlSessionFactory=new SqlSessionFactoryBuilder().build(reader);
            reader.close();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
    
    @Test
    public void testSelectAll() {
        SqlSession session=sqlSessionFactory.openSession();
        try {
            //分页处理，显示第一页的5条数据
            PageHelper.startPage(1, 5);
            List<Country> countryList=session.selectList("selectAll");
            countryList.forEach(System.out::println);
            // 取分页信息
            PageInfo<Country> pageInfo = new PageInfo<Country>(countryList);
            long total = pageInfo.getTotal(); //获取总记录数
        } catch (Exception e) {
            e.printStackTrace();
        }finally {
            //关闭session
            session.close();
        }
    }
}

二、pageHelper的原理

参考链接：https://www.cnblogs.com/dengpengbo/p/10579631.html

其他相关链接：https://www.jianshu.com/p/c70722f55d74