Mybatis分頁插件PageHelper手寫實現(xiàn)示例
更新時間：2022年08月15日 10:12:06 作者：我是小趴菜
這篇文章主要為大家介紹了Mybatis分頁插件PageHelper手寫實現(xiàn)示例，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪
引言
PageHelper是一個非常好用的插件，以至于很想知道它底層是怎么實現(xiàn)的。至于MyBatis插件概念原理網(wǎng)上有很多，我不太喜歡去寫一些概念性的東西，我比較喜歡自己動手實現(xiàn)的那種，話不多說，我們開干
搭建一個SpringBoot+MyBatis+MySql項目
編寫我們的插件類
package com.example.demo.plugin;
import org.apache.ibatis.cache.CacheKey;
import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.session.ResultHandler;
import org.apache.ibatis.session.RowBounds;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;
@Intercepts(
{
@Signature(type = Executor.class,
method = "query",
args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}),
@Signature(type = Executor.class,
method = "query",
args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class,
CacheKey.class, BoundSql.class}),
}
)
public class MyPagePlugin implements Interceptor {
@Override
public Object intercept(Invocation invocation) throws Throwable {
Object[] args = invocation.getArgs();
MappedStatement ms = (MappedStatement) args[0];
Object parameter = args[1];
RowBounds rowBounds = (RowBounds) args[2];
ResultHandler resultHandler = (ResultHandler) args[3];
Executor executor = (Executor) invocation.getTarget();
CacheKey cacheKey;
BoundSql boundSql;
//由于邏輯關系，只會進入一次
if (args.length == 4) {
//4 個參數(shù)時
boundSql = ms.getBoundSql(parameter);
cacheKey = executor.createCacheKey(ms, parameter, rowBounds, boundSql);
} else {
//6 個參數(shù)時
cacheKey = (CacheKey) args[4];
boundSql = (BoundSql) args[5];
}
== 其實在這之上的代碼都是拷貝PageHelper源碼來的，下面才是重頭戲，上面都是獲取一些必要的參數(shù)==
/**
* 下面4行代碼暫時只需要知道是用來傳參數(shù)的就行，分頁不是需要
* 二個參數(shù)嘛 一個是當前頁，一個是數(shù)量
*/
Page page = ThreadLocalUtil.getPage();
Map<String,Object> params = new HashMap<>();
params.put("first_key",page.getPageNum());
params.put("second_key",page.getPageSize());
/**
* 重點：獲取數(shù)據(jù)庫記錄總數(shù)
*/
//統(tǒng)計總數(shù)
Long count = MyExecutorUtil.executeAutoCount(executor,ms,parameter,boundSql,rowBounds,resultHandler);
/**
* 重點：分頁查詢
*/
List<Object> objects = MyExecutorUtil.pageQuery(executor, ms, parameter, rowBounds, resultHandler, boundSql, cacheKey, params);
return objects;
}
@Override
public Object plugin(Object target) {
return Plugin.wrap(target, this);
}
@Override
public void setProperties(Properties properties) {
}
}
上面有二個核心方法
1：獲取記錄總數(shù)：
MyExecutorUtil.executeAutoCount(executor,ms,parameter,boundSql,rowBounds,resultHandler);
2：分頁查詢：
MyExecutorUtil.pageQuery(executor, ms, parameter, rowBounds, resultHandler, boundSql, cacheKey,params);
獲取記錄總數(shù)
1：MyBatis源碼底層會封裝好我們在配置文件中寫的每一條SQL語句，封裝到一個SqlSource對象中去，在我們執(zhí)行SQL的時候，會獲取到這條SQL，然后封裝到BoundSql這個對象中，所以在這里，我們既然能拿到BoundSql,那么也就意味著我們能拿到我們需要執(zhí)行的那條Sql了
2：獲取到了我們的sql之后，怎么查詢總記錄數(shù)呢？？
其實很簡單，改Sql語句不就好了，Pagehelper底層也是這么做的，但是PageHelper底層比我這個版本的復雜太多了，但是我們無非就是將原先的SQL轉換成 -> SELECT COUNT(0) FROM TABLE,就這樣，但是我這個人比較懶，而且昨天看這個源碼實現(xiàn)頭疼，所以在這里直接寫死了，但是問題不大哈
3：改好了Sql之后是不是就完成了呢？？
當然不是，改好了SQL當然是要去執(zhí)行它了，如果就這樣執(zhí)行，還是會執(zhí)行原先的SQL，但是你要知道這個有個很關鍵的東西，就是MappedStatement的id，如果不改這個id的話，即使你的Sql能夠執(zhí)行成功，那么返回的記錄總數(shù)是個NULL，這里我想可能是因為ResultSetHandle的關系，因為這個id對應的還是我們之前的sql，也就是select * from student,那么必然有一個resultType的屬性，也就是實體類映射，但是我們現(xiàn)在的sql是select count(0) from student,那么就對應不上了，也就是數(shù)據(jù)庫查詢出來的列與實體類對應不上，所以我們需要改變這個id。
//改變MapperStatement id的方法
public static MappedStatement newCountMappedStatement(MappedStatement ms, String newMsId) {
MappedStatement.Builder builder = new MappedStatement.Builder(ms.getConfiguration(), newMsId, ms.getSqlSource(), ms.getSqlCommandType());
builder.resource(ms.getResource());
builder.fetchSize(ms.getFetchSize());
builder.statementType(ms.getStatementType());
builder.keyGenerator(ms.getKeyGenerator());
if (ms.getKeyProperties() != null && ms.getKeyProperties().length != 0) {
StringBuilder keyProperties = new StringBuilder();
for (String keyProperty : ms.getKeyProperties()) {
keyProperties.append(keyProperty).append(",");
}
keyProperties.delete(keyProperties.length() - 1, keyProperties.length());
builder.keyProperty(keyProperties.toString());
}
builder.timeout(ms.getTimeout());
builder.parameterMap(ms.getParameterMap());
//count查詢返回值int
List<ResultMap> resultMaps = new ArrayList<ResultMap>();
ResultMap resultMap = new ResultMap.Builder(ms.getConfiguration(), ms.getId(), Long.class, EMPTY_RESULTMAPPING).build();
resultMaps.add(resultMap);
builder.resultMaps(resultMaps);
builder.resultSetType(ms.getResultSetType());
builder.cache(ms.getCache());
builder.flushCacheRequired(ms.isFlushCacheRequired());
builder.useCache(ms.isUseCache());
return builder.build();
}
4：MyBatis的Sql是封裝到BoundSql中去的，而原先的BoundSql中的Sql是我們配置文件中的，所以我們需要將select count(0) from student這條Sql語句封裝到一個新的BoundSql中去
public static Long executeAutoCount(Executor executor, MappedStatement countMs,
Object parameter, BoundSql boundSql,
RowBounds rowBounds, ResultHandler resultHandler) throws SQLException {
//改變MapperStatement中的ID屬性
String countMsId = countMs.getId() + "_COUNT";
countMs = newCountMappedStatement(countMs,countMsId);
//創(chuàng)建 count 查詢的緩存 key
CacheKey countKey = executor.createCacheKey(countMs, parameter, RowBounds.DEFAULT, boundSql);
//調(diào)用獲取count的sql
String countSql = "select count(0) from student";
//重新封裝BoundSql對象
BoundSql countBoundSql = new BoundSql(countMs.getConfiguration(), countSql, boundSql.getParameterMappings(), parameter);
//執(zhí)行 count 查詢
List<Long> countResultList = executor.query(countMs, parameter, RowBounds.DEFAULT, resultHandler, countKey, countBoundSql);
Long count = countResultList.get(0);
return count;
}
5：最后調(diào)用executor.query方法就可以得到我們的記錄總數(shù)了
分頁查詢記錄數(shù)
- 1：其實分頁查詢與查詢記錄總數(shù)的原理是一樣的
- 2：首先獲取原先的BoundSql中的Sql，也就是我們在配置文件中的Sql，比如 select * from student
- 3：然后獲取我們的分頁參數(shù)，也就是前端傳遞過來的pageNum和pageSize二個參數(shù)
- 4：修改Sql，select * from student limit ?,?
- 5：這次我們就不用修改MapperStatement中的ID了，因為查詢出來的都是studnet，所以映射不用修改
- 6：重新實例化一個BoundSql對象，將新的Sql傳遞給它
- 7：最后執(zhí)行executor.query方法查詢，得到結果
如何獲取前端傳遞過來的參數(shù)？
1：我這里使用的是ThreadLocal，
總結
- 1：首選我們需要獲取到原先需要執(zhí)行的sql
- 2：然后修改這條修改，分頁查詢無非就是總記錄數(shù)，分頁查詢的記錄數(shù)
- 3：分別執(zhí)行這二條Sql，得到我們想要的結果
源碼：
就下面這5個類,其它的就是將SpringBoot+MyBatis+MySql日常配置就行了，然后再Controller記得傳遞一下參數(shù)
package com.example.demo.plugin;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
@MapperScan({"com.example.demo.mapper"})
public class MapperConfig {
@Bean
public MyPagePlugin myPagePlugin() {
return new MyPagePlugin();
}
}
package com.example.demo.plugin;
import com.example.demo.entity.Student;
import org.apache.ibatis.cache.CacheKey;
import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.*;
import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.session.ResultHandler;
import org.apache.ibatis.session.RowBounds;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
public class MyExecutorUtil {
private static final List<ResultMapping> EMPTY_RESULTMAPPING = new ArrayList<ResultMapping>(0);
public static <E> List<E> pageQuery(Executor executor, MappedStatement ms, Object parameter,
RowBounds rowBounds, ResultHandler resultHandler,
BoundSql boundSql, CacheKey cacheKey,Map<String,Object> params) throws SQLException {
executor.clearLocalCache();
//生成分頁的緩存 key
CacheKey pageKey = cacheKey;
//處理參數(shù)對象
if(params.size() < 0 || params.size() > 2) {
System.out.println("參數(shù)錯誤");
}
//獲取sql
String pageSql = getPageSql(params.size(),boundSql);
List<ParameterMapping> mappingList = new ArrayList<>();
mappingList.add(new ParameterMapping.Builder(ms.getConfiguration(), "first_key", Integer.class).build());
mappingList.add(new ParameterMapping.Builder(ms.getConfiguration(), "second_key", Integer.class).build());
//實例化新的BoundSql對象
BoundSql pageBoundSql = new BoundSql(ms.getConfiguration(), pageSql, mappingList, params);
//執(zhí)行分頁查詢
return executor.query(ms, params, RowBounds.DEFAULT, resultHandler, pageKey, pageBoundSql);
}
public static Long executeAutoCount(Executor executor, MappedStatement countMs,
Object parameter, BoundSql boundSql,
RowBounds rowBounds, ResultHandler resultHandler) throws SQLException {
//改變MapperStatement中的ID屬性
String countMsId = countMs.getId() + "_COUNT";
countMs = newCountMappedStatement(countMs,countMsId);
//創(chuàng)建 count 查詢的緩存 key
CacheKey countKey = executor.createCacheKey(countMs, parameter, RowBounds.DEFAULT, boundSql);
//調(diào)用獲取count的sql
String countSql = "select count(0) from student";
//重新封裝BoundSql對象
BoundSql countBoundSql = new BoundSql(countMs.getConfiguration(), countSql, boundSql.getParameterMappings(), parameter);
//執(zhí)行 count 查詢
List<Long> countResultList = executor.query(countMs, parameter, RowBounds.DEFAULT, resultHandler, countKey, countBoundSql);
Long count = countResultList.get(0);
return count;
}
public static MappedStatement newCountMappedStatement(MappedStatement ms, String newMsId) {
MappedStatement.Builder builder = new MappedStatement.Builder(ms.getConfiguration(), newMsId, ms.getSqlSource(), ms.getSqlCommandType());
builder.resource(ms.getResource());
builder.fetchSize(ms.getFetchSize());
builder.statementType(ms.getStatementType());
builder.keyGenerator(ms.getKeyGenerator());
if (ms.getKeyProperties() != null && ms.getKeyProperties().length != 0) {
StringBuilder keyProperties = new StringBuilder();
for (String keyProperty : ms.getKeyProperties()) {
keyProperties.append(keyProperty).append(",");
}
keyProperties.delete(keyProperties.length() - 1, keyProperties.length());
builder.keyProperty(keyProperties.toString());
}
builder.timeout(ms.getTimeout());
builder.parameterMap(ms.getParameterMap());
//count查詢返回值int
List<ResultMap> resultMaps = new ArrayList<ResultMap>();
ResultMap resultMap = new ResultMap.Builder(ms.getConfiguration(), ms.getId(), Long.class, EMPTY_RESULTMAPPING).build();
resultMaps.add(resultMap);
builder.resultMaps(resultMaps);
builder.resultSetType(ms.getResultSetType());
builder.cache(ms.getCache());
builder.flushCacheRequired(ms.isFlushCacheRequired());
builder.useCache(ms.isUseCache());
return builder.build();
}
private static String getPageSql(int paramsLength,BoundSql boundSql){
StringBuilder str = new StringBuilder();
str.append(boundSql.getSql());
if(paramsLength == 1) {
str.append(" LIMIT ?");
}else {
str.append(" LIMIT ?,? ");
}
return str.toString();
}
}
package com.example.demo.plugin;
import org.apache.ibatis.cache.CacheKey;
import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.session.ResultHandler;
import org.apache.ibatis.session.RowBounds;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;
@Intercepts(
{
@Signature(type = Executor.class,
method = "query",
args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}),
@Signature(type = Executor.class,
method = "query",
args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class,
CacheKey.class, BoundSql.class}),
}
)
public class MyPagePlugin implements Interceptor {
@Override
public Object intercept(Invocation invocation) throws Throwable {
Object[] args = invocation.getArgs();
MappedStatement ms = (MappedStatement) args[0];
Object parameter = args[1];
RowBounds rowBounds = (RowBounds) args[2];
ResultHandler resultHandler = (ResultHandler) args[3];
Executor executor = (Executor) invocation.getTarget();
CacheKey cacheKey;
BoundSql boundSql;
//由于邏輯關系，只會進入一次
if (args.length == 4) {
//4 個參數(shù)時
boundSql = ms.getBoundSql(parameter);
cacheKey = executor.createCacheKey(ms, parameter, rowBounds, boundSql);
} else {
//6 個參數(shù)時
cacheKey = (CacheKey) args[4];
boundSql = (BoundSql) args[5];
}
Page page = ThreadLocalUtil.getPage();
Map<String,Object> params = new HashMap<>();
params.put("first_key",page.getPageNum());
params.put("second_key",page.getPageSize());
//統(tǒng)計總數(shù)
Long count = MyExecutorUtil.executeAutoCount(executor,ms,parameter,boundSql,rowBounds,resultHandler);
System.out.println("count = " + count);
List<Object> objects = MyExecutorUtil.pageQuery(executor, ms, parameter, rowBounds, resultHandler, boundSql, cacheKey, params);
return objects;
}
@Override
public Object plugin(Object target) {
return Plugin.wrap(target, this);
}
@Override
public void setProperties(Properties properties) {
}
}
package com.example.demo.plugin;
public class Page {
private Integer pageNum;
private Integer pageSize;
public Integer getPageNum() {
return pageNum;
}
public void setPageNum(Integer pageNum) {
this.pageNum = pageNum;
}
public Integer getPageSize() {
return pageSize;
}
public void setPageSize(Integer pageSize) {
this.pageSize = pageSize;
}
}
package com.example.demo.plugin;
public class ThreadLocalUtil {
public static ThreadLocal<Page> PAGE_INFO = new ThreadLocal<>();
public static void startPage(int pageNum,int pageSize) {
Page page = new Page();
page.setPageNum(pageNum);
page.setPageSize(pageSize);
PAGE_INFO.set(page);
}
public static Page getPage() {
return PAGE_INFO.get();
}
}
@RestController
public class StudnetController {
@Autowired
private StudentMapper studentMapper;
@GetMapping("/getData")
public Object getData() {
ThreadLocalUtil.startPage(0,2);
return studentMapper.getData();
}
}以上就是Mybatis分頁插件PageHelper手寫實現(xiàn)示例的詳細內(nèi)容，更多關于Mybatis分頁插件PageHelper的資料請關注腳本之家其它相關文章！
相關文章
這篇文章主要介紹了Java dbcp連接池基本使用方法詳解,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-10-10
這篇文章主要介紹了spring security CSRF防護的示例代碼,小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2019-03-03
Elasticsearch查詢之Term?Query示例解析
這篇文章主要為大家介紹了Elasticsearch查詢之Term?Query示例解析，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2023-04-04
下面小編就為大家?guī)硪黄狫ava基礎教程_判斷語句if else。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2016-06-06
這篇文章主要介紹了java 多線程交通信號燈模擬過程詳解,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2019-07-07
大家好，本篇文章主要講的是java中生產(chǎn)者消費者問題和代碼案例，感興趣的同學趕快來看一看吧，對你有幫助的話記得收藏一下2022-02-02
以Spring Boot的方式顯示圖片或下載文件到瀏覽器的示例代碼
這篇文章主要介紹了以Spring Boot的方式顯示圖片或下載文件到瀏覽器的示例代碼,本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2021-01-01
這篇文章主要介紹了Java注解詳細介紹,本文講解了Java注解是什么、Java注解基礎知識、Java注解類型、定義Java注解類型的注意事項等內(nèi)容,需要的朋友可以參考下2014-09-09
這篇文章主要介紹了java 獲取服務器真實IP的實例的相關資料,這里提供實現(xiàn)方法幫助大家學習理解這部分內(nèi)容，需要的朋友可以參考下2017-08-08
SpringBoot動態(tài)定時任務實現(xiàn)完整版
最近有幸要開發(fā)個動態(tài)定時任務,這里簡單再梳理一下,下面這篇文章主要給大家介紹了關于SpringBoot動態(tài)定時任務實現(xiàn)的相關資料,文中通過實例代碼介紹的非常詳細,需要的朋友可以參考下2023-02-02