PageHelper学习与使用记录（借助插件完成分页查询）

最新推荐文章于 2024-02-01 18:42:34 发布

IT小白想变大佬

最新推荐文章于 2024-02-01 18:42:34 发布

阅读量220

点赞数

文章标签： java

本文链接：https://blog.csdn.net/qq_41732653/article/details/110176128

版权

使用步骤：

maven中导入坐标

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

修改配置文件：此处要理解pageHelper是作为Mybatis框架的一个插件存在的，所以此处配置文件的配置，在单独使用Mybatis框架中，直接配置其插件即可。在与spring框架的整合中，在applicationContext.xml中配置，配置位置即sqlSession的工厂标签下引入。
注意此处配置的是页面拦截器，PageInterceptor

 <!--配置一个生产SqlSession对象的工厂-->
    <bean id="sessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource"></property>
        <property name="typeAliasesPackage" value="com.itcast.domain"></property>
        <!--传入pageHelper插件-->
        <property name="plugins">
            <array>
                <!--传入插件的对象-->
                <bean class="com.github.pagehelper.PageInterceptor">
                    <property name="properties">
                        <props>
                            <prop key="helperDialect">oracle</prop>
                            <prop key="reasonable">true</prop>
                        </props>
                    </property>
                </bean>
            </array>
        </property>
    </bean>

此处配置文件中有很多该插件的配置参数可以选择，上述代码中配置的两个参数的含义分别为：
helperDialect：连接的数据库类型，此处选择的是Oracle
reasonable：数据合理化，配置为true意味着自动帮助锁定第一页点击上一页，和最后一页点击下一页时不出错。
具体的参数粘贴到文末方便查阅。

使用：（使用方法有6种，此处静态调用）
（1）在service层实现分页查询，在实现查询语句之前静态调用PageHelper.startPage()方法。

public List<Orders> findAll() {
        /*实现分页查询，查询第一页（当前页），
        每页显示4条，
        */
        PageHelper.startPage(1,4);
        return orderDao.findAll();
    }

在实际的开发应用中，当前页和每页显示条数两个参数不能写死，要从前端页面传递回来两个参数，好让后端dao层知道查询从哪条开始到哪条结束的数据，并将数据返回。具体可参照如下代码，

public List<Orders> findAll(Integer page,Integer size) {

       /*page:当前所要查询的页码，
       *size:每页显示的条数
       */
        PageHelper.startPage(page,size);
        return orderDao.findAll();
    }

为什么要这两个参数就能知道查询从哪里开始的数据？
公式：起始索引=（当前页码-1）×每页显示条数。
在MySQL中，可以使用特有的方言：limit 起始索引，每页显示条数实现分页查询。
在Oracle中，可以使用rownum行号，三次嵌套select查询实现分页查询。具体可看代码

select * from(
	select rownum rn,tt.* from(
		select * from emp order by sal desc) tt
		where rownum< endrow
		)where rn> startrow

（2）修改前端控制器，前端控制器要使用一个JavaBean对象来封装从service层查询回来的数据，此处应该是一个list集合数据，在PageHelper插件中提供了这样的一个JavaBean：PageInfo，该Bean对象几乎包含了分页查询中前后端交互的所有数据。具体实现可看源码，此处贴出源码中的属性。

private static final long serialVersionUID = 1L;
    //当前页
    private int pageNum;
    //每页的数量
    private int pageSize;
    //当前页的数量
    private int size;

    //由于startRow和endRow不常用，这里说个具体的用法
    //可以在页面中"显示startRow到endRow 共size条数据"

    //当前页面第一个元素在数据库中的行号
    private int startRow;
    //当前页面最后一个元素在数据库中的行号
    private int endRow;
    //总记录数
    private long total;
    //总页数
    private int pages;
    //结果集
    private List<T> list;

    //前一页
    private int prePage;
    //下一页
    private int nextPage;

    //是否为第一页
    private boolean isFirstPage = false;
    //是否为最后一页
    private boolean isLastPage = false;
    //是否有前一页
    private boolean hasPreviousPage = false;
    //是否有下一页
    private boolean hasNextPage = false;
    //导航页码数
    private int navigatePages;
    //所有导航页号
    private int[] navigatepageNums;
    //导航条上的第一页
    private int navigateFirstPage;
    //导航条上的最后一页
    private int navigateLastPage;

（3）修改前端页面。
前端控制器将域对象pageInfo存入，在前端页面上就直接用pageInfo在相应的地方取值即可。此处前端页面用jsp实现的，html实现时使用ajax异步请求。

补充插件参数含义：

helperDialect ：分页插件会自动检测当前的数据库链接，自动选择合适的分页方式。你可以配置helperDialect 属性来指定分页插件使用哪种方言。配置时，可以使用下面的缩写值：
oracle , mysql , mariadb , sqlite , hsqldb , postgresql , db2 , sqlserver , informix , h2 , sqlserver2012 , derby
特别注意：使用 SqlServer2012 数据库时，需要手动指定为 sqlserver2012 ，否则会使用 SqlServer2005 的方式进行分页。
你也可以实现 AbstractHelperDialect ，然后配置该属性为实现类的全限定名称即可使用自定义的实现方法。
offsetAsPageNum ：默认值为 false ，该参数对使用 RowBounds 作为分页参数时有效。当该参数设置为true 时，会将 RowBounds 中的 offset 参数当成 pageNum 使用，可以用页码和页面大小两个参数进行分页。
rowBoundsWithCount ：默认值为 false ，该参数对使用 RowBounds 作为分页参数时有效。当该参数设置为 true 时，使用 RowBounds 分页会进行 count 查询。
pageSizeZero ：默认值为 false ，当该参数设置为 true 时，如果 pageSize=0 或者 RowBounds.limit =0 就会查询出全部的结果（相当于没有执行分页查询，但是返回结果仍然是 Page 类型）。
reasonable ：分页合理化参数，默认值为 false 。当该参数设置为 true 时， pageNum<=0 时会查询第一页， pageNum>pages （超过总数时），会查询最后一页。默认 false 时，直接根据参数进行查询。
params ：为了支持 startPage(Object params) 方法，增加了该参数来配置参数映射，用于从对象中根据属性名取值，可以配置 pageNum,pageSize,count,pageSizeZero,reasonable ，不配置映射的用默认值，默认值为
pageNum=pageNum;pageSize=pageSize;count=countSql;reasonable=reasonable;pageSizeZero=pageSizeZero。
supportMethodsArguments ：支持通过 Mapper 接口参数来传递分页参数，默认值 false ，分页插件会从查
询方法的参数值中，自动根据上面 params 配置的字段中取值，查找到合适的值时就会自动分页。使用方法
可以参考测试代码中的 com.github.pagehelper.test.basic 包下的 ArgumentsMapTest 和ArgumentsObjTest 。
autoRuntimeDialect ：默认值为 false 。设置为 true 时，允许在运行时根据多数据源自动识别对应方言的分页（不支持自动选择 sqlserver2012 ，只能使用 sqlserver ），用法和注意事项参考下面的场景五。
closeConn ：默认值为 true 。当使用运行时动态数据源或没有设置 helperDialect 属性自动获取数据库类
型时，会自动获取一个数据库连接，通过该属性来设置是否关闭获取的这个连接，默认 true 关闭，设置为
false 后，不会关闭获取的连接，这个参数的设置要根据自己选择的数据源来决定。