Spring Boot,整合Pagehelper分页插件

1.pom.xml引入插件



    com.github.pagehelper
    pagehelper-spring-boot-starter
    1.2.5

2.设置分页插件

//.yml文件
# pagehelper分页配置
pagehelper:
  helper-dialect: mysql
  params: count=countSql
  reasonable: false
  page-size-zero: false
  support-methods-arguments: true
//.xml文件
#分页插件
pagehelper.helper-dialect=mysql
pagehelper.params=count=countSql
pagehelper.reasonable=true
pagehelper.support-methods-arguments=true

分页插件参数介绍

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

3.项目部分代码

        //启动分页后所遇第一个mybatis语句 会分页 后面的分页则无效
        PageHelper.startPage(listQuery.getPage(), listQuery.getLimit());  
        MtcChecklist ety = new MtcChecklist();
        ety.setUserid(userid);
        ety.setLiftnumber(liftnumber);
        //此处会分页 如果后面还有查询则不会分页
        List mtcllist = mtcChecklistMapper.getMtcChecklistByCondition(ety);

        // 获取分页查询后的数据 也可以直接返回PageInfo对象 里面数据都有
        PageInfo pageInfo = new PageInfo<>(mtcllist);
        pdr.setTotal(Long.valueOf(pageInfo.getTotal()).intValue());
        pdr.setRows(mtcllist);
        return setResultSuccess(pdr);

其中:PageHelper.startPage(int PageNum,int PageSize):用来设置页面的位置和展示的数据条目数,我们设置每页展示5条数据。PageInfo用来封装页面信息,返回给前台界面。PageInfo中的一些我们需要用到的参数如下表:

PageInfo.list   结果集
PageInfo.pageNum    当前页码
PageInfo.pageSize   当前页面显示的数据条目
PageInfo.pages  总页数
PageInfo.total  数据的总条目数
PageInfo.prePage    上一页
PageInfo.nextPage   下一页
PageInfo.isFirstPage    是否为第一页
PageInfo.isLastPage 是否为最后一页
PageInfo.hasPreviousPage    是否有上一页
PageHelper.hasNextPage  是否有下一页

你可能感兴趣的:(Spring Boot,整合Pagehelper分页插件)