Mybatis的pagehelper插件—分页

使用步骤：

• 1.导入maven的依赖

        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper</artifactId>
            <version>5.1.2</version>
        </dependency>

• 2.单独使用mybatis的情况,在mybatis的配置文件中

<!--     
    plugins在配置文件中的位置必须符合要求，否则会报错，顺序如下:    
    properties?, settings?,     
    typeAliases?, typeHandlers?,     
    objectFactory?,objectWrapperFactory?,    
     plugins?,     
    environments?, databaseIdProvider?, mappers? 
--> 
<plugins>    
    <!-- com.github.pagehelper为PageHelper类所在包名 -->    
    <plugin interceptor="com.github.pagehelper.PageInterceptor">        
    <!-- 使用下面的方式配置参数，后面会有所有的参数介绍 -->        
    <property name="param1" value="value1"/>    
    </plugin> 
</plugins>

• 2.mybatis与spring一起使用的情况，在spring的配置文件中

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">  
    <!-- 传入pagehelper的插件 -->  
    <property name="plugins">    
        <array>   
            <!-- 传入插件的对象 -->   
            <bean class="com.github.pagehelper.PageInterceptor">        
                <property name="properties">          
                   <props>
                        <prop key="helperDialect">mysql</prop>
                        <prop key="reasonable">true</prop>
                   </props>      
                </property>      
            </bean>    
        </array>  
    </property> 
</bean>

• 3. PageHelper.startPage 静态方法调用（重点）
  这种方式是我们要掌握的 在你需要进行分页的 MyBatis 查询方法前调用PageHelper.startPage 静态方法即可，紧 跟在这个方法后的第一个MyBatis 查询方法会被进行分页

//第一个参数是页码值，第二个参数是每页显示条数
//获取第1页，10条内容，默认查询总数count 
PageHelper.startPage(1, 10); 
//紧跟着的第一个select方法会被分页 
List<Country> list = countryMapper.selectIf(1);

 

分页插件参数

1. helperDialect ：分页插件会自动检测当前的数据库链接，自动选择合适的分页方式。 你可以配置 helperDialect 属性来指定分页插件使用哪种方言。配置时，可以使用下面的缩写值： oracle , mysql , mariadb , sqlite , hsqldb , postgresql , db2 , sqlserver , informix , h2 , sqlserver201 2 , derby

特别注意：使用 SqlServer2012 数据库时，需要手动指定为 sqlserver2012 ，否则会使用 SqlServer2005 的 方式进行分页

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

3. rowBoundsWithCount ：默认值为 false ，该参数对使用 RowBounds 作为分页参数时有效。 当该参数设置 为 true 时，使用 RowBounds 分页会进行 count 查询。

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

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

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 后，不会关闭获取的连接，这个参数的设置要根据自己选择的数据源来决定。