分享一個完整的Mybatis分頁解決方案

時間  2019-11-30
標籤 分享 一個 完整 mybatis 分頁 解決 方案 欄目 MyBatis 简体版
原文   原文鏈接

分享一個完整的Mybatis分頁解決方案

博客分類：
 

Mybatis 的物理分頁是應用中的一個難點，特別是配合檢索和排序功能疊加時更是如此。javascript

我在最近的項目中開發了這個通用分頁器，過程當中參考了站內很多好文章，新年第一天，特此發文回饋網站。前端

特別鳴謝 paginator項目 （https://github.com/miemiedev/mybatis-paginator ） ，閱讀源碼幫助很大。java

 

【背景】mysql

項目框架是 SpringMVC+Mybatis, 需求是想採用自定義的分頁標籤，同時，要儘可能少的影響業務程序開發的。
若是你已經使用了JS框架（ 如：Ext，EasyUi等）自帶的分頁機能，是屬於前端分頁，不在本文討論範圍。git

 

【關於問題】github

大多數分頁器會使用在查詢頁面，要考慮如下問題：算法

1）分頁時是要隨時帶有最近一次查詢條件spring

2）不能影響現有的sql，相似aop的效果sql

3）mybatis提供了通用的攔截接口，要選擇適當的攔截方式和時點數據庫

4）儘可能少的影響現有service等接口

 

【關於依賴庫】

Google Guava    做爲基礎工具包

Commons JXPath  用於對象查詢  （1/23日版改善後，再也不須要）

Jackson  向前臺傳送Json格式數據轉換用

 

【關於適用數據庫】 

如今只適用mysql 

（若是須要用在其餘數據庫可參考 paginator的Dialect部分，改動都不大）

 

首先是Page類，比較簡單，保存分頁相關的全部信息，涉及到分頁算法。雖然「其貌不揚」，但很重要。後面會看到這個page類對象會以「信使」的身份出如今所有與分頁相關的地方。

Java代碼   收藏代碼
  1. /** 
  2.  * 封裝分頁數據 
  3.  */  
  4. import java.util.List;  
  5. import java.util.Map;  
  6.   
  7. import org.codehaus.jackson.map.ObjectMapper;  
  8. import org.slf4j.Logger;  
  9. import org.slf4j.LoggerFactory;  
  10.   
  11. import com.google.common.base.Joiner;  
  12. import com.google.common.collect.Lists;  
  13. import com.google.common.collect.Maps;  
  14.   
  15. public class Page {  
  16.   
  17.   private static final Logger logger = LoggerFactory.getLogger(Page.class);  
  18.   private static ObjectMapper mapper = new ObjectMapper();  
  19.   
  20.   public static String DEFAULT_PAGESIZE = "10";  
  21.   private int pageNo;          //當前頁碼  
  22.   private int pageSize;        //每頁行數  
  23.   private int totalRecord;      //總記錄數  
  24.   private int totalPage;        //總頁數  
  25.   private Map<String, String> params;  //查詢條件  
  26.   private Map<String, List<String>> paramLists;  //數組查詢條件  
  27.   private String searchUrl;      //Url地址  
  28.   private String pageNoDisp;       //能夠顯示的頁號(分隔符"|"，總頁數變動時更新)  
  29.   
  30.   private Page() {  
  31.     pageNo = 1;  
  32.     pageSize = Integer.valueOf(DEFAULT_PAGESIZE);  
  33.     totalRecord = 0;  
  34.     totalPage = 0;  
  35.     params = Maps.newHashMap();  
  36.     paramLists = Maps.newHashMap();  
  37.     searchUrl = "";  
  38.     pageNoDisp = "";  
  39.   }  
  40.      
  41.   public static Page newBuilder(int pageNo, int pageSize, String url){  
  42.     Page page = new Page();  
  43.     page.setPageNo(pageNo);  
  44.     page.setPageSize(pageSize);  
  45.     page.setSearchUrl(url);  
  46.     return page;  
  47.   }  
  48.     
  49.   /** 
  50.    * 查詢條件轉JSON 
  51.    */  
  52.   public String getParaJson(){  
  53.     Map<String, Object> map = Maps.newHashMap();  
  54.     for (String key : params.keySet()){  
  55.       if ( params.get(key) != null  ){  
  56.         map.put(key, params.get(key));  
  57.       }  
  58.     }  
  59.     String json="";  
  60.     try {  
  61.       json = mapper.writeValueAsString(map);  
  62.     } catch (Exception e) {  
  63.       logger.error("轉換JSON失敗", params, e);  
  64.     }  
  65.     return json;  
  66.   }  
  67.   
  68.   /** 
  69.    * 數組查詢條件轉JSON 
  70.    */  
  71.   public String getParaListJson(){  
  72.     Map<String, Object> map = Maps.newHashMap();  
  73.     for (String key : paramLists.keySet()){  
  74.       List<String> lists = paramLists.get(key);  
  75.       if ( lists != null && lists.size()>0 ){  
  76.         map.put(key, lists);  
  77.       }  
  78.     }  
  79.     String json="";  
  80.     try {  
  81.       json = mapper.writeValueAsString(map);  
  82.     } catch (Exception e) {  
  83.       logger.error("轉換JSON失敗", params, e);  
  84.     }  
  85.     return json;  
  86.   }  
  87.   
  88.   /** 
  89.    * 總件數變化時，更新總頁數並計算顯示樣式 
  90.    */  
  91.   private void refreshPage(){  
  92.     //總頁數計算  
  93.     totalPage = totalRecord%pageSize==0 ? totalRecord/pageSize : (totalRecord/pageSize + 1);  
  94.     //防止超出最末頁（瀏覽途中數據被刪除的狀況）  
  95.     if ( pageNo > totalPage && totalPage!=0){  
  96.         pageNo = totalPage;  
  97.     }  
  98.     pageNoDisp = computeDisplayStyleAndPage();  
  99.   }  
  100.     
  101.   /** 
  102.    * 計算頁號顯示樣式 
  103.    *  這裏實現如下的分頁樣式("[]"表明當前頁號)，可根據項目需求調整 
  104.    *   [1],2,3,4,5,6,7,8..12,13 
  105.    *   1,2..5,6,[7],8,9..12,13 
  106.    *   1,2..6,7,8,9,10,11,12,[13] 
  107.    */  
  108.   private String computeDisplayStyleAndPage(){  
  109.     List<Integer> pageDisplays = Lists.newArrayList();  
  110.     if ( totalPage <= 11 ){  
  111.       for (int i=1; i<=totalPage; i++){  
  112.         pageDisplays.add(i);  
  113.       }  
  114.     }else if ( pageNo < 7 ){  
  115.       for (int i=1; i<=8; i++){  
  116.         pageDisplays.add(i);  
  117.       }  
  118.       pageDisplays.add(0);// 0 表示 省略部分(下同)  
  119.       pageDisplays.add(totalPage-1);         
  120.       pageDisplays.add(totalPage);  
  121.     }else if ( pageNo> totalPage-6 ){  
  122.       pageDisplays.add(1);  
  123.       pageDisplays.add(2);  
  124.       pageDisplays.add(0);  
  125.       for (int i=totalPage-7; i<=totalPage; i++){  
  126.         pageDisplays.add(i);  
  127.       }         
  128.     }else{  
  129.       pageDisplays.add(1);  
  130.       pageDisplays.add(2);  
  131.       pageDisplays.add(0);  
  132.       for (int i=pageNo-2; i<=pageNo+2; i++){  
  133.         pageDisplays.add(i);  
  134.       }  
  135.       pageDisplays.add(0);  
  136.       pageDisplays.add(totalPage-1);  
  137.       pageDisplays.add(totalPage);  
  138.     }  
  139.     return Joiner.on("|").join(pageDisplays.toArray());  
  140.   }  
  141.    
  142.   public int getPageNo() {  
  143.      return pageNo;  
  144.   }  
  145.    
  146.   public void setPageNo(int pageNo) {  
  147.      this.pageNo = pageNo;  
  148.   }  
  149.    
  150.   public int getPageSize() {  
  151.      return pageSize;  
  152.   }  
  153.    
  154.   public void setPageSize(int pageSize) {  
  155.      this.pageSize = pageSize;  
  156.   }  
  157.    
  158.   public int getTotalRecord() {  
  159.      return totalRecord;  
  160.   }  
  161.    
  162.   public void setTotalRecord(int totalRecord) {  
  163.     this.totalRecord = totalRecord;  
  164.     refreshPage();       
  165.   }  
  166.   
  167.   public int getTotalPage() {  
  168.      return totalPage;  
  169.   }  
  170.    
  171.   public void setTotalPage(int totalPage) {  
  172.      this.totalPage = totalPage;  
  173.   }  
  174.    
  175.   public Map<String, String> getParams() {  
  176.      return params;  
  177.   }  
  178.      
  179.   public void setParams(Map<String, String> params) {  
  180.      this.params = params;  
  181.   }  
  182.     
  183.   public Map<String, List<String>> getParamLists() {  
  184.     return paramLists;  
  185.   }  
  186.   
  187.   public void setParamLists(Map<String, List<String>> paramLists) {  
  188.     this.paramLists = paramLists;  
  189.   }  
  190.   public String getSearchUrl() {  
  191.     return searchUrl;  
  192.   }  
  193.   public void setSearchUrl(String searchUrl) {  
  194.     this.searchUrl = searchUrl;  
  195.   }  
  196.   public String getPageNoDisp() {  
  197.     return pageNoDisp;  
  198.   }  
  199.   public void setPageNoDisp(String pageNoDisp) {  
  200.     this.pageNoDisp = pageNoDisp;  
  201.   }  
  202. }  

 

而後是最核心的攔截器了。涉及到了mybatis的核心功能，期間閱讀大量mybatis源碼幾經修改重構，辛苦自沒必要說。

核心思想是將攔截到的select語句，改裝成select count(*)語句，執行之獲得，總數據數。再根據page中的當前頁號算出limit值，拼接到select語句後。

爲簡化代碼使用了Commons JXPath 包，作對象查詢。

Java代碼   收藏代碼
  1. /** 
  2.  * 分頁用攔截器 
  3.  */  
  4. import java.sql.Connection;  
  5. import java.sql.PreparedStatement;  
  6. import java.sql.ResultSet;  
  7. import java.util.Properties;  
  8.   
  9. import org.apache.commons.jxpath.JXPathContext;  
  10. import org.apache.commons.jxpath.JXPathNotFoundException;  
  11. import org.apache.ibatis.executor.Executor;  
  12. import org.apache.ibatis.executor.parameter.DefaultParameterHandler;  
  13. import org.apache.ibatis.mapping.BoundSql;  
  14. import org.apache.ibatis.mapping.MappedStatement;  
  15. import org.apache.ibatis.mapping.MappedStatement.Builder;  
  16. import org.apache.ibatis.mapping.ParameterMapping;  
  17. import org.apache.ibatis.mapping.SqlSource;  
  18. import org.apache.ibatis.plugin.Interceptor;  
  19. import org.apache.ibatis.plugin.Intercepts;  
  20. import org.apache.ibatis.plugin.Invocation;  
  21. import org.apache.ibatis.plugin.Plugin;  
  22. import org.apache.ibatis.plugin.Signature;  
  23. import org.apache.ibatis.session.ResultHandler;  
  24. import org.apache.ibatis.session.RowBounds;  
  25.   
  26. @Intercepts({@Signature(type=Executor.class,method="query",args={ MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class })})  
  27. public class PageInterceptor implements Interceptor{  
  28.   
  29.   public Object intercept(Invocation invocation) throws Throwable {  
  30.       
  31.     //當前環境 MappedStatement，BoundSql，及sql取得  
  32.     MappedStatement mappedStatement=(MappedStatement)invocation.getArgs()[0];      
  33.     Object parameter = invocation.getArgs()[1];   
  34.     BoundSql boundSql = mappedStatement.getBoundSql(parameter);   
  35.     String originalSql = boundSql.getSql().trim();  
  36.     Object parameterObject = boundSql.getParameterObject();  
  37.   
  38.     //Page對象獲取，「信使」到達攔截器！  
  39.     Page page = searchPageWithXpath(boundSql.getParameterObject(),".","page","*/page");  
  40.   
  41.     if(page!=null ){  
  42.       //Page對象存在的場合，開始分頁處理  
  43.       String countSql = getCountSql(originalSql);  
  44.       Connection connection=mappedStatement.getConfiguration().getEnvironment().getDataSource().getConnection()  ;            
  45.       PreparedStatement countStmt = connection.prepareStatement(countSql);    
  46.       BoundSql countBS = copyFromBoundSql(mappedStatement, boundSql, countSql);  
  47.       DefaultParameterHandler parameterHandler = new DefaultParameterHandler(mappedStatement, parameterObject, countBS);  
  48.       parameterHandler.setParameters(countStmt);  
  49.       ResultSet rs = countStmt.executeQuery();  
  50.       int totpage=0;  
  51.       if (rs.next()) {    
  52.         totpage = rs.getInt(1);    
  53.       }  
  54.       rs.close();    
  55.       countStmt.close();    
  56.       connection.close();  
  57.         
  58.       //分頁計算  
  59.       page.setTotalRecord(totpage);  
  60.         
  61.       //對原始Sql追加limit  
  62.       int offset = (page.getPageNo() - 1) * page.getPageSize();  
  63.       StringBuffer sb = new StringBuffer();  
  64.       sb.append(originalSql).append(" limit ").append(offset).append(",").append(page.getPageSize());  
  65.       BoundSql newBoundSql = copyFromBoundSql(mappedStatement, boundSql, sb.toString());  
  66.       MappedStatement newMs = copyFromMappedStatement(mappedStatement,new BoundSqlSqlSource(newBoundSql));    
  67.       invocation.getArgs()[0]= newMs;    
  68.     }  
  69.     return invocation.proceed();  
  70.       
  71.   }  
  72.     
  73.   /** 
  74.    * 根據給定的xpath查詢Page對象 
  75.    */  
  76.   private Page searchPageWithXpath(Object o,String... xpaths) {  
  77.     JXPathContext context = JXPathContext.newContext(o);  
  78.     Object result;  
  79.     for(String xpath : xpaths){  
  80.       try {  
  81.         result = context.selectSingleNode(xpath);  
  82.       } catch (JXPathNotFoundException e) {  
  83.         continue;  
  84.       }  
  85.       if ( result instanceof Page ){  
  86.         return (Page)result;  
  87.       }  
  88.     }  
  89.     return null;  
  90.   }  
  91.   
  92.   /** 
  93.    * 複製MappedStatement對象 
  94.    */  
  95.   private MappedStatement copyFromMappedStatement(MappedStatement ms,SqlSource newSqlSource) {  
  96.     Builder builder = new Builder(ms.getConfiguration(),ms.getId(),newSqlSource,ms.getSqlCommandType());  
  97.       
  98.     builder.resource(ms.getResource());  
  99.     builder.fetchSize(ms.getFetchSize());  
  100.     builder.statementType(ms.getStatementType());  
  101.     builder.keyGenerator(ms.getKeyGenerator());  
  102.     builder.keyProperty(ms.getKeyProperty());  
  103.     builder.timeout(ms.getTimeout());  
  104.     builder.parameterMap(ms.getParameterMap());  
  105.     builder.resultMaps(ms.getResultMaps());  
  106.     builder.resultSetType(ms.getResultSetType());  
  107.     builder.cache(ms.getCache());  
  108.     builder.flushCacheRequired(ms.isFlushCacheRequired());  
  109.     builder.useCache(ms.isUseCache());  
  110.       
  111.     return builder.build();  
  112.   }  
  113.   
  114.   /** 
  115.    * 複製BoundSql對象 
  116.    */  
  117.   private BoundSql copyFromBoundSql(MappedStatement ms, BoundSql boundSql, String sql) {  
  118.     BoundSql newBoundSql = new BoundSql(ms.getConfiguration(),sql, boundSql.getParameterMappings(), boundSql.getParameterObject());  
  119.     for (ParameterMapping mapping : boundSql.getParameterMappings()) {  
  120.         String prop = mapping.getProperty();  
  121.         if (boundSql.hasAdditionalParameter(prop)) {  
  122.             newBoundSql.setAdditionalParameter(prop, boundSql.getAdditionalParameter(prop));  
  123.         }  
  124.     }  
  125.     return newBoundSql;  
  126.   }  
  127.   
  128.   /** 
  129.    * 根據原Sql語句獲取對應的查詢總記錄數的Sql語句 
  130.    */  
  131.   private String getCountSql(String sql) {  
  132.     return "SELECT COUNT(*) FROM (" + sql + ") aliasForPage";  
  133.   }  
  134.   
  135.   public class BoundSqlSqlSource implements SqlSource {    
  136.       BoundSql boundSql;    
  137.       public BoundSqlSqlSource(BoundSql boundSql) {    
  138.         this.boundSql = boundSql;    
  139.       }    
  140.       public BoundSql getBoundSql(Object parameterObject) {    
  141.         return boundSql;    
  142.       }    
  143.     }    
  144.   public Object plugin(Object arg0) {  
  145.      return Plugin.wrap(arg0, this);  
  146.   }  
  147.   public void setProperties(Properties arg0) {  
  148.   }  
  149. }  

 

到展現層終於能夠輕鬆些了，使用了文件標籤來簡化前臺開發。

採用臨時表單提交，CSS使用了Bootstrap。

Html代碼   收藏代碼
  1. <%@tag pageEncoding="UTF-8"%>  
  2. <%@ attribute name="page" type="cn.com.intasect.ots.common.utils.Page" required="true"%>  
  3. <%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core"%>  
  4.   
  5. <%  
  6. int current =  page.getPageNo();  
  7. int begin = 1;  
  8. int end = page.getTotalPage();  
  9.   
  10. request.setAttribute("current", current);  
  11. request.setAttribute("begin", begin);  
  12. request.setAttribute("end", end);  
  13. request.setAttribute("pList", page.getPageNoDisp());  
  14.   
  15. %>  
  16. <script type="text/javascript">  
  17.   var paras = '<%=page.getParaJson()%>';  
  18.   var paraJson = eval('(' + paras + ')');  
  19.   
  20.   //將提交參數轉換爲JSON  
  21.   var paraLists = '<%=page.getParaListJson()%>';  
  22.   var paraListJson = eval('(' + paraLists + ')');  
  23.   function pageClick( pNo ){  
  24.     paraJson["pageNo"] = pNo;  
  25.     paraJson["pageSize"] = "<%=page.getPageSize()%>";  
  26.       
  27.     var jsPost = function(action, values, valueLists) {  
  28.       var id = Math.random();  
  29.       document.write('<form id="post' + id + '" name="post'+ id +'" action="' + action + '" method="post">');  
  30.       for (var key in values) {  
  31.         document.write('<input type="hidden" name="' + key + '" value="' + values[key] + '" />');  
  32.       }  
  33.       for (var key2 in valueLists) {  
  34.         for (var index in valueLists[key2]) {  
  35.           document.write('<input type="hidden" name="' + key2 + '" value="' + valueLists[key2][index] + '" />');  
  36.         }  
  37.       }  
  38.       document.write('</form>');      
  39.       document.getElementById('post' + id).submit();  
  40.     }  
  41.       
  42.     //發送POST  
  43.     jsPost("<%=page.getSearchUrl()%>", paraJson, paraListJson);  
  44.   }  
  45. </script>  
  46. <div class="page-pull-right">  
  47.   <% if (current!=1 && end!=0){%>  
  48.     <button class="btn btn-default btn-sm" onclick="pageClick(1)">首頁</button>  
  49.     <button class="btn btn-default btn-sm" onclick="pageClick(${current-1})">前頁</button>  
  50.   <%}else{%>  
  51.     <button class="btn btn-default btn-sm" >首頁</button>  
  52.     <button class="btn btn-default btn-sm" >前頁</button>  
  53.   <%} %>  
  54.   <c:forTokens items="${pList}" delims="|" var="pNo">  
  55.     <c:choose>  
  56.       <c:when test="${pNo == 0}">  
  57.         <label style="font-size: 10px; width: 20px; text-align: center;">•••</label>  
  58.       </c:when>  
  59.       <c:when test="${pNo != current}">  
  60.         <button class="btn btn-default btn-sm" onclick="pageClick(${pNo})">${pNo}</button>  
  61.       </c:when>  
  62.       <c:otherwise>  
  63.         <button class="btn btn-primary btn-sm" style="font-weight:bold;">${pNo}</button>  
  64.       </c:otherwise>  
  65.     </c:choose>  
  66.   </c:forTokens>  
  67.   <% if (current<end && end!=0){%>  
  68.     <button class="btn btn-default btn-sm" onclick="pageClick(${current+1})">後頁</button>  
  69.     <button class="btn btn-default btn-sm" onclick="pageClick(${end})">末頁</button>  
  70.   <%}else{%>  
  71.     <button class="btn btn-default btn-sm">後頁</button>  
  72.     <button class="btn btn-default btn-sm">末頁</button>  
  73.   <%} %>  
  74. </div>  

注意「信使」在這裏使出了渾身解數，7個主要的get方法所有用上了。

Java代碼   收藏代碼
  1. page.getPageNo()        //當前頁號  
  2. page.getTotalPage()     //總頁數  
  3. page.getPageNoDisp()    //能夠顯示的頁號  
  4. page.getParaJson()      //查詢條件  
  5. page.getParaListJson()  //數組查詢條件  
  6. page.getPageSize()      //每頁行數  
  7. page.getSearchUrl()     //Url地址（做爲action名稱）  

到這裏三個核心模塊完成了。而後是攔截器的註冊。

 

【攔截器的註冊】

須要在mybatis-config.xml 中加入攔截器的配置

Java代碼   收藏代碼
  1. <plugins>  
  2.    <plugin interceptor="cn.com.dingding.common.utils.PageInterceptor">    
  3.    </plugin>  
  4. </plugins>    

 

【相關代碼修改】

首先是後臺代碼的修改，Controller層因爲涉及到查詢條件，須要修改的內容較多。

1）入參需增長 pageNo,pageSize 兩個參數

2）根據pageNo,pageSize 及你的相對url構造page對象。（

3）最重要的是將你的其餘入參（查詢條件）保存到page中

4）Service層的方法須要帶着page這個對象（最終目的是傳遞到sql執行的入參，讓攔截器識別出該sql須要分頁，同時傳遞頁號）

5）將page對象傳回Mode中

修改前

Java代碼   收藏代碼
  1. @RequestMapping(value = "/user/users")  
  2. public String list(  
  3.   @ModelAttribute("name") String name,  
  4.   @ModelAttribute("levelId") String levelId,  
  5.   @ModelAttribute("subjectId") String subjectId,  
  6.   Model model) {  
  7.   model.addAttribute("users",userService.selectByNameLevelSubject(  
  8.           name, levelId, subjectId));  
  9.   return USER_LIST_JSP;  
  10. }  

 修改後

Java代碼   收藏代碼
  1. @RequestMapping(value = "/user/users")  
  2. public String list(  
  3.   @RequestParam(required = false, defaultValue = "1") int pageNo,  
  4.   @RequestParam(required = false, defaultValue = "5") int pageSize,  
  5.   @ModelAttribute("name") String name,  
  6.   @ModelAttribute("levelId") String levelId,  
  7.   @ModelAttribute("subjectId") String subjectId,  
  8.   Model model) {  
  9.   // 這裏是「信使」誕生之地，一出生就加載了不少重要信息！  
  10.   Page page = Page.newBuilder(pageNo, pageSize, "users");  
  11.   page.getParams().put("name", name);           //這裏再保存查詢條件  
  12.   page.getParams().put("levelId", levelId);  
  13.   page.getParams().put("subjectId", subjectId);  
  14.       
  15.   model.addAttribute("users",userService.selectByNameLevelSubject(  
  16.           name, levelId, subjectId, page));  
  17.   model.addAttribute("page", page);             //這裏將page返回前臺  
  18.   return USER_LIST_JSP;  
  19. }  

注意pageSize的缺省值決定該分頁的每頁數據行數 ，實際項目更通用的方式是使用配置文件指定。

 

Service層

攔截器能夠自動識別在Map或Bean中的Page對象。

若是使用Bean須要在裏面增長一個page項目，Map則比較簡單，如下是例子。

Java代碼   收藏代碼
  1. @Override  
  2. public List<UserDTO> selectByNameLevelSubject(String name, String levelId, String subjectId, Page page) {  
  3.   Map<String, Object> map = Maps.newHashMap();  
  4.   levelId = DEFAULT_SELECTED.equals(levelId)?null: levelId;  
  5.   subjectId = DEFAULT_SELECTED.equals(subjectId)?null: subjectId;  
  6.   if (name != null && name.isEmpty()){  
  7.     name = null;  
  8.   }  
  9.   map.put("name", name);  
  10.   map.put("levelId", levelId);  
  11.   map.put("subjectId", subjectId);  
  12.   map.put("page", page);             //MAP的話加這一句就OK  
  13.   return userMapper.selectByNameLevelSubject(map);  
  14. }  

 

前臺頁面方面，因爲使用了標籤，在適當的位置加一句就夠了。

Html代碼   收藏代碼
  1. <tags:page page="${page}"/>  

 「信使」page在這裏進入標籤，讓分頁按鈕最終展示。

 

至此，無需修改一句sql，完成分頁自動化。

 

 

【總結】

 如今回過頭來看下最開始提出的幾個問題：

1）分頁時是要隨時帶有最近一次查詢條件

  回答：在改造Controller層時，經過將提交參數設置到 Page對象的 Map<String, String> params（單個基本型參數） 和 Map<String, List<String>> paramLists（數組基本型）解決。

  順便提一下，例子中沒有涉及參數是Bean的狀況，實際應用中應該比較常見。簡單的方法是將Bean轉換層Map後加入到params。

 

2）不能影響現有的sql，相似aop的效果

  回答：利用Mybatis提供了 Interceptor 接口，攔截後改頭換面去的件數並計算limit值，天然能神不知鬼不覺。

 

3）mybatis提供了通用的攔截接口，要選擇適當的攔截方式和時點

  回答：@Signature(method = "query", type = Executor.class, args = {  MappedStatement.class, Object.class, RowBounds.class,  ResultHandler.class }) 只攔截查詢語句,其餘增刪改查不會影響。

 

4）儘可能少的影響現有service等接口

  回答：這個自認爲本方案作的還不夠好，主要是Controller層改造上，感受代碼量還比較大。若是有有識者知道更好的方案還請多指教。 

 

【遺留問題】

1）一個「明顯」的性能問題，是每次檢索前都要去 select count(*)一次。在不少時候(數據變化不是特別敏感的場景)是沒必要要的。調整也不難，先Controller參數增長一個 totalRecord 總記錄數 ，在稍加修改一下Page相關代碼便可。

2）要排序怎麼辦？本文並未討論排序，可是方法是相似的。以上面代碼爲基礎，能夠較容易地實現一個通用的排序標籤。

 

===================================== 分割線 （1/8）=======================================

對於Controller層須要將入參傳入Page對象的問題已經進行了改善，思路是自動從HttpServletRequest 類中提取入殘，減低了分頁代碼的侵入性，詳細參看文章 http://duanhengbin.iteye.com/blog/2001142

===================================== 分割線 （1/23）=======================================

再次改善，使用ThreadLocal類封裝Page對象，讓Service層等無需傳Page對象，減少了侵入性。攔截器也省去了查找Page對象的動做，性能也同時改善。總體代碼改動不大。

===================================== 分割線 （2/21）=======================================

今天比較閒，順便聊下這個分頁的最終版，固然歷來只有不斷變化的需求，沒有完美的方案，這裏所說的最終版實際上是一個優化後的「零侵入」的方案。爲避免代碼混亂仍是隻介紹思路。在上一個版本(1/23版）基礎上有兩點改動：

一是增長一個配置文件，按Url 配置初始的每頁行數。以下面這樣（pagesize 指的是每頁行數）：

Xml代碼   收藏代碼
  1. <pager url="/user/users" pagesize="10" />  

 二是增長一個過濾器，並將剩下的位於Control類中 惟一侵入性的分頁相關代碼移入過濾器。發現當前的 Url  在配置文件中有匹配是就構造Page對象，並加入到Response中。

 

使用最終版後，對於開發者須要分頁時，只要在配置文件中加一行，並在前端頁面上加一個分頁標籤便可，其餘代碼，SQL等都不須要任何改動，能夠說簡化到了極限。

 

【技術列表】

總結下最終方案用到的技術：

  • Mybatis 提供的攔截器接口實現（實現分頁sql自動 select count 及limit 拼接）
  • Servlet過濾器+ThreadLocal  （生成線程共享的Page對象）
  • 標籤文件   （實現前端共通的分頁效果）
  • 臨時表單提交 （減小頁面體積）

【其餘分頁方案比較】

時下比較成熟的 JPA 的分頁方案，（主要應用在 Hibernate + Spring Data 的場合），主要切入點在DAO層，而Controller等各層接口依然須要帶着pageNumber，pageSize 這些的參數，另外框架開發者還要掌握一些必須的輔助類，如：

  org.springframework.data.repository.PagingAndSortingRepository    可分頁DAO基類

  org.springframework.data.domain.Page            抽取結果封裝類

  org.springframework.data.domain.Pageable     分頁信息類

比較來看 本方案 作到了分頁與業務邏輯的徹底解耦，開發者無需關注分頁，所有經過配置實現。經過這個例子也能夠反映出Mybatis在底層開發上有其獨特的優點。

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程