Mybatis第三方PageHelper分頁插件的使用與原理

Posted on by

​用法

​

此時commentAnalyses為Page對象（PageHelper插件包內定義的）

​

而Page對象繼承自JDK中的ArrayList，擴展並封裝瞭一些page相關的字段，如頁碼，每頁大小，總記錄數，總頁數等。

​原理

我們就加瞭一行，它是如何幫助我們實現分頁的呢？請往下看。

PageHelper.startPage做瞭什麼

我們看這一行PageHelper.startPage(pageIndex, pageSize);做瞭什麼。這個類中重載瞭好多個startPage方法，最終調用到如下的一個方法

​可以看到該方法將分頁信息作為構造器參數實例化Page對象，調用SqlUtil.getLocalPage()獲取一個舊的Page對象，最後調用SqlUtil.setLocalPage(page);把新創建的Page對象set進去。

我們看看這兩個方法做瞭什麼。如下，很簡單，從ThreadLocal中獲取Page對象，將Page對象set到ThreadLocal中。知道ThreadLocal作用的不用多說，不知道的可以理解為用於保存本地變量，並與線程綁定。

​看到這我們暫且將這一行的作用記為，創建並保存Page對象（分頁信息）到ThreadLocal中。

Page分頁信息在哪使用

那麼既然保存瞭，就有使用的地方。

我通過代碼追蹤的方式定位到被調用的地方，通過回溯，發現是從這個類com.github.pagehelper.dialect.AbstractDialect發起調用的

點進去看瞭一下，主要是取出Page對象用於做一些判斷，或保存page相關的信息。應該後續會涉及到

攔截器

上述AbstractDialect類中的這些方法再回溯，指向瞭

com.github.pagehelper.util.SqlUtil#doIntercept方法，intercep調用瞭doIntercep方法，

繼續往上追蹤來到瞭com.github.pagehelper.PageHelper#intercept，這是Interceptor接口的方法。

然後是org.apache.ibatis.plugin.Plugin#invoke調用瞭com.github.pagehelper.PageHelper#intercept。

可以看到PageHelper實現瞭Interceptor，這個接口是Mybatis官方提供的，中文意思是攔截器，所以有可能是通過實現這個攔截器做瞭某些操作來實現分頁的。

插件

通過代碼追蹤我們看到Interceptor的intercept方法是在Mybatis的一個org.apache.ibatis.plugin.Plugin類的invoke方法中調用的，而這個Plugin類實現瞭JDK的java.lang.reflect.InvocationHandler接口，這是JDK代理接口。

這個Plugin中有一個wrap方法會返回一個代理類，所以當調用這個代理類的方法時就會走到上面的invoke方法，就可能會進到攔截器的intercept方法。

所以我們看這個warp在哪調的，就知道啥時候創建這個代理類。就是在上面的PageHelper中，再貼一下代碼

攔截器鏈

而這個PageHelper中的plugin方法是實現自Interceptor攔截器接口，所以會有一個地方統一調這個方法，往上追溯就會發現是在org.apache.ibatis.plugin.InterceptorChain攔截器鏈中調用的，如下。

該類有一個List保存所有攔截器，還有三個方法，分別是pluginAll用於調用所有攔截器的plugin方法，addInterceptor添加攔截器，getInterceptors獲取攔截器鏈。

看到這大致明白瞭它的原理，PageHelper通過實現Mybatis的Interceptor接口實現分頁，Mybatis通過InterceptorChain調用所有Interceptor。

加載&調用攔截器

那麼我們看看Mybatis的攔截器是什麼時候添加到攔截器鏈，什麼時候被調用的。

通過代碼追溯，發現在Configuration的addInterceptor方法中調用添加方法，Configuration.addInterceptor是在XMLConfigBuilder的pluginElement方法中被調用

​而XMLConfigBuilder是解析XML方式的Mybatis的配置的，顧名思義pluginElement方法是解析XML中plugin相關的配置節點的

而我們確實在XML中配置瞭plugin

所以我們現在知道瞭mybatis的攔截器是在Mybatis解析配置文件時，解析plugins節點時添加到InterceptorChain中的。

攔截器什麼時候調用的。我們看InterceptorChain的pluginAll方法在哪調的，通過代碼追蹤有如下四個地方調用攔截器鏈

@Intercepts註解

而PageHelper這個攔截器，我們可以發現這個類上有一個@Intercepts註解，這個註解接收的值為@Signature註解，在Signature註解配置瞭，Executor.class，query還有四個class：MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class。

瞭解Mybatis的插件機制的就明白瞭，這一行配置的意思是攔截Executor中的query方法，方法參數列表類型是MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class，就是下面這個方法。

所以看到這，我們可以斷定InterceptorChain的pluginAll方法在上述調用點的第四個，也就是org.apache.ibatis.session.Configuration#newExecutor(org.apache.ibatis.transaction.Transaction, org.apache.ibatis.session.ExecutorType)，可想而知newExecutor，也就是創建Executor實例，可以斷定，創建Executor時通過PageHelper的plugin方法包裝瞭Executor，返回的是Executor的代理類。下面會講到創建動態代理。

通過PageHelper創建代理對象

我們在正向回顧一下，如何調到PageHelper的。首先進入到pluginAll

然後會調到PageHelper的plugin方法，內部又調Plugin的warp方法

我們看看Plugin.wrap方法幹瞭啥，代碼如下。代碼跟過來我們知道現在的target是Executor，interceptor是PageHelper。首先獲取PageHelper攔截信息，然後篩選target是否是需要攔截的類型，這裡會進入if判斷邏輯，返回Executor的代理對象。

所以這時創建的Executor實例是代理對象，那麼就會在某個時候調用代理的invoke方法（org.apache.ibatis.plugin.Plugin#invoke），invoke調Interceptor攔截器的intercept方法，從而調PageHelper的intercept方法執行分頁邏輯

org.apache.ibatis.plugin.Plugin#invoke ==》 com.github.pagehelper.PageHelper#intercept

攔截器的調用源頭-動態代理

因為返回的是Executor的動態代理，所以肯定是調用Executor的某個方法時觸發進到invoke方法，具體在哪調的不好找。我們通過打斷點的方式看是從哪進invoke方法的，首先斷點打到Plugin的invoke方法內

通過調用棧看到是org.apache.ibatis.session.defaults.DefaultSqlSession#selectList(java.lang.String, java.lang.Object, org.apache.ibatis.session.RowBounds)調過來的，在invoke方法內判斷瞭目標方法是不是我們要攔截的方法，因為PageHelper上註解的也是攔截這個方法，所以會進入到Plugin的invoke方法的第61行。所以就會進入到PageHelper的intercept方法，執行具體的攔截邏輯。

分頁邏輯

思路就是拼SQL。

通過代碼跟蹤，最終的分頁邏輯是在com.github.pagehelper.util.SqlUtil#doIntercept方法中，第162行，獲取分頁SQL，

調用

com.github.pagehelper.dialect.AbstractDialect#getPageSql(org.apache.ibatis.mapping.MappedStatement, org.apache.ibatis.mapping.BoundSql, java.lang.Object, org.apache.ibatis.session.RowBounds, org.apache.ibatis.cache.CacheKey)

在com.github.pagehelper.dialect.AbstractDialect#getPageSql(org.apache.ibatis.mapping.MappedStatement, org.apache.ibatis.mapping.BoundSql, java.lang.Object, org.apache.ibatis.session.RowBounds, org.apache.ibatis.cache.CacheKey)中調用com.github.pagehelper.dialect.AbstractDialect#getPageSql(java.lang.String, com.github.pagehelper.Page, org.apache.ibatis.session.RowBounds,org.apache.ibatis.cache.CacheKey)，是一個抽象方法，具體實現有好多種

我們看mysql的，在原始SQL 拼接瞭" limit ?,?"

​總結

以上是PageHelper實現分頁的原理，總結一下：

Mybatis在四個地方留瞭擴展點，可以通過自定義攔截器實現Interceptor接口的plugin方法，執行自定義邏輯，可以通過該方法對Executor、ParameterHandler、ResultSetHandler、StatementHandler四個對象進行增強、擴展。

PageHelper實現瞭Interceptor接口，它的plugin方法調用Plugin.wrap方法對目標對象進行包裝，包裝成一個代理對象並返回，代理類的實現就是Plugin自身。

Plugin.wrap方法判斷目標對象是否需要返回代理對象，判斷依據是：Interceptor實現類（這裡是PageHelper)上註解標註的類是否包含目標對象所屬類。這裡PageHelper上註解標註參數為Executor對象，所以創建Executor對象會返回代理對象。

當調用Executor對象的方法時會進入到Plugin.invoke方法。invoke方法會判斷是否需要走攔截器的intercept方法，判斷方式是取攔截器上的註解標註的方法，這裡PageHelper標註的為executor.query(四個參數的那個)，所以調這個時才會被攔截器攔截，其餘方法還用原始對象調用。

PageHelper的intercept方法調用SqlUtil的intercept方法最終調SqlUtil.doIntercept方法。在這個方法裡會執行count語句，並將結果放到page對象裡，然後判斷需要分頁，則將分頁sql拼在原始sql上，然後執行。

簡單來說就是通過mybatis的攔截器和插件實現的，PageHelper實現瞭Interceptor攔截器接口，並攔截Executor的query方法，在執行前PageHelper會在原始SQL前拼裝分頁相關的SQL。

PageHelper支持以下數據庫的分頁：Db2、Hsqldbt 、Informix、MySq、Oracle 、SqlServer2012、SqlServer

mybatis的插件Plugin是通過JDK動態代理對目標對象進行增強

到此這篇關於Mybatis第三方PageHelper分頁插件使用與原理的文章就介紹到這瞭,更多相關Mybatis第三方PageHelper分頁插件內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：