日韩无码专区无码一级三级片|91人人爱网站中日韩无码电影|厨房大战丰满熟妇|AV高清无码在线免费观看|另类AV日韩少妇熟女|中文日本大黄一级黄色片|色情在线视频免费|亚洲成人特黄a片|黄片wwwav色图欧美|欧亚乱色一区二区三区

RELATEED CONSULTING
相關(guān)咨詢
選擇下列產(chǎn)品馬上在線溝通
服務(wù)時(shí)間：8:30-17:00
你可能遇到了下面的問(wèn)題
關(guān)閉右側(cè)工具欄

新聞中心

這里有您想知道的互聯(lián)網(wǎng)營(yíng)銷解決方案
Mybatis：PageHelper分頁(yè)插件源碼及原理剖析

PageHelper是一款好用的開(kāi)源免費(fèi)的Mybatis第三方物理分頁(yè)插件，其實(shí)我并不想加上好用兩個(gè)字，但是為了表?yè)P(yáng)插件作者開(kāi)源免費(fèi)的崇高精神，我毫不猶豫的加上了好用一詞作為贊美。

公司主營(yíng)業(yè)務(wù)：成都網(wǎng)站設(shè)計(jì)、成都做網(wǎng)站、移動(dòng)網(wǎng)站開(kāi)發(fā)等業(yè)務(wù)。幫助企業(yè)客戶真正實(shí)現(xiàn)互聯(lián)網(wǎng)宣傳，提高企業(yè)的競(jìng)爭(zhēng)能力。創(chuàng)新互聯(lián)建站是一支青春激揚(yáng)、勤奮敬業(yè)、活力青春激揚(yáng)、勤奮敬業(yè)、活力澎湃、和諧高效的團(tuán)隊(duì)。公司秉承以“開(kāi)放、自由、嚴(yán)謹(jǐn)、自律”為核心的企業(yè)文化，感謝他們對(duì)我們的高要求，感謝他們從不同領(lǐng)域給我們帶來(lái)的挑戰(zhàn)，讓我們激情的團(tuán)隊(duì)有機(jī)會(huì)用頭腦與智慧不斷的給客戶帶來(lái)驚喜。創(chuàng)新互聯(lián)建站推出漳平免費(fèi)做網(wǎng)站回饋大家。

原本以為分頁(yè)插件，應(yīng)該是很簡(jiǎn)單的，然而PageHelper比我想象的要復(fù)雜許多，它做的很強(qiáng)大，也很徹底，強(qiáng)大到使用者可能并不需要這么多功能，徹底到一參可以兩用。但是，我認(rèn)為，作為分頁(yè)插件，完成物理分頁(yè)任務(wù)是根本，其它的很多智能并不是必要的，保持它夠傻夠憨，專業(yè)術(shù)語(yǔ)叫stupid，簡(jiǎn)單就是美。

我們將簡(jiǎn)單介紹PageHelper的基本使用和配置參數(shù)的含義，重點(diǎn)分析PageHelper作為Mybatis分頁(yè)插件的實(shí)現(xiàn)原理。

1. PageHelper的maven依賴及插件配置 

 
 
 
 
    
  
  
  
  
  1.   
    2. 
  
  
  
  
  2.     com.github.pagehelper  
    3. 
  
  
  
  
  3.     pagehelper  
    4. 
  
  
  
  
  4.     4.1.6  
    5. 
  
  
  
  
  5.  
    6.

PageHelper除了本身的jar包外，它還依賴了一個(gè)叫jsqlparser的jar包，使用時(shí)，我們不需要單獨(dú)指定jsqlparser的maven依賴，maven的間接依賴會(huì)幫我們引入。 

 
 
 
 
    
  
  
  
  
  1.   
    2. 
  
  
  
  
  2.   
    3. 
  
  
  
  
  3.       
    4. 
  
  
  
  
  4.       
    5. 
  
  
  
  
  5.       
    6. 
  
  
  
  
  6.       
    7. 
  
  
  
  
  7.       
    8. 
  
  
  
  
  8.       
    9. 
  
  
  
  
  9.       
    10. 
  
  
  
  
  10.       
    11. 
  
  
  
  
  11.       
    12. 
  
  
  
  
  12.       
    13. 
  
  
  
  
  13.       
    14. 
  
  
  
  
  14.       
    15. 
  
  
  
  
  15.       
    16. 
  
  
  
  
  16.       
    17. 
  
  
  
  
  17.       
    18. 
  
  
  
  
  18.       
    19. 
  
  
  
  
  19.       
    20. 
  
  
  
  
  20.       
    21. 
  
  
  
  
  21.  
    22.

上面是PageHelper官方給的配置和注釋，雖然寫的很多，不過(guò)確實(shí)描述的很明白。

  •   dialect：標(biāo)識(shí)是哪一種數(shù)據(jù)庫(kù)，設(shè)計(jì)上必須。
  •   offsetAsPageNum：將RowBounds第一個(gè)參數(shù)offset當(dāng)成pageNum頁(yè)碼使用，這就是上面說(shuō)的一參兩用，個(gè)人覺(jué)得完全沒(méi)必要，offset = pageSize * pageNum就搞定了，何必混用參數(shù)呢？
  •   rowBoundsWithCount：設(shè)置為true時(shí)，使用RowBounds分頁(yè)會(huì)進(jìn)行count查詢，個(gè)人覺(jué)得完全沒(méi)必要，實(shí)際開(kāi)發(fā)中，每一個(gè)列表分頁(yè)查詢，都配備一個(gè)count數(shù)量查詢即可。
  •   reasonable：value=true時(shí)，pageNum小于1會(huì)查詢第一頁(yè)，如果pageNum大于pageSize會(huì)查詢最后一頁(yè) ，個(gè)人認(rèn)為，參數(shù)校驗(yàn)在進(jìn)入Mybatis業(yè)務(wù)體系之前，就應(yīng)該完成了，不可能到達(dá)Mybatis業(yè)務(wù)體系內(nèi)參數(shù)還帶有非法的值。

這么一來(lái)，我們只需要記住 dialect = mysql 一個(gè)參數(shù)即可，其實(shí)，還有下面幾個(gè)相關(guān)參數(shù)可以配置。

  •   autoDialect：true or false，是否自動(dòng)檢測(cè)dialect。
  •   autoRuntimeDialect：true or false，多數(shù)據(jù)源時(shí)，是否自動(dòng)檢測(cè)dialect。
  •   closeConn：true or false，檢測(cè)完dialect后，是否關(guān)閉Connection連接。

上面這3個(gè)智能參數(shù)，不到萬(wàn)不得已，我們不應(yīng)該在系統(tǒng)中使用，我們只需要一個(gè)dialect = mysql 或者 dialect = oracle就夠了，如果系統(tǒng)中需要使用，還是得問(wèn)問(wèn)自己，是否真的非用不可。

2. PageHelper源碼分析 

 
 
 
 
    
  
  
  
  
  1. @Intercepts(@Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}))  
    2. 
  
  
  
  
  2. public class PageHelper implements Interceptor {  
    3. 
  
  
  
  
  3.     //sql工具類  
    4. 
  
  
  
  
  4.     private SqlUtil sqlUtil;  
    5. 
  
  
  
  
  5.     //屬性參數(shù)信息  
    6. 
  
  
  
  
  6.     private Properties properties;  
    7. 
  
  
  
  
  7.     //配置對(duì)象方式  
    8. 
  
  
  
  
  8.     private SqlUtilConfig sqlUtilConfig;  
    9. 
  
  
  
  
  9.     //自動(dòng)獲取dialect,如果沒(méi)有setProperties或setSqlUtilConfig，也可以正常進(jìn)行  
    10. 
  
  
  
  
  10.     private boolean autoDialect = true;  
    11. 
  
  
  
  
  11.     //運(yùn)行時(shí)自動(dòng)獲取dialect  
    12. 
  
  
  
  
  12.     private boolean autoRuntimeDialect;  
    13. 
  
  
  
  
  13.     //多數(shù)據(jù)源時(shí)，獲取jdbcurl后是否關(guān)閉數(shù)據(jù)源  
    14. 
  
  
  
  
  14.     private boolean closeConn = true;  
    15. 
  
  
  
  
  15.     //緩存  
    16. 
  
  
  
  
  16.     private Map urlSqlUtilMap = new ConcurrentHashMap();  
    17. 
  
  
  
  
  17.     private ReentrantLock lock = new ReentrantLock();  
    18. 
  
  
  
  
  18. // ...  
    19. 
  
  
  
  
  19. } 
    20.

上面是官方源碼以及源碼所帶的注釋，我們?cè)傺a(bǔ)充一下。

SqlUtil：數(shù)據(jù)庫(kù)類型專用sql工具類，一個(gè)數(shù)據(jù)庫(kù)url對(duì)應(yīng)一個(gè)SqlUtil實(shí)例，SqlUtil內(nèi)有一個(gè)Parser對(duì)象，如果是mysql，它是MysqlParser，如果是oracle，它是OracleParser，這個(gè)Parser對(duì)象是SqlUtil不同實(shí)例的主要存在價(jià)值。執(zhí)行count查詢、設(shè)置Parser對(duì)象、執(zhí)行分頁(yè)查詢、保存Page分頁(yè)對(duì)象等功能，均由SqlUtil來(lái)完成。

SqlUtilConfig：Spring Boot中使用，忽略。

autoRuntimeDialect：多個(gè)數(shù)據(jù)源切換時(shí)，比如mysql和oracle數(shù)據(jù)源同時(shí)存在，就不能簡(jiǎn)單指定dialect，這個(gè)時(shí)候就需要運(yùn)行時(shí)自動(dòng)檢測(cè)當(dāng)前的dialect。

Map urlSqlUtilMap：它就用來(lái)緩存autoRuntimeDialect自動(dòng)檢測(cè)結(jié)果的，key是數(shù)據(jù)庫(kù)的url，value是SqlUtil。由于這種自動(dòng)檢測(cè)只需要執(zhí)行1次，所以做了緩存。

ReentrantLock lock：這個(gè)lock對(duì)象是比較有意思的現(xiàn)象，urlSqlUtilMap明明是一個(gè)同步ConcurrentHashMap，又搞了一個(gè)lock出來(lái)同步ConcurrentHashMap做什么呢？是否是畫蛇添足？

在《Java并發(fā)編程實(shí)戰(zhàn)》一書中有詳細(xì)論述，簡(jiǎn)單的說(shuō)，ConcurrentHashMap可以保證put或者remove方法一定是線程安全的，但它不能保證put、get、remove的組合操作是線程安全的，為了保證組合操作也是線程安全的，所以使用了lock。

com.github.pagehelper.PageHelper.java源碼。 

 
 
 
 
    
  
  
  
  
  1. // Mybatis攔截器方法   
    2. 
  
  
  
  
  2.   public Object intercept(Invocation invocation) throws Throwable {  
    3. 
  
  
  
  
  3.        if (autoRuntimeDialect) {  
    4. 
  
  
  
  
  4.            // 多數(shù)據(jù)源  
    5. 
  
  
  
  
  5.            SqlUtil sqlUtil = getSqlUtil(invocation);  
    6. 
  
  
  
  
  6.            return sqlUtil.processPage(invocation);  
    7. 
  
  
  
  
  7.        } else {  
    8. 
  
  
  
  
  8.            // 單數(shù)據(jù)源  
    9. 
  
  
  
  
  9.            if (autoDialect) {  
    10. 
  
  
  
  
  10.                initSqlUtil(invocation);  
    11. 
  
  
  
  
  11.            }  
    12. 
  
  
  
  
  12.            // 指定了dialect  
    13. 
  
  
  
  
  13.            return sqlUtil.processPage(invocation);  
    14. 
  
  
  
  
  14.        }  
    15. 
  
  
  
  
  15.    }  
    16. 
  
  
  
  
  16.    public synchronized void initSqlUtil(Invocation invocation) {  
    17. 
  
  
  
  
  17.        if (this.sqlUtil == null) {  
    18. 
  
  
  
  
  18.            this.sqlUtil = getSqlUtil(invocation);  
    19. 
  
  
  
  
  19.            if (!autoRuntimeDialect) {  
    20. 
  
  
  
  
  20.                properties = null;  
    21. 
  
  
  
  
  21.                sqlUtilConfig = null;  
    22. 
  
  
  
  
  22.            }  
    23. 
  
  
  
  
  23.            autoDialect = false;  
    24. 
  
  
  
  
  24.        }  
    25. 
  
  
  
  
  25.    }  
    26. 
  
  
  
  
  26.    public void setProperties(Properties p) {  
    27. 
  
  
  
  
  27.        checkVersion();  
    28. 
  
  
  
  
  28.        //多數(shù)據(jù)源時(shí)，獲取jdbcurl后是否關(guān)閉數(shù)據(jù)源  
    29. 
  
  
  
  
  29.        String closeConn = p.getProperty("closeConn");  
    30. 
  
  
  
  
  30.        //解決#97  
    31. 
  
  
  
  
  31.        if(StringUtil.isNotEmpty(closeConn)){  
    32. 
  
  
  
  
  32.            this.closeConn = Boolean.parseBoolean(closeConn);  
    33. 
  
  
  
  
  33.        }  
    34. 
  
  
  
  
  34.        //初始化SqlUtil的PARAMS  
    35. 
  
  
  
  
  35.        SqlUtil.setParams(p.getProperty("params"));  
    36. 
  
  
  
  
  36.        //數(shù)據(jù)庫(kù)方言  
    37. 
  
  
  
  
  37.        String dialect = p.getProperty("dialect");  
    38. 
  
  
  
  
  38.        String runtimeDialect = p.getProperty("autoRuntimeDialect"); 
    39. 
  
  
  
  
  39.        if (StringUtil.isNotEmpty(runtimeDialect) && runtimeDialect.equalsIgnoreCase("TRUE")) {  
    40. 
  
  
  
  
  40.            this.autoRuntimeDialect = true;  
    41. 
  
  
  
  
  41.            this.autoDialect = false;  
    42. 
  
  
  
  
  42.            this.properties = p;  
    43. 
  
  
  
  
  43.        } else if (StringUtil.isEmpty(dialect)) {  
    44. 
  
  
  
  
  44.            autoDialect = true;  
    45. 
  
  
  
  
  45.            this.properties = p;  
    46. 
  
  
  
  
  46.        } else {  
    47. 
  
  
  
  
  47.            autoDialect = false;  
    48. 
  
  
  
  
  48.            sqlUtil = new SqlUtil(dialect);  
    49. 
  
  
  
  
  49.            sqlUtil.setProperties(p);  
    50. 
  
  
  
  
  50.        }  
    51. 
  
  
  
  
  51.    }  
    52. 
  
  
  
  
  52.    public SqlUtil getSqlUtil(Invocation invocation) {  
    53. 
  
  
  
  
  53.        MappedStatement ms = (MappedStatement) invocation.getArgs()[0]; 
    54. 
  
  
  
  
  54.        //改為對(duì)dataSource做緩存  
    55. 
  
  
  
  
  55.        DataSource dataSource = ms.getConfiguration().getEnvironment().getDataSource();  
    56. 
  
  
  
  
  56.        String url = getUrl(dataSource);  
    57. 
  
  
  
  
  57.        if (urlSqlUtilMap.containsKey(url)) {  
    58. 
  
  
  
  
  58.            return urlSqlUtilMap.get(url);  
    59. 
  
  
  
  
  59.        }  
    60. 
  
  
  
  
  60.        try {  
    61. 
  
  
  
  
  61.            lock.lock();  
    62. 
  
  
  
  
  62.            if (urlSqlUtilMap.containsKey(url)) {  
    63. 
  
  
  
  
  63.                return urlSqlUtilMap.get(url);  
    64. 
  
  
  
  
  64.            }  
    65. 
  
  
  
  
  65.            if (StringUtil.isEmpty(url)) {  
    66. 
  
  
  
  
  66.                throw new RuntimeException("無(wú)法自動(dòng)獲取jdbcUrl，請(qǐng)?jiān)诜猪?yè)插件中配置dialect參數(shù)!");  
    67. 
  
  
  
  
  67.            }  
    68. 
  
  
  
  
  68.            String dialect = Dialect.fromJdbcUrl(url);  
    69. 
  
  
  
  
  69.            if (dialect == null) {  
    70. 
  
  
  
  
  70.                throw new RuntimeException("無(wú)法自動(dòng)獲取數(shù)據(jù)庫(kù)類型，請(qǐng)通過(guò)dialect參數(shù)指定!");  
    71. 
  
  
  
  
  71.            }  
    72. 
  
  
  
  
  72.            SqlUtil sqlUtil = new SqlUtil(dialect);  
    73. 
  
  
  
  
  73.            if (this.properties != null) {  
    74. 
  
  
  
  
  74.                sqlUtil.setProperties(properties);  
    75. 
  
  
  
  
  75.            } else if (this.sqlUtilConfig != null) {  
    76. 
  
  
  
  
  76.                sqlUtil.setSqlUtilConfig(this.sqlUtilConfig);  
    77. 
  
  
  
  
  77.            }  
    78. 
  
  
  
  
  78.            urlSqlUtilMap.put(url, sqlUtil);  
    79. 
  
  
  
  
  79.            return sqlUtil;  
    80. 
  
  
  
  
  80.        } finally {  
    81. 
  
  
  
  
  81.            lock.unlock();  
    82. 
  
  
  
  
  82.        }  
    83. 
  
  
  
  
  83.    } 
    84.
  •   autoRuntimeDialect：多數(shù)據(jù)源，會(huì)創(chuàng)建多個(gè)SqlUtil。
  •   autoDialect：?jiǎn)螖?shù)據(jù)源，只會(huì)創(chuàng)建1個(gè)SqlUtil。單數(shù)據(jù)源時(shí)，也可以當(dāng)做多數(shù)據(jù)源來(lái)使用。
  •   指定了dialect：只會(huì)創(chuàng)建1個(gè)SqlUtil。

3. PageSqlSource 

 
 
 
 
    
  
  
  
  
  1. public abstract class PageSqlSource implements SqlSource {  
    2. 
  
  
  
  
  2.  /**  
    3. 
  
  
  
  
  3.      * 獲取正常的BoundSql  
    4. 
  
  
  
  
  4.      *  
    5. 
  
  
  
  
  5.      * @param parameterObject  
    6. 
  
  
  
  
  6.      * @return  
    7. 
  
  
  
  
  7.      */  
    8. 
  
  
  
  
  8.     protected abstract BoundSql getDefaultBoundSql(Object parameterObject);  
    9. 
  
  
  
  
  9.     /**  
    10. 
  
  
  
  
  10.      * 獲取Count查詢的BoundSql  
    11. 
  
  
  
  
  11.      *  
    12. 
  
  
  
  
  12.      * @param parameterObject  
    13. 
  
  
  
  
  13.      * @return  
    14. 
  
  
  
  
  14.      */  
    15. 
  
  
  
  
  15.     protected abstract BoundSql getCountBoundSql(Object parameterObject);  
    16. 
  
  
  
  
  16.     /**  
    17. 
  
  
  
  
  17.      * 獲取分頁(yè)查詢的BoundSql  
    18. 
  
  
  
  
  18.      *  
    19. 
  
  
  
  
  19.      * @param parameterObject  
    20. 
  
  
  
  
  20.      * @return  
    21. 
  
  
  
  
  21.      */  
    22. 
  
  
  
  
  22.     protected abstract BoundSql getPageBoundSql(Object parameterObject);  
    23. 
  
  
  
  
  23.     /**  
    24. 
  
  
  
  
  24.      * 獲取BoundSql  
    25. 
  
  
  
  
  25.      *  
    26. 
  
  
  
  
  26.      * @param parameterObject  
    27. 
  
  
  
  
  27.      * @return  
    28. 
  
  
  
  
  28.      */  
    29. 
  
  
  
  
  29.     @Override  
    30. 
  
  
  
  
  30.     public BoundSql getBoundSql(Object parameterObject) {  
    31. 
  
  
  
  
  31.         Boolean count = getCount();  
    32. 
  
  
  
  
  32.         if (count == null) {  
    33. 
  
  
  
  
  33.             return getDefaultBoundSql(parameterObject);  
    34. 
  
  
  
  
  34.         } else if (count) {  
    35. 
  
  
  
  
  35.             return getCountBoundSql(parameterObject);  
    36. 
  
  
  
  
  36.         } else {  
    37. 
  
  
  
  
  37.             return getPageBoundSql(parameterObject);  
    38. 
  
  
  
  
  38.         }  
    39. 
  
  
  
  
  39.     }  
    40. 
  
  
  
  
  40. } 
    41.
  •   getDefaultBoundSql：獲取原始的未經(jīng)改造的BoundSql。
  •   getCountBoundSql：不需要寫count查詢，插件根據(jù)分頁(yè)查詢sql，智能的為你生成的count查詢BoundSql。
  •   getPageBoundSql：獲取分頁(yè)查詢的BoundSql。

舉例：

DefaultBoundSql：

 
 
 
 
    
  
  
  
  
  1. select  stud_id as studId , name, email, dob, phone from students 
    2.

CountBoundSql：

 
 
 
 
    
  
  
  
  
  1. select  count(0) from students --由PageHelper智能完成 
    2.

PageBoundSql： 

 
 
 
 
    
  
  
  
  
  1. select  stud_id as studId , name, email, dob, phone from students limit ?, ? 
    2. 
 
 
 
 
 
 
 
 
    
  
  
  
  
  1. public class PageStaticSqlSource extends PageSqlSource {  
    2. 
  
  
  
  
  2.     private String sql;  
    3. 
  
  
  
  
  3.     private List parameterMappings;  
    4. 
  
  
  
  
  4.     private Configuration configuration;  
    5. 
  
  
  
  
  5.     private SqlSource original;  
    6. 
  
  
  
  
  6.     @Override  
    7. 
  
  
  
  
  7.     protected BoundSql getDefaultBoundSql(Object parameterObject) {  
    8. 
  
  
  
  
  8.         String tempSql = sql;  
    9. 
  
  
  
  
  9.         String orderBy = PageHelper.getOrderBy();  
    10. 
  
  
  
  
  10.         if (orderBy != null) {  
    11. 
  
  
  
  
  11.             tempSql = OrderByParser.converToOrderBySql(sql, orderBy);  
    12. 
  
  
  
  
  12.         }  
    13. 
  
  
  
  
  13.         return new BoundSql(configuration, tempSql, parameterMappings, parameterObject);  
    14. 
  
  
  
  
  14.     }  
    15. 
  
  
  
  
  15.     @Override  
    16. 
  
  
  
  
  16.     protected BoundSql getCountBoundSql(Object parameterObject) {  
    17. 
  
  
  
  
  17.         // localParser指的就是MysqlParser或者OracleParser  
    18. 
  
  
  
  
  18.         // localParser.get().getCountSql(sql)，可以根據(jù)原始的sql，生成一個(gè)count查詢的sql  
    19. 
  
  
  
  
  19.         return new BoundSql(configuration, localParser.get().getCountSql(sql), parameterMappings, parameterObject);  
    20. 
  
  
  
  
  20.     }  
    21. 
  
  
  
  
  21.     @Override  
    22. 
  
  
  
  
  22.     protected BoundSql getPageBoundSql(Object parameterObject) {  
    23. 
  
  
  
  
  23.         String tempSql = sql;  
    24. 
  
  
  
  
  24.         String orderBy = PageHelper.getOrderBy();  
    25. 
  
  
  
  
  25.         if (orderBy != null) {  
    26. 
  
  
  
  
  26.             tempSql = OrderByParser.converToOrderBySql(sql, orderBy);  
    27. 
  
  
  
  
  27.         }  
    28. 
  
  
  
  
  28.         // getPageSql可以根據(jù)原始的sql，生成一個(gè)帶有分頁(yè)參數(shù)信息的sql，比如 limit ?, ?  
    29. 
  
  
  
  
  29.         tempSql = localParser.get().getPageSql(tempSql);  
    30. 
  
  
  
  
  30.         // 由于sql增加了分頁(yè)參數(shù)的？號(hào)占位符，getPageParameterMapping()就是在原有List基礎(chǔ)上，增加兩個(gè)分頁(yè)參數(shù)對(duì)應(yīng)的ParameterMapping對(duì)象，為分頁(yè)參數(shù)賦值使用  
    31. 
  
  
  
  
  31.         return new BoundSql(configuration, tempSql, localParser.get().getPageParameterMapping(configuration, original.getBoundSql(parameterObject)), parameterObject); 
    32. 
  
  
  
  
  32.      }  
    33. 
  
  
  
  
  33. } 
    34.

假設(shè)List原來(lái)的size=2，添加分頁(yè)參數(shù)后，其size=4，具體增加多少個(gè)，看分頁(yè)參數(shù)的？號(hào)數(shù)量。

其他PageSqlSource，原理和PageStaticSqlSource一模一樣。

解析sql，并增加分頁(yè)參數(shù)占位符，或者生成count查詢的sql，都依靠Parser來(lái)完成。

4. com.github.pagehelper.parser.Parser

 
 
 
 
    
  
  
  
  
  1. public class MysqlParser extends AbstractParser {  
    2. 
  
  
  
  
  2.     @Override  
    3. 
  
  
  
  
  3.     public String getPageSql(String sql) {  
    4. 
  
  
  
  
  4.         StringBuilder sqlBuilder = new StringBuilder(sql.length() + 14);  
    5. 
  
  
  
  
  5.         sqlBuilder.append(sql);  
    6. 
  
  
  
  
  6.         sqlBuilder.append(" limit ?,?");  
    7. 
  
  
  
  
  7.         return sqlBuilder.toString();  
    8. 
  
  
  
  
  8.     }  
    9. 
  
  
  
  
  9.     @Override  
    10. 
  
  
  
  
  10.     public Map setPageParameter(MappedStatement ms, Object parameterObject, BoundSql boundSql, Page page) {  
    11. 
  
  
  
  
  11.         Map paramMap = super.setPageParameter(ms, parameterObject, boundSql, page);  
    12. 
  
  
  
  
  12.         paramMap.put(PAGEPARAMETER_FIRST, page.getStartRow());  
    13. 
  
  
  
  
  13.         paramMap.put(PAGEPARAMETER_SECOND, page.getPageSize());  
    14. 
  
  
  
  
  14.         return paramMap;  
    15. 
  
  
  
  
  15.     }  
    16. 
  
  
  
  
  16. } 
    17.

我們可以清楚的看到，MysqlParser是如何添加分頁(yè)占位符和分頁(yè)參數(shù)的。 

 
 
 
 
    
  
  
  
  
  1. public abstract class AbstractParser implements Parser, Constant {  
    2. 
  
  
  
  
  2.     public String getCountSql(final String sql) {  
    3. 
  
  
  
  
  3.         return sqlParser.getSmartCountSql(sql);  
    4. 
  
  
  
  
  4.     }  
    5. 
  
  
  
  
  5. } 
    6.

生成count sql，則是前文提到的jsqlparser工具包來(lái)完成的，是另外一個(gè)開(kāi)源的sql解析工具包。

5. SqlUtil.doProcessPage()分頁(yè)查詢 

 
 
 
 
    
  
  
  
  
  1. // PageSqlSource裝飾原SqlSource   
    2. 
  
  
  
  
  2. public void processMappedStatement(MappedStatement ms) throws Throwable {  
    3. 
  
  
  
  
  3.         SqlSource sqlSource = ms.getSqlSource();  
    4. 
  
  
  
  
  4.         MetaObject msObject = SystemMetaObject.forObject(ms);  
    5. 
  
  
  
  
  5.         SqlSource pageSqlSource;  
    6. 
  
  
  
  
  6.         if (sqlSource instanceof StaticSqlSource) {  
    7. 
  
  
  
  
  7.             pageSqlSource = new PageStaticSqlSource((StaticSqlSource) sqlSource);  
    8. 
  
  
  
  
  8.         } else if (sqlSource instanceof RawSqlSource) {  
    9. 
  
  
  
  
  9.             pageSqlSource = new PageRawSqlSource((RawSqlSource) sqlSource);  
    10. 
  
  
  
  
  10.         } else if (sqlSource instanceof ProviderSqlSource) {  
    11. 
  
  
  
  
  11.             pageSqlSource = new PageProviderSqlSource((ProviderSqlSource) sqlSource);  
    12. 
  
  
  
  
  12.         } else if (sqlSource instanceof DynamicSqlSource) {  
    13. 
  
  
  
  
  13.             pageSqlSource = new PageDynamicSqlSource((DynamicSqlSource) sqlSource);  
    14. 
  
  
  
  
  14.         } else {  
    15. 
  
  
  
  
  15.             throw new RuntimeException("無(wú)法處理該類型[" + sqlSource.getClass() + "]的SqlSource");  
    16. 
  
  
  
  
  16.         }  
    17. 
  
  
  
  
  17.         msObject.setValue("sqlSource", pageSqlSource);  
    18. 
  
  
  
  
  18.         //由于count查詢需要修改返回值，因此這里要?jiǎng)?chuàng)建一個(gè)Count查詢的MS  
    19. 
  
  
  
  
  19.         msCountMap.put(ms.getId(), MSUtils.newCountMappedStatement(ms));  
    20. 
  
  
  
  
  20.     }  
    21. 
  
  
  
  
  21. // 執(zhí)行分頁(yè)查詢  
    22. 
  
  
  
  
  22. private Page doProcessPage(Invocation invocation, Page page, Object[] args) throws Throwable {  
    23. 
  
  
  
  
  23.         //保存RowBounds狀態(tài)  
    24. 
  
  
  
  
  24.         RowBounds rowBounds = (RowBounds) args[2];  
    25. 
  
  
  
  
  25.         //獲取原始的ms  
    26. 
  
  
  
  
  26.         MappedStatement ms = (MappedStatement) args[0];  
    27. 
  
  
  
  
  27.         //判斷并處理為PageSqlSource  
    28. 
  
  
  
  
  28.         if (!isPageSqlSource(ms)) {  
    29. 
  
  
  
  
  29.             processMappedStatement(ms);  
    30. 
  
  
  
  
  30.         }  
    31. 
  
  
  
  
  31.         //設(shè)置當(dāng)前的parser，后面每次使用前都會(huì)set，ThreadLocal的值不會(huì)產(chǎn)生不良影響  
    32. 
  
  
  
  
  32.         ((PageSqlSource)ms.getSqlSource()).setParser(parser);  
    33. 
  
  
  
  
  33.         try { 
    34. 
  
  
  
  
  34.              //忽略RowBounds-否則會(huì)進(jìn)行Mybatis自帶的內(nèi)存分頁(yè)  
    35. 
  
  
  
  
  35.             args[2] = RowBounds.DEFAULT;  
    36. 
  
  
  
  
  36.             //如果只進(jìn)行排序 或 pageSizeZero的判斷  
    37. 
  
  
  
  
  37.             if (isQueryOnly(page)) {  
    38. 
  
  
  
  
  38.                 return doQueryOnly(page, invocation);  
    39. 
  
  
  
  
  39.             }  
    40. 
  
  
  
  
  40.             //簡(jiǎn)單的通過(guò)total的值來(lái)判斷是否進(jìn)行count查詢  
    41. 
  
  
  
  
  41.             if (page.isCount()) {  
    42. 
  
  
  
  
  42.                 page.setCountSignal(Boolean.TRUE);  
    43. 
  
  
  
  
  43.                 //替換MS  
    44. 
  
  
  
  
  44.                 args[0] = msCountMap.get(ms.getId());  
    45. 
  
  
  
  
  45.                 //查詢總數(shù)  
    46. 
  
  
  
  
  46.                 Object result = invocation.proceed();  
    47. 
  
  
  
  
  47.                 //還原ms  
    48. 
  
  
  
  
  48.                 args[0] = ms;  
    49. 
  
  
  
  
  49.                 //設(shè)置總數(shù)  
    50. 
  
  
  
  
  50.                 page.setTotal((Integer) ((List) result).get(0));  
    51. 
  
  
  
  
  51.                 if (page.getTotal() == 0) {  
    52. 
  
  
  
  
  52.                     return page;  
    53. 
  
  
  
  
  53.                 }  
    54. 
  
  
  
  
  54.             } else {  
    55. 
  
  
  
  
  55.                 page.setTotal(-1l);  
    56. 
  
  
  
  
  56.             }  
    57. 
  
  
  
  
  57.             //pageSize>0的時(shí)候執(zhí)行分頁(yè)查詢，pageSize<=0的時(shí)候不執(zhí)行相當(dāng)于可能只返回了一個(gè)count  
    58. 
  
  
  
  
  58.             if (page.getPageSize() > 0 &&  
    59. 
  
  
  
  
  59.                     ((rowBounds == RowBounds.DEFAULT && page.getPageNum() > 0)  
    60. 
  
  
  
  
  60.                             || rowBounds != RowBounds.DEFAULT)) {  
    61. 
  
  
  
  
  61.                 //將參數(shù)中的MappedStatement替換為新的qs  
    62. 
  
  
  
  
  62.                 page.setCountSignal(null);  
    63. 
  
  
  
  
  63.                 BoundSql boundSql = ms.getBoundSql(args[1]);  
    64. 
  
  
  
  
  64.                 args[1] = parser.setPageParameter(ms, args[1], boundSql, page);  
    65. 
  
  
  
  
  65.                 page.setCountSignal(Boolean.FALSE);  
    66. 
  
  
  
  
  66.                 //執(zhí)行分頁(yè)查詢  
    67. 
  
  
  
  
  67.                 Object result = invocation.proceed();  
    68. 
  
  
  
  
  68.                 //得到處理結(jié)果  
    69. 
  
  
  
  
  69.                 page.addAll((List) result);  
    70. 
  
  
  
  
  70.             }  
    71. 
  
  
  
  
  71.         } finally {  
    72. 
  
  
  
  
  72.             ((PageSqlSource)ms.getSqlSource()).removeParser();  
    73. 
  
  
  
  
  73.         }  
    74. 
  
  
  
  
  74.         //返回結(jié)果  
    75. 
  
  
  
  
  75.         return page;  
    76. 
  
  
  
  
  76.     } 
    77.

源碼中注意關(guān)鍵的四點(diǎn)即可：

1、msCountMap.put(ms.getId(), MSUtils.newCountMappedStatement(ms))，創(chuàng)建count查詢的MappedStatement對(duì)象，并緩存于msCountMap。

2、如果count=true，則執(zhí)行count查詢，結(jié)果total值保存于page對(duì)象中，繼續(xù)執(zhí)行分頁(yè)查詢。

3、執(zhí)行分頁(yè)查詢，將查詢結(jié)果保存于page對(duì)象中，page是一個(gè)ArrayList對(duì)象。

4、args[2] = RowBounds.DEFAULT，改變Mybatis原有分頁(yè)行為；

args[1] = parser.setPageParameter(ms, args[1], boundSql, page)，改變?cè)袇?shù)列表（增加分頁(yè)參數(shù)）。

6. PageHelper的兩種使用方式

第一種、直接通過(guò)RowBounds參數(shù)完成分頁(yè)查詢 。 

 
 
 
 
    
  
  
  
  
  1. List list = studentMapper.find(new RowBounds(0, 10));  
    2. 
  
  
  
  
  2. Page page = ((Page) list; 
    3.

第二種、PageHelper.startPage()靜態(tài)方法 

 
 
 
 
    
  
  
  
  
  1. //獲取第1頁(yè)，10條內(nèi)容，默認(rèn)查詢總數(shù)count  
    2. 
  
  
  
  
  2.     PageHelper.startPage(1, 10);  
    3. 
  
  
  
  
  3. //緊跟著的第一個(gè)select方法會(huì)被分頁(yè)  
    4. 
  
  
  
  
  4.     List list = studentMapper.find();  
    5. 
  
  
  
  
  5.     Page page = ((Page) list; 
    6.

注：返回結(jié)果list，已經(jīng)是Page對(duì)象，Page對(duì)象是一個(gè)ArrayList。

原理：使用ThreadLocal來(lái)傳遞和保存Page對(duì)象，每次查詢，都需要單獨(dú)設(shè)置PageHelper.startPage()方法。 

 
 
 
 
    
  
  
  
  
  1. public class SqlUtil implements Constant {  
    2. 
  
  
  
  
  2.     private static final ThreadLocal LOCAL_PAGE = new ThreadLocal();  
    3. 
  
  
  
  
  3. } 
    4.

本文中經(jīng)常提到的count查詢，其實(shí)是PageHelper幫助我們生成的一個(gè)MappedStatement內(nèi)存對(duì)象，它可以免去我們?cè)赬XXMapper.xml內(nèi)單獨(dú)聲明一個(gè)sql count查詢，我們只需要寫一個(gè)sql分頁(yè)業(yè)務(wù)查詢即可。 


新聞標(biāo)題：Mybatis：PageHelper分頁(yè)插件源碼及原理剖析
本文URL：http://www.5511xx.com/article/cdsoghj.html