MyBatis分页插件pageHelper配置和使用

1、PageHelper简介

这是一个基于MyBatis开源的分页插件,使用非常方便,支持各种复杂的单表、多表分页查询,让你在写sql时无需考虑分页问题,PageHelper帮你搞定。项目托管在github上https://github.com/pagehelper/Mybatis-PageHelper

2、在项目中引入PageHelper

PageHelper是一个通用的MyBatis分页插件,在使用的时候除了要导入MyBatis和数据库驱动的jar包外,还要导入PageHelper的依赖包。

<!--MyBatis通用分页插件pageHelper-->
<dependency>
	<groupId>com.github.pagehelper</groupId>
	<artifactId>pagehelper</artifactId>
	<version>5.1.6</version>
</dependency>
<!--分页插件依赖的包-->
<dependency>
	<groupId>com.github.jsqlparser</groupId>
	<artifactId>jsqlparser</artifactId>
	<version>0.9.5</version>
</dependency>

3、分页插件的配置

配置PageHepler插件对方法有很多种,这里我有最基础的一种方法,使用mybatis-config.xml全局配置文件来配置。配置也很简单,只需要在mybatis-config.xml添加如下配置:

<!--配置拦截器插件-->
<plugins>
   <plugin interceptor="com.github.pagehelper.PageInterceptor">
        <property name="dialect" value="mysql"/>
        <property name="offsetAsPageNum" value="false"/>
        <property name="rowBoundsWithCount" value="false"/>
        <property name="pageSizeZero" value="true"/>
        <property name="reasonable" value="false"/>
        <property name="supportMethodsArguments" value="false"/>
        <property name="returnPageInfo" value="none"/>
   </plugin>
</pligins>

配置参数详解

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

4、在代码中使用PageHelper

完成上面的操作后对分页插件的配置就完成了,使用方法也很简单:使用PageHelper.statPage静态方法来分页,使用PageInfo来获取分页信息

 @RequestMapping("/showAll")
    public String showAllBook(@RequestParam(value = "pageNo",defaultValue = "1") Integer pageNo,Model model) {
        //官方推荐的两种使用方式
        //1.使用PageHelper.startPage(pageNo,10)进行分页,第一个参数是页码,第二个参数是每页的大小
        PageHelper.startPage(pageNo,20);
        List<Book> lists = bookService.getAll();

        /**2.使用PageHelper.offsetPage()
        *PageHelper.offsetPage(pageNo,20);
        *List<Book> lists = bookService.getAll();
        */

       
        //可以有两个参数,第一个参数是查询到的结果、第二个参数是连续显示的页码数
        PageInfo<Book> info=new PageInfo<Book>(lists,10);
        model.addAttribute("info", info);
        return "bookInfo";
    }

注意:
    1.PageHelper.startPage(pageNum, pageSize);语句之后,第一个SQL语句,必须为要进行分页的(全)查询语句。 追注:如果在PageHelper.startPage()方法之后,先执行了其他的sql语句,然后再执行的要分页的查询的话;那么分页会失效。
    2.由于分页插件是通过拦截器,在原有SQL上进行追加约束条件,所以使用分页插件时,应注意:保证原有SQL不会 受后面追加的条件的影响。给出一个反例:原有SQL中使用变量计算排名时,如果在后面追加了LIMIT的话,那么排名就会受到影响,因为SELECT的优先级在LIMIT之后。
    3.PageInfo是比Page信息更丰富的一个类;我们可以直接返回Page,也可以使用PageInfo包装一下返回PageInfo,甚至也可以自定义一个类来存放结果信息(只需将返回的Page中的信息取出来,再setter放入我们自己的类即可)。

5、PageHelper常用的API

PageMethod的API
PageHelper继承了抽象类PageMethod,而使用PageHelper进行分页操作的方法实际是在PageMethod中的方法,具体如下:

/**startPage方法都有下面几个内存
pageNum    int类型,当前页码
pageSize   int类型,每页的大小
count      boolean类型,是否在分页的时候统计记录数 
reasonable  boolean类型, isReasonable分页合理化,null时用默认配置
pageSizeZero   boolean类型,isPageSizeZero是否支持PageSize为0,true且pageSize=0时返回全部结果,false时分页,null时用默认配置
*/
public static <E> Page<E> startPage(Object params)
public static <E> Page<E> startPage(int pageNum, int pageSize)
public static <E> Page<E> startPage(int pageNum, int pageSize, boolean count)
public static <E> Page<E> startPage(int pageNum, int pageSize, String orderBy)
public static <E> Page<E> startPage(int pageNum, int pageSize, boolean count, Boolean reasonable, Boolean pageSizeZero)
//offsetPage方法和startPage一样都是用来分页的offset相当于pageNum,limit相当于PageSize
public static <E> Page<E> offsetPage(int offset, int limit)
public static <E> Page<E> offsetPage(int offset, int limit, boolean count)
//设置排序规则DESC、ASC
public static void orderBy(String orderBy)

PageInfo中的成员变量
每一个成员变量都有对应的get和set方法,使用这些方法可以获得分页的任何信息,这个类十分强大

//两个重要的构造方法,list是查询到的结果,navigatePages是下方显示的导航页码ge
public PageInfo(List<T> list)
public PageInfo(List<T> list, int navigatePages)
//当前页
private int pageNum;
//每页的数量
private int pageSize;
//当前页的数量
private int size;
//当前页面第一个元素在数据库中的行号
private int startRow;
//当前页面最后一个元素在数据库中的行号
private int endRow;
//总记录数
private long total;
//总页数
private int pages;
//结果集
private List<T> list;
//第一页
private int firstPage;
//前一页
private int prePage;
//是否为第一页
private boolean isFirstPage;
//是否为最后一页
private boolean isLastPage;
//是否有前一页
private boolean hasPreviousPage;
//是否有下一页
private boolean hasNextPage;
//导航页码数
private int navigatePages;
//所有导航页号
private int[] navigatepageNums;

追加
现在SpringBoot已经是Java开发中非常流行的一个框架了,如果我们需要在基于SpringBoot开发的项目中使用pageHelper,只需要更换pageHelper的pom依赖,然后我们无需在写繁杂的xml配置文件了,只需要在SpringBoot的配置文件中写如下配置即可。

(1)引入pageHelper依赖

<dependency>
   <groupId>com.github.pagehelper</groupId>
   <artifactId>pagehelper-spring-boot-starter</artifactId>
   <version>1.2.5</version>
</dependency>

(2)编写配置

mybatis:
  config-location: classpath:/mybatis/mybatis-config.xml
  mapper-locations: classpath:/mybatis/mapper/*.xml
#配置pahehelper  
pagehelper:
  helper-dialect: mysql
  params:
   count: countSql
  reasonable: false
  support-methods-arguments: true

留言区

还能输入500个字符