幾種常見mybatis分頁的實現(xiàn)方式
更新時間：2023年06月12日 10:35:15 作者：luffy5459
這篇文章主要介紹了幾種常見mybatis分頁的實現(xiàn)方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
幾種常見mybatis分頁實現(xiàn)
mybatis框架分頁實現(xiàn)，有幾種方式，最簡單的就是利用原生的sql關鍵字limit來實現(xiàn)，還有一種就是利用interceptor來拼接sql，實現(xiàn)和limit一樣的功能，再一個就是利用PageHelper來實現(xiàn)。
這里講解這三種常見的實現(xiàn)方式：
無論哪種實現(xiàn)方式，我們返回的結(jié)果，不能再使用List了，需要一個自定義對象Pager。
package com.xxx.mybatis.bean;
import java.util.List;
public class Pager<T> {
private int page;//分頁起始頁
private int size;//每頁記錄數(shù)
private List<T> rows;//返回的記錄集合
private long total;//總記錄條數(shù)
public int getPage() {
return page;
}
public void setPage(int page) {
this.page = page;
}
public int getSize() {
return size;
}
public void setSize(int size) {
this.size = size;
}
public List<T> getRows() {
return rows;
}
public void setRows(List<T> rows) {
this.rows = rows;
}
public long getTotal() {
return total;
}
public void setTotal(long total) {
this.total = total;
}
}limit關鍵字實現(xiàn)
UserDao.java增加兩個方法
public List<User> findByPager(Map<String, Object> params); public long count();
UserMapper.xml中增加兩個查詢
<select id="findByPager" resultType="com.xxx.mybatis.domain.User">
select * from xx_user limit #{page},#{size}
</select>
<select id="count" resultType="long">
select count(1) from xx_user
</select>UserService.java中增加分頁方法
public Pager<User> findByPager(int page,int size){
Map<String, Object> params = new HashMap<String, Object>();
params.put("page", (page-1)*size);
params.put("size", size);
Pager<User> pager = new Pager<User>();
List<User> list = userDao.findByPager(params);
pager.setRows(list);
pager.setTotal(userDao.count());
return pager;
}這是最直觀的實現(xiàn)方式，也是最簡單的，不用任何插件或者工具就能夠很方便的實現(xiàn)的方法。
interceptor plugin實現(xiàn)
需要定義一個類實現(xiàn)Interceptor接口
MyPageInterceptor.java
package com.xxx.mybatis.bean;
import java.sql.Connection;
import java.util.Map;
import java.util.Properties;
import org.apache.ibatis.executor.parameter.ParameterHandler;
import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.plugin.Interceptor;
import org.apache.ibatis.plugin.Intercepts;
import org.apache.ibatis.plugin.Invocation;
import org.apache.ibatis.plugin.Plugin;
import org.apache.ibatis.plugin.Signature;
import org.apache.ibatis.reflection.MetaObject;
import org.apache.ibatis.reflection.SystemMetaObject;
@Intercepts({@Signature(type=StatementHandler.class,method="prepare",args={Connection.class,Integer.class})})
public class MyPageInterceptor implements Interceptor {
private int page;
private int size;
@SuppressWarnings("unused")
private String dbType;
@SuppressWarnings("unchecked")
@Override
public Object intercept(Invocation invocation) throws Throwable {
System.out.println("plugin is running...");
StatementHandler statementHandler = (StatementHandler)invocation.getTarget();
MetaObject metaObject = SystemMetaObject.forObject(statementHandler);
while(metaObject.hasGetter("h")){
Object object = metaObject.getValue("h");
metaObject = SystemMetaObject.forObject(object);
}
while(metaObject.hasGetter("target")){
Object object = metaObject.getValue("target");
metaObject = SystemMetaObject.forObject(object);
}
MappedStatement mappedStatement = (MappedStatement)metaObject.getValue("delegate.mappedStatement");
String mapId = mappedStatement.getId();
if(mapId.matches(".+ByPager$")){
ParameterHandler parameterHandler = (ParameterHandler)metaObject.getValue("delegate.parameterHandler");
Map<String, Object> params = (Map<String, Object>)parameterHandler.getParameterObject();
page = (int)params.get("page");
size = (int)params.get("size");
String sql = (String) metaObject.getValue("delegate.boundSql.sql");
sql += " limit "+(page-1)*size +","+size;
metaObject.setValue("delegate.boundSql.sql", sql);
}
return invocation.proceed();
}
@Override
public Object plugin(Object target) {
return Plugin.wrap(target, this);
}
@Override
public void setProperties(Properties properties) {
String limit = properties.getProperty("limit","10");
this.page = Integer.parseInt(limit);
this.dbType = properties.getProperty("dbType", "mysql");
}
}我們之前在service的findByPager方法里面，為了給limit傳入兩個參數(shù)，其中page做了計算，這里使用攔截器的方式就無需計算了：
public Pager<User> findByPager(int page,int size){
Map<String, Object> params = new HashMap<String, Object>();
params.put("page", page);
params.put("size", size);
Pager<User> pager = new Pager<User>();
List<User> list = userDao.findByPager(params);
pager.setRows(list);
pager.setTotal(userDao.count());
return pager;
}spring配置中，增加plugin設置:
到這里，你也許也猜到了MyPageInterceptor實際上是以一種攔截器的方式在程序執(zhí)行findByPager方法的時候，對語句會增加limit page,size的拼接，還是和第一種原生實現(xiàn)思路一樣，所以這里需要對UserMapper.xml配置文件中的findByPager這個查詢對應的語句中的limit #{page},#{size}這部分去掉，變?yōu)槿缦碌臉幼樱?/p>
至此，通過攔截器插件的方式也實現(xiàn)了分頁功能了。
PageHelper實現(xiàn)
這種方式實現(xiàn)需要我們引入maven依賴。
<dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper</artifactId> <version>4.2.1</version> </dependency>
spring.xml配置文件做一下修改：
<bean id="pageInterceptor" class="com.github.pagehelper.PageHelper"> <property name="properties"> <props> <prop key="helperDialect">mysql</prop> <prop key="reasonable">true</prop> <prop key="supportMethodsArguments">true</prop> <prop key="params">count=countSql</prop> </props> </property> </bean> <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"> <property name="dataSource" ref="dataSource" /> <property name="mapperLocations" value="classpath:com/xxx/mybatis/dao/*Mapper.xml"/> <property name="plugins" ref="pageInterceptor"></property> </bean>
service層的方法，做一些修改：
public Pager<User> findByPager(int page,int size){
Pager<User> pager = new Pager<User>();
Page<User> res = PageHelper.startPage(page,size);
userDao.findAll();
pager.setRows(res.getResult());
pager.setTotal(res.getTotal());
return pager;
}至此，PageHelper工具方法實現(xiàn)分頁也實現(xiàn)了。其實PageHelper方法也是第二種使用Interceptor攔截器方式的一種三方實現(xiàn)，它內(nèi)部幫助我們實現(xiàn)了Interceptor的功能。
所以我們不用自定義MyPageInterceptor這個類了。實際上也是在運行查詢方法的時候，進行攔截，然后設置分頁參數(shù)。
所以PageHelper.startPage(page,size)這一句需要顯示調(diào)用，然后再執(zhí)行userDao.findAll()，在查詢所有用戶信息的時候，會進行一個分頁參數(shù)設置，讓放回的結(jié)果只是分頁的結(jié)果，而不是全部集合。
mybatis實現(xiàn)分頁查詢
使用mybatis整合時，最容易遇到的需求就是分頁了，pagehelper 分頁插件是一個非常實用的 MyBatis分頁插件，可以快速的實現(xiàn)MyBatis分頁功能，而且pagehelper有個優(yōu)點就是分頁和Mapper.xml完全解耦，并以插件的形式實現(xiàn)，有效的避免了直接寫分頁SQL語句來實現(xiàn)分頁功能
分頁插件原理
分頁插件的基本原理是使用Mybatis提供的插件接口，實現(xiàn)自定義插件，在插件的攔截方法內(nèi)攔截待執(zhí)行的sql，然后重寫sql，添加對應的物理分頁語句和物理分頁參數(shù)
舉例：
select * from student
攔截sql后重寫為：
select t.* from （select * from student）t limit 0，10
1.引入pagehelper依賴
<dependency> ? ?<groupId>com.github.pagehelper</groupId> ? ?<artifactId>pagehelper</artifactId> ? ?<version>5.1.11</version> </dependency>
2.配置攔截器
這個是配置在mybatis-config.xml文件中
<plugins> ? ? ? ? <plugin interceptor="com.github.pagehelper.PageInterceptor"> ? ? ? ? ? ? <property name="param1" value="value1"/> ? ? ? ? </plugin> ? ? </plugins>
3.在代碼中的使用
@RequestMapping("/emps")
? ? public String list(@RequestParam(required = false,defaultValue = "1",value = "pn")Integer pn,
? ? ? ? ? ? ? ? ? ? ? ?Map<String,Object> map){
? ? ? ? //引入分頁查詢，使用PageHelper分頁功能
? ? ? ? //在查詢之前傳入當前頁，然后多少記錄
? ? ? ? PageHelper.startPage(pn,5);
? ? ? ? //startPage后緊跟的這個查詢就是分頁查詢
? ? ? ? List<Employee> emps = employeeService.getAll();
? ? ? ? //使用PageInfo包裝查詢結(jié)果，只需要將pageInfo交給頁面就可以
? ? ? ? PageInfo pageInfo = new PageInfo<>(emps,5);
? ? ? ? //pageINfo封裝了分頁的詳細信息，也可以指定連續(xù)顯示的頁數(shù)
? ? ? ? map.put("pageInfo",pageInfo);
? ? ? ? return "list";
? ? }總結(jié)
以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關文章
Spring Cloud超詳細i講解Feign自定義配置與使用
這篇文章主要介紹了SpringCloud Feign自定義配置與使用,本文通過實例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2022-06-06
這篇文章主要介紹了Java MongoDB實現(xiàn)REST過程解析,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-08-08
MyBatis?Generator生成數(shù)據(jù)庫模型實現(xiàn)示例
這篇文章主要為大家介紹了MyBatis?Generator生成數(shù)據(jù)庫模型實現(xiàn)示例,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2023-12-12
SpringBoot整合EasyExcel實現(xiàn)Excel表格導出功能
這篇文章主要介紹了SpringBoot整合EasyExcel實現(xiàn)Excel表格導出功能，文章圍繞主題展開詳細的內(nèi)容介紹，具有一定的參考價值，需要的朋友可以參考一下2022-07-07
這篇文章主要介紹了SpringBoot之如何指定配置文件啟動問題，具有很好的參考價值，希望對大家有所幫助。2023-04-04
本主要介紹了Java 集合去重的三種方法,包含HashSet,Stream API和手動遍歷并使用Map三種,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2024-07-07
這篇文章主要介紹了mybatis的dtd約束文件及配置文件xml自動提示操作，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-12-12
Java?Web應用小案例之實現(xiàn)用戶登錄功能全過程
在Java開發(fā)過程中實現(xiàn)用戶的注冊功能是最基本的,這篇文章主要給大家介紹了關于Java?Web應用小案例之實現(xiàn)用戶登錄功能的相關資料,文中通過圖文介紹的非常詳細,需要的朋友可以參考下2024-01-01
這篇文章主要介紹了MybatisPlus 自動填充的實現(xiàn)，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2020-09-09
下面小編就為大家?guī)硪黄猨ava二叉樹的幾道面試題詳解。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2021-07-07