mybatis分页插件PageHelper入门

PageHelper是国内非常优秀的一款开源的mybatis分页插件，它支持基本主流与常用的数据库，例如mysql、oracle、mariaDB、DB2、SQLite、Hsqldb等。功能强大，使用简便。

github 的项目地址：https://github.com/pagehelper/Mybatis-PageHelper

PageHelper使用

1.maven集成

在 pom.xml 中添加如下依赖：

<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper</artifactId>
    <!--版本写最新的就行-->
    <version>5.1.2</version>
</dependency>

2.配置

新版拦截器是 com.github.pagehelper.PageInterceptor 。 com.github.pagehelper.PageHelper 现在是一个特殊的 dialect 实现类，是分页插件的默认实现类，提供了和以前相同的用法。

2.1在 MyBatis 配置 xml 中配置拦截器插件

<plugins>
    <!-- com.github.pagehelper为PageHelper类所在包名 -->
    <plugin interceptor="com.github.pagehelper.PageInterceptor">
        <!-- 使用下面的方式配置参数，后面会有所有的参数介绍 -->
        <property name="param1" value="value1"/>
    </plugin>
</plugins>

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

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <!-- 注意其他配置 -->
    <property name="plugins">
        <array>
            <bean class="com.github.pagehelper.PageInterceptor">
                <property name="properties">
                <!--使用下面的方式配置参数，一行配置一个 -->
                    <props>
                    <!--常用的两个，helperDialect配置操作数据库的类型-->
                        <prop key="helperDialect">oracle</prop>
                        <!--reasonable配置分页合理化(超过第一页第一页，超过最后一页即为最后一页)-->
                        <prop key="reasonable">true</prop>
                    </props>
                </property>
            </bean>
        </array>
    </property>
</bean>

2.3 分页插件参数介绍

1. helperDialect ：分页插件会自动检测当前的数据库链接，自动选择合适的分页方式。 你可以配置
   helperDialect 属性来指定分页插件使用哪种方言。配置时，可以使用下面的缩写值：
   oracle , mysql , mariadb , sqlite , hsqldb , postgresql , db2 , sqlserver , informix , h2 , sqlserver201
   2 , 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 后，不会关闭获取的连接，这个参数的设置要根据自己选择的数据源来决定。

3.基本使用

3.1.PageHelper.startPage 静态方法调用

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

3.2.举例：订单分页查询

3.2.1 Service

@Override
public List<Orders> findAllByPage(int page, int pageSize) throws Exception {

    //调用静态方法startPage，即实现分页查询，参数page为当前页码，pageSize为当前每页显示条数
    PageHelper.startPage(page, pageSize);

    return ordersDao.findAllByPage();
}

3.2.2 Controller

@RequestMapping("/findAll.do")
public ModelAndView findAll(@RequestParam(name = "page", required = true, defaultValue = "1")
Integer page, @RequestParam(name = "pageSize", required = true, defaultValue = "10") Integer
pageSize) throws Exception {
    List<Orders> ordersList = ordersService.findAllByPage(page, pageSize);

    //PageHelper为我们提供了PageInfo类封装分页数据
    PageInfo pageInfo = new PageInfo(ordersList);

    ModelAndView mv = new ModelAndView();
    mv.setViewName("order-list");
    mv.addObject("pageInfo", pageInfo);
    return mv;
}

3.2.3 订单分页查询页面Order-list.jsp

PageInfo是封装了分页信息的JavaBean,其字段有：

private int pageNum; //当前页码
private int pageSize; //每页显示的条数
private int size; // 该页显示的条数
private int startRow;
private int endRow;
private long total; //总记录数
private int pages; //总页数
private List list; //分页数据
private int prePage; //上一页
private int nextPage; //下一页
private boolean isFirstPage; //当前是否是第一页
private boolean isLastPage; //当前是否是最后一页
private boolean hasPreviousPage; //是否有前一页
private boolean hasNextPage; //是否有下一页
private int navigatePages;
private int[] navigatepageNums;
private int navigateFirstPage;
private int navigateLastPage;

(当笔记写的，自己怕忘)