欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Mybatis分页插件PageHelper使用

程序员文章站 2022-07-02 15:50:32
MyBatis分页插件 Author:SimpleWu 在mybatis中我们需要实现分页功能,如果我们连接的是mysql我们就要写mysql的分页sql,连接oracle就要写oracle的sql语句,这是很不友好的,而我们针对各种不同的数据库的分页我们有一个插件PageHelper PageHe ......

mybatis分页插件

author:simplewu

在mybatis中我们需要实现分页功能,如果我们连接的是mysql我们就要写mysql的分页sql,连接oracle就要写oracle的sql语句,这是很不友好的,而我们针对各种不同的数据库的分页我们有一个插件pagehelper

pagehelper

这一定是最方便使用的分页插件。分页插件支持任何复杂的单表、多表分页。 支持常见的 12 种数据库。oracle,mysql,mariadb,sqlite,db2, postgresql,sqlserver 等

支持常见的rowbounds(pagerowbounds), pagehelper.startpage 方法调用, mapper 接口参数调用

更多用法参照请官方文档:

使用方式

添加依赖

<dependency>
    <groupid>com.github.pagehelper</groupid>
    <artifactid>pagehelper</artifactid>
    <version>4.1.6</version>
</dependency>
<!--由于使用了sql 解析工具-->
<dependency>
    <groupid>com.github.jsqlparser</groupid>
    <artifactid>jsqlparser</artifactid>
    <version>0.9.6</version>
</dependency>

在mybatis-config.xml中配置插件拦截器

 <!-- 插件配置 -->
    <plugins>  
        <!-- com.github.pagehelper为pagehelper类所在包名 -->  
        <plugin interceptor="com.github.pagehelper.pagehelper">  
            <!-- 4.0.0以后版本可以不设置该参数 -->  
            <!-- <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"/>  
            <!-- 3.5.0版本可用 - 为了支持startpage(object params)方法 -->  
            <!-- 增加了一个`params`参数来配置参数映射,用于从map或servletrequest中取值 -->  
            <!-- 可以配置pagenum,pagesize,count,pagesizezero,reasonable,orderby,不配置映射的用默认值 -->  
            <!-- 不理解该含义的前提下,不要随便复制该配置 -->  
            <property name="params" value="pagenum=start;pagesize=limit;"/>  
            <!-- 支持通过mapper接口参数来传递分页参数 -->  
            <property name="supportmethodsarguments" value="true"/>  
            <!-- always总是返回pageinfo类型,check检查返回类型是否为pageinfo,none返回page -->  
            <property name="returnpageinfo" value="check"/>  
        </plugin>  
    </plugins> 

使用方式非常简单,我们只需要在执行查询直接插入pagehelper.startpage(当前页,每页多少数据)就可以完成分页,必须在执行mapper.findall()之前插入

public static void main(string[] args) throws ioexception {
        inputstream inputstream = resources.getresourceasstream("mybatis-config.xml");
        sqlsessionfactory sqlsessionfactory = new sqlsessionfactorybuilder().build(inputstream);
        employeemapper mapper = sqlsessionfactory.opensession().getmapper(employeemapper.class);
        //设置分页参数
        pagehelper.startpage(0, 5);
        list<employee> lists= mapper.findall();
        //传入结果集获取分页数据
        pageinfo<employee> info = new pageinfo<>(lists);
        system.out.println("总记录数:" + info.gettotal());
        system.out.println("当前页数:" + info.getpagenum());
        system.out.println("每页数:" + info.getpagesize());
        system.out.println("总页数:" + info.getpages());
        system.out.println("结果集:" + info.getlist());
    }