04.MyBatis的PageHelper分页插件

MyBatis框架提供的PageHelper分页插件的使用

PageHelper是国内非常优秀的一款开源的mybatis分页插件，支持主流与常用的数据库，MySQL、 Oracle、 mariaDB、 DB2、 SQLte、 Hsqldb等
github地址 https://github.com/pagehelper/Mybatis-PageHelper

一. 使用方式介绍

1. jar包导入方式【了解】

   1. https://oss.sonatype.org/content/repositories/releases/com/github/pagehelper/pagehelper/
   2. http://repo1.maven.org/maven2/com/github/pagehelper/pagehelper/
   3. jsqlparser.jar --- sql 解析工具http://repo1.maven.org/maven2/com/github/jsqlparser/jsqlparser/0.9.5/

2. maven坐标【推荐】

二、maven使用方式

1). 在pom.xml中添加依赖

    com.github.pagehelper
    pagehelper
    5.1.2

2). 配置拦截器

MyBatis插件的实现方式是使用的拦截器的原理；新版的拦截器是 com.github.pagehelper.PageInterceptor;而 com.github.pagehelper.PageHelper 现在是一个特殊的 dialect,是分页插件的默认实现类，提供了以前相同的用法。

1. 在Spring配置文件中配置拦截器插件

    
    
    
        
            
            
                
                    
                        oracle
                        true
                    
                

                <-- 或者使用其他方式，替换上面对应的标签体-->
            
        
    

2. 补充写法

    
    
        helperDialect=oracle
    

3). 使用PageHelper.startPage 静态方法调用

在进行分页的MyBatis查询方法前调用PageHelper.startPage静态方法即可，紧跟 在这个方法后的 第一个MyBatis查询相关方法 会被进行分页。

底层的运行原理大致解析：与LocalThread本地线程类变量有关，当调用此静态方法之后，拼接的连接器激活，再次操作与MyBatis相关的方法后会进行分页语句SQL拼接，然后去数据库查询！并且拼接完后，激活状态失活！

1. service层中设置分页查询

// 获取第1页，10条内容，默认查询总数count
PageHelper.startPage(1, 10);

// 紧跟着的第一个select方法会被分页
List list = countryMapper.selectIf(1);

2. Controller中可以创建PageInfo封装全面的的分页信息

// 封装的相关分页信息
PageInfo pageInfo = new PageInfo(list);

三、补充知识介绍

1). 分页插件参数介绍【关注前两个即可】

1. 【helperDialect】: 指定数据库，一般不用配置，底层会自动识别
   • 指定时的参数值：oracle , mysql , mariadb , sqlite , hsqldb , postgresql , db2 , sqlserver , informix , h2 , sqlserver2012 , derby
   • 使用 SqlServer2012 数据库时，需要手动指定为 sqlserver2012 ，否则会使用 SqlServer2005 的方式进行分页。

也可以实现 AbstractHelperDialect ，然后配置该属性为实现类的全限定名称即可使用自定义的实现方法。

2. 【reasonable】: 分页合理化参数，默认值为 false 。当该参数设置为 true 时， pageNum<=0 时会查询第一页， pageNum>pages （超过总数时），会查询最后一页。默认 false 时，直接根据参数进行查询。

3. offsetAsPageNum: 默认值为 false ，该参数对使用 RowBounds 作为分页参数时有效。 当该参数设置为true 时，会将 RowBounds 中的 offset 参数当成 pageNum 使用，可以用页码和页面大小两个参数进行分页。

4. rowBoundsWithCount**: 该参数对使用 RowBounds 作为分页参数时有效。 当该参数设置为 true 时，使用 RowBounds 分页会进行 count 查询。

5. pageSizeZero: 默认值为 false ，当该参数设置为 true 时，如果 pageSize=0 或者 RowBounds.limit =0 就会查询出全部的结果（相当于没有执行分页查询，但是返回结果仍然是 Page 类型）。

6. params: 为了支持 startPage(Object params) 方法，增加了该参数来配置参数映射，用于从对象中根据属性名取值， 可以配置 pageNum,pageSize,count,pageSizeZero,reasonable ，不配置映射的用默认值， 默认值为 pageNum=pageNum;pageSize=pageSize;count=countSql;reasonable=reasonable;pageSizeZero=pageSizeZero

7. supportMethodsArguments: 支持通过 Mapper 接口参数来传递分页参数，默认值 false ，分页插件会从查询方法的参数值中，自动根据上面 params 配置的字段中取值，查找到合适的值时就会自动分页。 使用方法可以参考测试代码中的 com.github.pagehelper.test.basic 包下的 ArgumentsMapTest 和ArgumentsObjTest

8. autoRuntimeDialect: 默认值为 false 。设置为 true 时，允许在运行时根据多数据源自动识别对应方言的分页 （不支持自动选择 sqlserver2012 ，只能使用 sqlserver ）

9. closeConn: 默认值为 true 。当使用运行时动态数据源或没有设置 helperDialect 属性自动获取数据库类型时，会自动获取一个数据库连接， 通过该属性来设置是否关闭获取的这个连接，默认 true 关闭，设置为false 后，不会关闭获取的连接，这个参数的设置要根据自己选择的数据源来决定。

2). MyBatis配置xml文件中配置拦截器插件

3). RowBounds方式的调用

PageHelper的基本使用有6种

1. 使用命名空间方式调用RowBounds

List list = sqlSession.selectList("x.y.selectIf", null, new RowBounds(1, 10));

可以使用RowBounds参数进行分页，这种方式侵入性最小，我们可以看到，通过RowBounds方式调用只是使用了这个参数，并没有增加其他任何内容。分页插件检测到使用了RowBounds参数时，就会对该查询进行物理分页。关于这种方式的调用，有两个特殊的参数是针对 RowBounds 的，可以参看上面的分页插件参数介绍

2. 直接在Dao接口中加入RowBounds参数签名

//这种情况下也会进行物理分页查询
List selectAll(RowBounds rowBounds);

由于默认情况下的 RowBounds 无法获取查询总数，分页插件提供了一个继承自 RowBounds 的PageRowBounds ，这个对象中增加了 total 属性，执行分页查询后，可以从该属性得到查询总数。