????????在使用springboot開發系統時，列表查詢經常會用PageHelper來進行分頁。使用起來很方便，但從未想過它的實現原理，所以對其進行解讀。

@Service
public class ScUserServiceImpl extends ServiceImpl<ScUserMapper, ScUser> implements IScUserService {@Overridepublic PageInfo<ScUser> pageList(UserListF form) {LambdaQueryWrapper<ScUser> qw = Wrappers.<ScUser>lambdaQuery().like(ScUser::getName, form.getName());// 開啟分頁，對下一條執行的sql進行分頁Page<ScUser> page = PageHelper.startPage(form.getPageNum(), form.getPageSize());List<ScUser> userList = baseMapper.selectList(qw);return new PageInfo<>(page);}
}

? ? ? ? 基于PageHelper（v5.3.2）官方文檔，這是一個最簡單、最常用的分頁demo，持久層框架使用的是Mybatis-plus.

? ? ? ? 調試截圖：

????????調試過程發現3個問題點：

1. 為什么調用PageHelper.startPage()方法后可以實現分頁？
2. 為什么在執行sql查詢前先執行select count(0) ？
3. 為什么查詢出來的userList不需要return，直接return new PageInfo<>(page)就可以有數據？

? ? ? ? 追蹤過程：

? ? ? ? 進入PageHelper.startPage()方法，看到里面有一個 setLocalPage(page) 方法，方法的入參page里包含了分頁參數pageNum、pageSize等

????????setLocalPage方法對 LOCAL_PAGE 這個線程局部變量進行進行賦值

? ? ? ? 在getLocaPage方法打斷點，看什么時候會取出LOCAL_PAGE線程局部變量。最終發現方法落在了com.github.pagehelper.PageHelper#doBoundSql

????????同時在該方法的第二個入參boundSql里可以下一條要執行的sql

? ? ? ? 繼續追蹤，看到它的上級調用方法在com.github.pagehelper.PageInterceptor#intercept

?????????PageInterceptor這個類實現了ibatis的Interceptor接口，從而實現了對sql語句的攔截

????????intercept()這個方法的中文注釋非常完整，基本可以對照著閱讀源碼。

????????其中 dialect.beforeCount()這個方法會去線程局部變量LOCAL_PAGE中拿到count屬性，從而決定是否在分頁查詢前執行count(0)查詢。而這個count屬性在一開始我們調用PageHelper.startPage()的時候，就配置了默認值true。

? ? ? ? 而 ExecutorUtil.pageQuery() 則是對查詢sql進行解析（配置了多種解析器兼容mysql、oracle、sqlserver、Oscar等），并組裝成對應的分頁sql。組裝好的sql將其封裝為BoundSql對象，再調用org.apache.ibatis.executor.Executor#query()方法執行，最終拿到分頁查詢結果。? ? ??

? ? ? ? 根據現有的結論我們可以得出，分頁參數是通過ThreadLocal<Page>的方式傳遞的，那么第3個問題，為什么分頁查詢結果集不需要return而是直接return?page對象，答案也就水落石出了。

????????在分頁查詢結束后，dialect.afterPage()方法會將結果集resultList塞入到LOCAL_PAGE 這個線程局部變量里去。

? ? ? ? 問題點解答：

? ? ? ? 1、為什么調用PageHelper.startPage()方法后可以實現分頁？

? ? ? ? 因為startPage方法將分頁參數保存到了線程局部變量，然后通過PageInterceptor（它實現了ibatis提供的inteceptor接口）對下一條即將執行的query sql進行攔截，解析語義并組裝為分頁query sql，執行并拿到結果集，并存放到線程局部變量里去。

? ? ? ? 2、為什么在執行sql查詢前先執行select count(0) ？

? ? ? ? 因為調用?PageHelper.startPage(form.getPageNum(), form.getPageSize()) 方法時傳遞了默認count屬性值，默認為true，所以在分頁時會執行count(0)查詢總記錄數。它并不影響分頁的過程、結果，它只是滿足業務需要所做的一個查詢。

? ? ? ? 如果不需要count(0)，可以調用?PageHelper.startPage(form.getPageNum(), form.getPageSize(), false) 來指定。

? ? ? ? 3、為什么查詢出來的userList不需要return，直接return new PageInfo<>(page)就可以有數據？

? ? ? ? 因為page是一個線程局部變量，分頁查詢結束后，PageInterceptor會調用 dialect.afterPage() 將結果集保存到page里去，所以page里會有數據。

? ? ? ? 你也可以return userList，但是page里的屬性更加豐富，它除了結果集之外，還有當前頁、每頁記錄數、總記錄數等等.....

? ? ? ? 小結：

? ? ? ? 經過代碼追蹤，我明白了PageHelper的本質其實是基于ThreadLocal和ibatis提供的sql監聽器實現的，解開了這層神秘的面紗。這種對sql約定好的的統一處理策略，非常值得學習。對也讓我對mybatis的的執行過程更加好奇，后續可以更進一步對mybatis的原理進行追蹤和理解。