MyBatis分页插件PageHelper使用方法

1.导入相关依赖坐标

<!-- MyBatis分页插件 -->

            <dependency>

                <groupId>com.github.pagehelper</groupId>

                <artifactId>pagehelper</artifactId>

                <version>5.2.0</version>====

            </dependency>

2.在application.xml或者spring-mybatis.xml中配置相关参数

(1)application.xml中配置

<!--4.配置SQLSessionFactory工厂-->

    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">

        <!--指定mybatis全局配置文件-->

        <property name="configLocation" value="classpath:mybatis-config.xml"/>

        <!--指定数据源-->

        <property name="dataSource" ref="dataSource"/>

        <!--指定mapper文件的位置-->

        <property name="mapperLocations" value="classpath:mapper/*Mapper.xml"/>

        <!--配置插件-->

        <property name="plugins">

            <array>

                <!--配置分页插件-->

                <bean class="com.github.pagehelper.PageInterceptor">

                    <property name="properties">

                        <props>

                            <!--配置数据库方言，告诉PageHelper-->

                            <!--<prop key="dialect">mysql</prop>-->

                            <!--配置页码合理化修正-->

                            <prop key="reasonable">true</prop>

                        </props>

                    </property>

                </bean>

            </array>

        </property>

    </bean>

(2)spring-mybatis.xml中配置

    <!--

    plugins在配置文件中的位置必须符合要求，否则会报错，顺序如下:

    properties?, settings?,

    typeAliases?, typeHandlers?,

    objectFactory?,objectWrapperFactory?,

    plugins?,

    environments?, databaseIdProvider?, mappers?

-->

<plugins>

    <!-- com.github.pagehelper为PageHelper类所在包名 -->

    <plugin interceptor="com.github.pagehelper.PageHelper">

        <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"/>

    </plugin>

</plugins>

参数说明

1)、helperDialect：分页插件会自动检测当前的数据库链接，自动选择合适的分页方式。你可以配置helperDialect属性来指定分页插件使用哪种方言。配置时，可以使用下面的缩写值：oracle,mysql,mariadb,sqlite,hsqldb,postgresql,db2,sqlserver,informix,h2,sqlserver2012,derby特别注意：使用 SqlServer2012数据库时，需要手动指定为sqlserver2012，否则会使用 SqlServer2005 的方式进行分页。

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

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