Mybatis分页插件PageHelper的配置和使用方法

约定不等于承诺〃 2022-01-28 16:31 288阅读 0赞

# [Mybatis分页插件PageHelper的配置和使用方法][Mybatis_PageHelper] #

*  ***MySQL对分页的支持***

简单来说MySQL对分页的支持是通过limit子句。请看下面的例子。

limit关键字的用法是
    LIMIT [offset,] rows
    offset是相对于首行的偏移量(首行是0)，rows是返回条数。
    
    # 每页10条记录，取第一页，返回的是前10条记录
    select * from tableA limit 0,10;
    # 每页10条记录，取第二页，返回的是第11条记录，到第20条记录，
    select * from tableA limit 10,10;

这里提一嘴的是，MySQL在处理分页的时候是这样的：

limit 1000,10 - 过滤出1010条数据，然后丢弃前1000条，保留10条。当偏移量大的时候，性能会有所下降。

limit 100000,10 - 会过滤10w+10条数据，然后丢弃前10w条。如果在分页中发现了性能问题，可以根据这个思路调优。

*  ***Mybatis分页插件PageHelper***

在使用Java Spring开发的时候，Mybatis算是对数据库操作的利器了。不过在处理分页的时候，Mybatis并没有什么特别的方法，一般需要自己去写limit子句实现，成本较高。好在有个PageHelper插件。

**1、POM依赖**

Mybatis的配置就不多提了。PageHelper的依赖如下。需要新的版本可以去maven上自行选择

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 </td> 
 <td> <code>&lt;dependency&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;groupId&gt;com.github.pagehelper&lt;/groupId&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;artifactId&gt;pagehelper&lt;/artifactId&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;version&gt;</code><code>4.1</code><code>.</code><code>4</code><code>&lt;/version&gt;</code> <code>&nbsp;</code><code>&lt;/dependency&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

**2、Mybatis对PageHelper的配置**

打开Mybatis配置文件，一般在Resource路径下。我这里叫mybatis-config.xml。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 </td> 
 <td> <code>&lt;?xml version=</code><code>"1.0"</code>&nbsp;<code>encoding=</code><code>"UTF-8"</code><code>?&gt;</code> &nbsp; <code>&lt;!DOCTYPE configuration PUBLIC&nbsp;</code><code>"-//mybatis.org//DTD Config 3.0//EN"</code>&nbsp;<code>"http://mybatis.org/dtd/mybatis-3-config.dtd"</code><code>&gt;</code> &nbsp; <code>&lt;configuration&gt;</code> <code>&lt;!-- 全局参数 --&gt;</code> <code>&lt;settings&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;!-- 使全局的映射器启用或禁用缓存。 --&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;setting name=</code><code>"cacheEnabled"</code>&nbsp;<code>value=</code><code>"true"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;!-- 全局启用或禁用延迟加载。当禁用时，所有关联对象都会即时加载。 --&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;setting name=</code><code>"lazyLoadingEnabled"</code>&nbsp;<code>value=</code><code>"true"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;!-- 当启用时，有延迟加载属性的对象在被调用时将会完全加载任意属性。否则，每种属性将会按需要加载。 --&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;setting name=</code><code>"aggressiveLazyLoading"</code>&nbsp;<code>value=</code><code>"true"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;!-- 是否允许单条sql 返回多个数据集&nbsp; (取决于驱动的兼容性)&nbsp;</code><code>default</code><code>:</code><code>true</code>&nbsp;<code>--&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;setting name=</code><code>"multipleResultSetsEnabled"</code>&nbsp;<code>value=</code><code>"true"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;!-- 是否可以使用列的别名 (取决于驱动的兼容性)&nbsp;</code><code>default</code><code>:</code><code>true</code>&nbsp;<code>--&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;setting name=</code><code>"useColumnLabel"</code>&nbsp;<code>value=</code><code>"true"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;!-- 允许JDBC 生成主键。需要驱动器支持。如果设为了</code><code>true</code><code>，这个设置将强制使用被生成的主键，有一些驱动器不兼容不过仍然可以执行。&nbsp;&nbsp;</code><code>default</code><code>:</code><code>false</code>&nbsp;&nbsp;<code>--&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;setting name=</code><code>"useGeneratedKeys"</code>&nbsp;<code>value=</code><code>"true"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;!-- 指定 MyBatis 如何自动映射 数据基表的列 NONE：不隐射　PARTIAL:部分&nbsp; FULL:全部&nbsp; --&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;setting name=</code><code>"autoMappingBehavior"</code>&nbsp;<code>value=</code><code>"PARTIAL"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;!-- 这是默认的执行类型&nbsp; （SIMPLE: 简单； REUSE: 执行器可能重复使用prepared statements语句；BATCH: 执行器可以重复执行语句和批量更新）&nbsp; --&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;setting name=</code><code>"defaultExecutorType"</code>&nbsp;<code>value=</code><code>"SIMPLE"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;!-- 使用驼峰命名法转换字段。 --&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;setting name=</code><code>"mapUnderscoreToCamelCase"</code>&nbsp;<code>value=</code><code>"true"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;!-- 设置本地缓存范围 session:就会有数据的共享&nbsp; statement:语句范围 (这样就不会有数据的共享 ) defalut:session --&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;setting name=</code><code>"localCacheScope"</code>&nbsp;<code>value=</code><code>"SESSION"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;!-- 设置但JDBC类型为空时,某些驱动程序 要指定值,</code><code>default</code><code>:OTHER，插入空值时不需要指定类型 --&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;setting name=</code><code>"jdbcTypeForNull"</code>&nbsp;<code>value=</code><code>"NULL"</code><code>/&gt;</code> <code>&lt;/settings&gt;</code> &nbsp; <code>&lt;plugins&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;plugin interceptor=</code><code>"com.github.pagehelper.PageHelper"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;property name=</code><code>"dialect"</code>&nbsp;<code>value=</code><code>"mysql"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;property name=</code><code>"offsetAsPageNum"</code>&nbsp;<code>value=</code><code>"false"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;property name=</code><code>"rowBoundsWithCount"</code>&nbsp;<code>value=</code><code>"false"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;property name=</code><code>"pageSizeZero"</code>&nbsp;<code>value=</code><code>"true"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;property name=</code><code>"reasonable"</code>&nbsp;<code>value=</code><code>"false"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;property name=</code><code>"supportMethodsArguments"</code>&nbsp;<code>value=</code><code>"false"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;property name=</code><code>"returnPageInfo"</code>&nbsp;<code>value=</code><code>"none"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/plugin&gt;</code> <code>&lt;/plugins&gt;</code> <code>&lt;/configuration&gt;　　</code> </td> 
 </tr> 
 </tbody> 
</table>

这里要注意的是PageHelper相关的配置。

如果你没有加载Mybatis配置文件，那么使用的是Mybatis默认的配置。如何加载Mybatis配置文件呢？

到你的dataSrouce配置中。

在配置sqlSessionFactory的时候，指定Mybatis核心配置文件和mapper的路径，代码如下

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 </td> 
 <td> <code>@Bean</code><code>(name =&nbsp;</code><code>"moonlightSqlSessionFactory"</code><code>)</code> <code>@Primary</code> <code>public</code>&nbsp;<code>SqlSessionFactory moonlightSqlSessionFactory(</code><code>@Qualifier</code><code>(</code><code>"moonlightData"</code><code>) DataSource dataSource)&nbsp;</code><code>throws</code>&nbsp;<code>Exception { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>SqlSessionFactoryBean bean =&nbsp;</code><code>new</code>&nbsp;<code>SqlSessionFactoryBean();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>bean.setDataSource(dataSource);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>bean.setMapperLocations(</code><code>new</code>&nbsp;<code>PathMatchingResourcePatternResolver().getResources(</code><code>"classpath:mybatis-mapper/*.xml"</code><code>));</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>bean.setConfigLocation(</code><code>new</code>&nbsp;<code>ClassPathResource(</code><code>"mybatis-config.xml"</code><code>));</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>bean.getObject();</code> <code>}　</code> </td> 
 </tr> 
 </tbody> 
</table>

说明：

这里配置的mapper.xml存放路径，在Resource/mybatis-mapper文件夹下

这里配置的mybatis-config.xml文件，在Resource/下

**3、分页**

准备一个mapper.xml，测试就随便写一个吧，干脆就用工程里的一个。

这里这个查询，是一个典型的多条件查询，我们要做的是对多条件匹配到的记录进行分页。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 </td> 
 <td> <code>&lt;?xml version=</code><code>"1.0"</code>&nbsp;<code>encoding=</code><code>"UTF-8"</code><code>?&gt;</code> <code>&lt;!DOCTYPE mapper PUBLIC&nbsp;</code><code>"-//mybatis.org//DTD Mapper 3.0//EN"</code>&nbsp;<code>"http://mybatis.org/dtd/mybatis-3-mapper.dtd"</code><code>&gt;</code> <code>&lt;mapper namespace=</code><code>"com.kangaroo.studio.moonlight.dao.mapper.MoonlightMapper"</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;resultMap id=</code><code>"geoFenceList"</code>&nbsp;<code>type=</code><code>"com.kangaroo.studio.moonlight.dao.model.GeoFence"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;constructor&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;idArg column=</code><code>"id"</code>&nbsp;<code>javaType=</code><code>"java.lang.Integer"</code>&nbsp;<code>jdbcType=</code><code>"INTEGER"</code>&nbsp;<code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;arg column=</code><code>"name"</code>&nbsp;<code>javaType=</code><code>"java.lang.String"</code>&nbsp;<code>jdbcType=</code><code>"VARCHAR"</code>&nbsp;<code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;arg column=</code><code>"type"</code>&nbsp;<code>javaType=</code><code>"java.lang.Integer"</code>&nbsp;<code>jdbcType=</code><code>"INTEGER"</code>&nbsp;<code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;arg column=</code><code>"group"</code>&nbsp;<code>javaType=</code><code>"java.lang.String"</code>&nbsp;<code>jdbcType=</code><code>"VARCHAR"</code>&nbsp;<code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;arg column=</code><code>"geo"</code>&nbsp;<code>javaType=</code><code>"java.lang.String"</code>&nbsp;<code>jdbcType=</code><code>"VARCHAR"</code>&nbsp;<code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;arg column=</code><code>"createTime"</code>&nbsp;<code>javaType=</code><code>"java.lang.String"</code>&nbsp;<code>jdbcType=</code><code>"VARCHAR"</code>&nbsp;<code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;arg column=</code><code>"updateTime"</code>&nbsp;<code>javaType=</code><code>"java.lang.String"</code>&nbsp;<code>jdbcType=</code><code>"VARCHAR"</code>&nbsp;<code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/constructor&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;/resultMap&gt;</code> &nbsp; <code>&nbsp;&nbsp;</code><code>&lt;sql id=</code><code>"base_column"</code><code>&gt;id, name, type, `group`, geo, createTime, updateTime &lt;/sql&gt;</code> &nbsp; <code>&nbsp;&nbsp;</code><code>&lt;select id=</code><code>"queryGeoFence"</code>&nbsp;<code>parameterType=</code><code>"com.kangaroo.studio.moonlight.dao.model.GeoFenceQueryParam"</code>&nbsp;<code>resultMap=</code><code>"geoFenceList"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>select &lt;include refid=</code><code>"base_column"</code><code>/&gt; from geoFence where&nbsp;</code><code>1</code><code>=</code><code>1</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>if</code>&nbsp;<code>test=</code><code>"type != null"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>and type = #{type}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/</code><code>if</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>if</code>&nbsp;<code>test=</code><code>"name != null"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>and name like concat(</code><code>'%'</code><code>, #{name},</code><code>'%'</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/</code><code>if</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>if</code>&nbsp;<code>test=</code><code>"group != null"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>and `group` like concat(</code><code>'%'</code><code>, #{group},</code><code>'%'</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/</code><code>if</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>if</code>&nbsp;<code>test=</code><code>"startTime != null"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>and createTime &gt;= #{startTime}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/</code><code>if</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>if</code>&nbsp;<code>test=</code><code>"endTime != null"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>and createTime &lt;= #{endTime}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/</code><code>if</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;/select&gt;</code> <code>&lt;/mapper&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

在Mapper.java接口中编写对应的方法

<table> 
 <tbody> 
 <tr> 
 <td> 1 </td> 
 <td> <code>List&lt;GeoFence&gt; queryGeoFence(GeoFenceQueryParam geoFenceQueryParam);</code> </td> 
 </tr> 
 </tbody> 
</table>

先上分页代码，后面再说明

说明：

1、PageHelper的优点是，分页和Mapper.xml完全解耦。实现方式是以插件的形式，对Mybatis执行的流程进行了强化，添加了总数count和limit查询。属于物理分页。

2、Page page = PageHelper.startPage(pageNum, pageSize, true); - true表示需要统计总数，这样会多进行一次请求select count(0); 省略掉true参数只返回分页数据。

1)统计总数，（将SQL语句变为 select count(0) from xxx,只对简单SQL语句其效果，复杂SQL语句需要自己写）

Page<?> page = PageHelper.startPage(1,-1);

long count = page.getTotal();

2)分页，pageNum - 第N页， pageSize - 每页M条数

A、只分页不统计(每次只执行分页语句)

PageHelper.startPage(\[pageNum\],\[pageSize\]);

List<?> pagelist = queryForList( xxx.class, "queryAll" , param);

//pagelist就是分页之后的结果

B、分页并统计（每次执行2条语句，一条select count语句，一条分页语句）适用于查询分页时数据发生变动，需要将实时的变动信息反映到分页结果上

Page<?> page = PageHelper.startPage(\[pageNum\],\[pageSize\],\[iscount\]);

List<?> pagelist = queryForList( xxx.class , "queryAll" , param);

long count = page.getTotal();

//也可以 List<?> pagelist = page.getList();  获取分页后的结果集

3)使用PageHelper查全部（不分页）

PageHelper.startPage(1,0);

List<?> alllist = queryForList( xxx.class , "queryAll" , param);

4)PageHelper的其他API

String orderBy = PageHelper.getOrderBy();    //获取orderBy语句

Page<?> page = PageHelper.startPage(Object params);

Page<?> page = PageHelper.startPage(int pageNum, int pageSize);

Page<?> page = PageHelper.startPage(int pageNum, int pageSize, boolean isCount);

Page<?> page = PageHelper.startPage(pageNum, pageSize, orderBy);

Page<?> page = PageHelper.startPage(pageNum, pageSize, isCount, isReasonable);    //isReasonable分页合理化,null时用默认配置

Page<?> page = PageHelper.startPage(pageNum, pageSize, isCount, isReasonable, isPageSizeZero);    //isPageSizeZero是否支持PageSize为0，true且pageSize=0时返回全部结果，false时分页,null时用默认配置

5)、默认值

//RowBounds参数offset作为PageNum使用 - 默认不使用

private boolean offsetAsPageNum = false;

//RowBounds是否进行count查询 - 默认不查询

private boolean rowBoundsWithCount = false;

//当设置为true的时候，如果pagesize设置为0（或RowBounds的limit=0），就不执行分页，返回全部结果

private boolean pageSizeZero = false;

//分页合理化

private boolean reasonable = false;

//是否支持接口参数来传递分页参数，默认false

private boolean supportMethodsArguments = false;

3、有一个安全性问题，需要注意一下，不然可能导致分页错乱。我这里直接粘贴了[这篇博客][Link 1]里的一段话。