自己動手寫的mybatis分頁插件(極其簡單好用)

剛開始項目，需要用到mybatis分頁，網上看了很多插件，其實實現原理基本都大同小異，但是大部分都只給了代碼，註釋不全，所以參考了很多篇文章（每篇文章偷一點代碼，評出來自己的，半抄襲），才自己模仿著寫出了一個適合自己項目的分頁插件，話不多說，直接上代碼，相比大部分文章，註釋算很完整了

最重要的攔截器

package com.dnkx.interceptor; import java.sql.*; import java.util.HashMap; import java.util.Properties; import org.apache.ibatis.executor.resultset.ResultSetHandler; import org.apache.ibatis.executor.statement.StatementHandler; import org.apache.ibatis.mapping.BoundSql; 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; import com.dnkx.pojo.Page; /** * * 分頁攔截器，用於攔截需要進行分頁查詢的操作，然後對其進行分頁處理。 * 利用攔截器實現Mybatis分頁的原理： * 要利用JDBC對數據庫進行操作就必須要有一個對應的Statement對象，Mybatis在執行Sql語句前就會產生一個包含Sql語句的Statement對象，而且對應的Sql語句* 是在Statement之前產生的，所以我們就可以在它生成Statement之前對用來生成Statement的Sql語句下手。在Mybatis中Statement語句是通過RoutingStatementHandler對象的* prepare方法生成的。所以利用攔截器實現Mybatis分頁的一個思路就是攔截StatementHandler接口的prepare方法，然後在攔截器方法中把Sql語句改成對應的分頁查詢Sql語句，之後再調用* StatementHandler對象的prepare方法，即調用invocation.proceed()。 * 對於分頁而言，在攔截器裡面我們還需要做的一個操作就是統計滿足當前條件的記錄一共有多少，這是通過獲取到了原始的Sql語句後，把它改為對應的統計語句再利用Mybatis封裝好的參數和設* 置參數的功能把Sql語句中的參數進行替換，之後再執行查詢記錄數的Sql語句進行總記錄數的統計。 * * 解釋一下插件中可能要用到的幾個類： * MetaObject：mybatis提供的一個基於返回獲取屬性值的對象的類* BoundSql : 在這個里面可以獲取都要執行的sql和執行sql要用到的參數* MappedStatement ： 這個可以得到當前執行的sql語句在xml文件中配置的id的值* RowBounds : 是mybatis內存分頁要用到的。 * ParameterHandler ： 是mybatis中用來替換sql中?出現的值的. * * @author 李小拐2016年11月9日10:59:04 */ @Intercepts({ @Signature(type=StatementHandler.class,method="prepare",args={Connection.class}), @Signature(type = ResultSetHandler.class, method = "handleResultSets", args = {Statement.class}) }) public class PageInterceptor implements Interceptor{ //攔截分頁關鍵字private static final String SELECT_ID="page"; //插件運行的代碼，它將代替原有的方法,要重寫最重要的intercept了@Override public Object intercept(Invocation invocation) throws Throwable { if (invocation.getTarget() instanceof StatementHandler) { //這裡我們有一個設定如果查詢方法含有Page 就進行分頁其他方法無視//所以就要獲取方法名StatementHandler statementHandler=(StatementHandler)invocation.getTarget(); MetaObject metaObject=SystemMetaObject.forObject(statementHandler); MappedStatement mappedStatement=(MappedStatement)metaObject.getValue("delegate.mappedStatement"); String selectId=mappedStatement.getId(); String methorName=selectId.substring(selectId.lastIndexOf(".")+1).toLowerCase(); //然後判斷下如果含有Page 就獲取sql if(methorName.contains(SELECT_ID)){ BoundSql boundSql=(BoundSql)metaObject.getValue("delegate.boundSql"); //分頁參數作為參數對象parameterObject的一個屬性String sql=boundSql.getSql(); System.out.println("獲取到的sql:"+sql); HashMap<String, Object> map=(HashMap<String, Object>)(boundSql.getParameterObject()); //Page page=(Page)(boundSql.getParameterObject()); Page page=(Page)map.get("page"); // 重寫sql String countSql=concatCountSql(sql); String pageSql=concatPageSql(sql,page); // System.out.println("重寫的count sql :"+countSql); System.out.println("重寫的select sql :"+pageSql); Connection connection = (Connection) invocation.getArgs()[0]; PreparedStatement countStmt = null; ResultSet rs = null; int totalCount = 0; try { countStmt = connection.prepareStatement(countSql); rs = countStmt.executeQuery(); if (rs.next()) { totalCount = rs.getInt(1); } } catch (SQLException e) { System.out.println("Ignore this exception"+e); } finally { try { rs.close(); countStmt.close(); } catch (SQLException e) { System.out.println("Ignore this exception"+ e); } } metaObject.setValue("delegate.boundSql.sql", pageSql); //綁定count page.setNumCount(totalCount); } } return invocation.proceed(); } // 攔截類型StatementHandler,重寫plugin方法@Override public Object plugin(Object target) { if (target instanceof StatementHandler) { return Plugin.wrap(target, this); }else { return target; } } @Override public void setProperties(Properties properties) { } //改造sql public String concatCountSql(String sql){ //StringBuffer sb=new StringBuffer("select count(*) from "); /*sql=sql.toLowerCase(); if(sql.lastIndexOf("order")>sql.lastIndexOf(")")){ sb.append(sql.substring(sql.indexOf("from")+4, sql.lastIndexOf("order"))); }else{ sb.append(sql.substring(sql.indexOf("from")+4)); }*/ StringBuffer sb=new StringBuffer(); sql=sql.toLowerCase(); if(sql.lastIndexOf("order")>0){ sql=sql.substring(0,sql.indexOf("order")); } sb.append("select count(*) from ("+sql+") tmp"); return sb.toString(); } public String concatPageSql(String sql,Page page){ StringBuffer sb=new StringBuffer(); sb.append(sql); sb.append(" limit ").append(page.getPageBegin()).append(" , ").append(page.getPageSize()); return sb.toString(); } } 分頁對象Page類[java] view plain copypackage com.dnkx.pojo; import java.util.HashMap; import java.util.Map; /** * * 分頁查詢輔助類* @author 李小拐2016年11月9日13:55:37 */ public class Page { //----------分頁----------- private int pageSize;//每頁顯示條數private int pageCurrentPage;//第幾頁private int pageBegin;//開始位置private int numCount;//總條數private int pageTotal;//總條數private String orderField = "";//控制排序頁面顯示的private String orderDirection = ""; public Page(){ } public Page(int pageSize, int pageCurrentPage) { super(); this.pageSize = pageSize; this.pageCurrentPage = pageCurrentPage; } public Page(Map<String, String> map){ if(map.get("pageNum")!=null){ this.setPageCurrentPage(this.pageCurrentPage = Integer.parseInt(map.get("pageNum")));//要查詢的頁數}else{ this.setPageCurrentPage(1);//設置初始值} if(map.get("numPerPage")!=null){ this.setPageSize(Integer.parseInt(map.get("numPerPage")));//每頁顯示條數}else{ this.setPageSize(5);//設置初始值} if(map.get("orderField")!=null){ this.setOrderField(map.get("orderField")); } if(map.get("orderDirection")!=null){ this.setOrderDirection(map.get("orderDirection")); } } public int getPageCurrentPage() { return pageCurrentPage; } public void setPageCurrentPage(int pageCurrentPage) { this.pageCurrentPage = pageCurrentPage; } public int getNumCount() { return numCount; } public void setNumCount(int numCount) { this.numCount = numCount; } public int getPageTotal() { return (numCount%pageSize>0)?(numCount/pageSize+1):(numCount/pageSize); } public void setPageTotal(int pageTotal) { this.pageTotal = pageTotal; } public int getPageSize() { return pageSize; } public void setPageSize(int pageSize) { this.pageSize = pageSize; } public int getPageBegin() { return pageSize*(pageCurrentPage-1); } public void setPageBegin(int pageBegin) { this.pageBegin = pageBegin; } public String getOrderField() { return orderField; } public void setOrderField(String orderField) { this.orderField = orderField; } public String getOrderDirection() { return orderDirection; } public void setOrderDirection(String orderDirection) { this.orderDirection = orderDirection; } public static Page getPage(int pageSize, int pageCurrentPage){ return new Page(pageSize,pageCurrentPage); } public static Page getPage(Map map){ return new Page(map); } }

Controller裡面調用方式

public String list(HttpServletRequest request) { long a=System.currentTimeMillis(); HashMap<String,Object> map=GetRequestMap.getMap(request);//自己封裝的方法，取request的參數Page page= Page.getPage(map);//初始化page map.put("page", page);//把page對象放入參數集合(這個map是mybatis要用到的，包含查詢條件，排序，分頁等) //控制排序頁面顯示的map.put(map.get("orderField")+"", map.get("orderDirection")); List<Employee> list=employeeService.getListPage(map); request.setAttribute("emlist", list); request.setAttribute("page", page); request.setAttribute("map", map); //取page相關屬性page.getNumCount();//總條數page.getPageTotal();//總頁數long b=System.currentTimeMillis(); System.out.println("---------耗時:"+(ba)+"ms"); return "basic/employee_list"; }

最後，spring裡面配置插件

<bean id="PageInterector"></bean> <!-- spring和MyBatis完美整合，不需要mybatis的配置映射文件--> <bean id="sqlSessionFactory"> <property name="dataSource" ref="dataSource" /> <!-- 自動掃描mapping.xml文件--> <property name="mapperLocations" value="classpath:com/dnkx/mapping/*.xml"></property> <property name="plugins"> <ref bean="PageInterector"/> </property> </bean>

好了，到此結束，本文僅供參考！也期待大神提意見