Mybatis 分頁插件實現(xiàn)
有數(shù)據(jù)的地方就有分頁，分頁的sql基本大加都會寫，MySQL可以用limit,Oracle可以用ronum，sql server可以用top。這些基本大家都會用，但是一個程序中需要用到分頁的地方無疑是很多的，每個地方都作這樣的處理則顯示的很繁瑣，存在大量的重復(fù)工作，如果能統(tǒng)一無疑會方便很多。
對mybatis插件開發(fā)感興趣的同學(xué)，可以參考mybatis官方文檔。
現(xiàn)在話不多說，直接上干貨。
分頁需要哪些屬性呢
當(dāng)前頁pageNo
每頁條數(shù)pageSize
總條數(shù)totalCount
第一個和第二個屬性基本所有分頁都需要的，總條數(shù)呢？可能大多地方也是需要的，因為大多場景需要計算所有數(shù)據(jù)一共可以分多少頁；但也有一些地方不需要的，比如說我在首頁只需要展示我最近五條動態(tài)。
所以我在這里加了個屬性needTotalCount，可能有些同學(xué)會認(rèn)為直接都查出來，不需要不用就ok了，但是考慮到查詢總條數(shù)需要執(zhí)行額外的sql，帶來性能的損耗，所以這個屬性了加上去了。
針對分頁查詢，這里我建立了一個分頁的基類 ,get與set方法太占版面，所以沒貼
```packagecom.lsf.twnb.dao.base;
importjava.io.Serializable;
importjava.util.Collections;
importjava.util.List;
/**
* Base class for query
*/
publicclassPageQueryimplementsSerializable {
publicstaticfinalintDEFAULT_PAGE_SIZE=10;
publicstaticfinalintDEFAULT_PAGE_NO=1;
/**
* 是否分頁,默認(rèn)不分頁
*/
booleanisPage=false;
/**
* 每頁條數(shù)
*/
intpageSize=DEFAULT_PAGE_SIZE;
/**
* 當(dāng)前頁數(shù)數(shù)
*/
intpageNo=DEFAULT_PAGE_NO;
/**
* 數(shù)據(jù)集
*/
Listitems;
/**
* 是否需要總條數(shù)，查詢總條數(shù)會額外增加一次查詢
*/
booleanisNeedTotalCount=false;
/**
* 總條數(shù)
*/
inttotalCount=0;
publicbooleanisPage() {
returnisPage;
}
publicvoidsetPage(booleanpage) {
isPage=page;
}
publicintgetPageSize() {
returnpageSize;
}
publicvoidsetPageSize(intpageSize) {
this.pageSize=pageSize;
}
publicintgetPageNo() {
returnpageNo;
}
publicvoidsetPageNo(intpageNo) {
this.pageNo=pageNo;
}
publicListgetItems() {
returnitems;
}
publicvoidsetItems(Listitems) {
this.items=items;
}
publicbooleanisNeedTotalCount() {
returnisNeedTotalCount;
}
publicvoidsetNeedTotalCount(booleanneedTotalCount) {
isNeedTotalCount=needTotalCount;
}
publicintgetTotalCount() {
returntotalCount;
}
publicvoidsetTotalCount(inttotalCount) {
this.totalCount=totalCount;
}
publicintgetOffset() {
return(pageNo-1)*pageSize;
}
}```
大家可以注意到這里多了一個items屬性和getOffest方法，items就是你需要的數(shù)據(jù)列表，offset是根據(jù)當(dāng)前頁數(shù)計算當(dāng)前偏移量。
這是查詢分頁的基類，也是查詢分頁需要的條件，所有分頁查詢條件繼承此基類。
這里我們以查詢用戶為例（get和set方法同樣省略）:
/*** Condition for UserPageQuery Query*/publicclassUserPageQueryextendsPageQuery{privateStringusername;}
我們這里增加了一個條件用戶名username，那我們只需要關(guān)注這個用戶名即可，
Dao層方法：
ListqueryUser(UserPageQueryuserQuery);
Mapper配置：
selectfrom User u where username=#{username}
接下來就是考慮怎樣寫插件了，mybatis的Plugin需要繼承Interceptor接口，接口如下
publicinterfaceInterceptor {Objectintercept(Invocationinvocation)throwsThrowable;Objectplugin(Objecttarget);voidsetProperties(Propertiesproperties);}
接口共有三個方法，我們先看第二個方法plugin, plugin方法就是把你實現(xiàn)這個接口的類加入插件，寫法基本固定
@OverridepublicObjectplugin(Objecttarget) {returnPlugin.wrap(target,this);}
我們看wrap方法的源碼基本可以發(fā)現(xiàn)，就是就是將攔截的方法通過動態(tài)代理的方式由第一個方法plugin執(zhí)行。
再看第三個方法setPrpperties()，顧明思義，即設(shè)置屬性,我們要使插件起作用，需要在mybatis配置文件中配置，配置如下
這里增加的property即可以在setProperties的參數(shù)中取到。
最后我們來說核心的intercept方法，前面我們說過plugin方法是將指定的方法動態(tài)代理，那具體要攔截什么方法了，我們增加分頁，無非是對sql作一下調(diào)整，所以有很多地方可以攔截，這里我們對Executor的query方法進(jìn)行攔截，配置注解如下
@Intercepts({@Signature(type=Executor.class,method="query",args={MappedStatement.class,Object.class,RowBounds.class,ResultHandler.class})})
intercept方法如下
@OverridepublicObjectintercept(Invocationinvocation)throwsThrowable{//若查詢參數(shù)不為分頁參數(shù)，不作處理，按原計劃執(zhí)行if(!(invocation.getArgs()[1]instanceofPageQuery)) {returninvocation.proceed();}MappedStatementms=(MappedStatement)invocation.getArgs()[0];ListtextSqlNodes=(List)SystemMetaObject.forObject(ms).getValue("sqlSource.rootSqlNode.contents");if(textSqlNodes.lastIndexOf(mysqlPageNode)!=textSqlNodes.size()-1) {textSqlNodes.add(mysqlPageNode);}PageQuerypageQuery=(PageQuery)invocation.getArgs()[1];BoundSqlboundSql=ms.getBoundSql(pageQuery);//條件未繼承分頁查詢類PageQuery的sql按原有邏輯處理if(!(boundSql.getParameterObject()instanceofPageQuery)) {returninvocation.proceed();}? ? Executorexecutor=(Executor)invocation.getTarget();Connectionconnection=executor.getTransaction().getConnection();//查詢總條數(shù)會額外執(zhí)行一條sql，影響性能if(pageQuery.isNeedTotalCount()) {//查詢總條數(shù)inttotalCount=getPageQueryCount(connection,ms,boundSql,pageQuery);pageQuery.setTotalCount(totalCount);if(totalCount==0){returnCollections.EMPTY_LIST;}? ? }returninvocation.proceed();}
我們攔截的是
Listquery(MappedStatementms,Objectparameter,RowBoundsrowBounds,ResultHandlerresultHandler)
第二個參數(shù)即查詢的參數(shù)，分頁時即繼承了PageQuery的類，若未繼承，則按原有邏輯處理；
mybatis會將一條sql劃分為許多塊，而textSqlNodes為這些塊的集合，
比如
selectfrom User u where username=#{username}
就被劃分成了
select
id,username
from User
where username=#{username}
四塊，而我們要做分頁，只需要在這個集合里面加入分頁數(shù)據(jù)即可
textSqlNodes.add(mysqlPageNode);
聲明如下
privatefinalTextSqlNodemysqlPageNode=newTextSqlNode(" limit #{offset},#{pageSize} ");
，如果是oracle，則在前后加上rownum的塊。
這里的pageSize和offset我們的rownum里面都有了的。
注意這個判斷
if(textSqlNodes.lastIndexOf(mysqlPageNode)!=textSqlNodes.size()-1)
只有第一次查詢分頁的方法時需要加，因為這個已經(jīng)寫進(jìn)內(nèi)存了，所以第二次調(diào)用時就不用加了，最后，如果你不需要總條數(shù)，可以直接
returninvocation.proceed();
執(zhí)行被代理的方法，game over。
如果需要總條數(shù)，則繼續(xù)往下看，調(diào)用方法getPageQueryCount查詢總條數(shù)
privateintgetPageQueryCount(Connectionconnection,MappedStatementms,BoundSqlboundSql,PageQuerypageQuery)throwsThrowable{//獲取綁定sqlStringsql=boundSql.getSql();//數(shù)據(jù)庫連接//查詢數(shù)據(jù)總條數(shù)PreparedStatementcountQuery=connection.prepareStatement(dialect.generateCountSql(sql));//記錄當(dāng)前頁數(shù)和每頁條數(shù)（查詢總條數(shù)時offset和limit要去掉）intpageSize=pageQuery.getPageSize();intpageNo=pageQuery.getPageNo();pageQuery.setPageNo(PageQuery.DEFAULT_PAGE_NO);pageQuery.setPageSize(RowBounds.NO_ROW_LIMIT);ParameterHandlerparameterHandler=newDefaultParameterHandler(ms,pageQuery,boundSql);parameterHandler.setParameters(countQuery);ResultSetrs=countQuery.executeQuery();inttotalCount=0;try{if(rs.next()) {? ? ? ? ? ? totalCount=rs.getInt(1);}? ? }finally{rs.close();countQuery.close();pageQuery.setPageNo(pageNo);pageQuery.setPageSize(pageSize);}returntotalCount;}
這里用PreparedStatemetn執(zhí)行預(yù)處理查詢總條數(shù)，這里需要注意的是因為前面我們已經(jīng)加入了分頁條件，所以這里把分頁條件的值設(shè)置為最大。如果數(shù)據(jù)集為空，則直接返回空集合。
