摘要：從學(xué)到的不侵入的前言最近搭新項目框架，之前的攔截器都是自己寫的，一般是有個類型做判斷是否增加分頁。發(fā)現(xiàn)開源項目不需要侵入方法的就可以做分頁，特此來源碼分析一下。

最近搭新項目框架，之前 Mybatis 的攔截器都是自己寫的，一般是有個 Page 類型做判斷是否增加分頁 sql。但是這樣同樣的業(yè)務(wù)開放給頁面和 api 可能要寫兩個，一種帶分頁類型 Page 一種不帶分頁。
發(fā)現(xiàn)開源項目 PageHelper 不需要侵入方法的 Signature 就可以做分頁，特此來源碼分析一下。

P.S: 看后面的源碼分析最好能懂 mybatis 得攔截器分頁插件原理

    public PageInfo listRpmDetailByCondition(String filename, Date startTime, Date endTime,
                                                    Integer categoryId, Integer ostypeId, Integer statusId,
                                                    Integer pageNo, Integer pageSize) {
        PageHelper.startPage(pageNo, pageSize);
        List result = rpmDetailMapper.listRpmDetailByCondition(filename, startTime, endTime, categoryId,
                ostypeId, statusId);
        return new PageInfo(result);
    }

    public static  Page startPage(int pageNum, int pageSize, boolean count, Boolean reasonable, Boolean pageSizeZero) {
        Page page = new Page(pageNum, pageSize, count);
        page.setReasonable(reasonable);
        page.setPageSizeZero(pageSizeZero);
        Page oldPage = getLocalPage();
        if (oldPage != null && oldPage.isOrderByOnly()) {
            page.setOrderBy(oldPage.getOrderBy());
        }

        setLocalPage(page);
        return page;
    }

    protected static final ThreadLocal LOCAL_PAGE = new ThreadLocal();
    protected static void setLocalPage(Page page) {
        LOCAL_PAGE.set(page);
    }

可以看出在真正使用分頁前，生成了一個 page 對象，然后放入了 ThreadLocal 中，這個思想很巧妙，利用每個請求 Web 服務(wù)，每個請求由一個線程處理的原理。利用線程來決定是否進行分頁。

        //調(diào)用方法判斷是否需要進行分頁，如果不需要，直接返回結(jié)果
            if (!dialect.skip(ms, parameter, rowBounds)) {
                //判斷是否需要進行 count 查詢
                if (dialect.beforeCount(ms, parameter, rowBounds)) {
                    //查詢總數(shù)
                    Long count = count(executor, ms, parameter, rowBounds, resultHandler, boundSql);
                    //處理查詢總數(shù)，返回 true 時繼續(xù)分頁查詢，false 時直接返回
                    if (!dialect.afterCount(count, parameter, rowBounds)) {
                        //當查詢總數(shù)為 0 時，直接返回空的結(jié)果
                        return dialect.afterPage(new ArrayList(), parameter, rowBounds);
                    }
                }
                resultList = ExecutorUtil.pageQuery(dialect, executor,
                        ms, parameter, rowBounds, resultHandler, boundSql, cacheKey);
            } else {
                //rowBounds用參數(shù)值，不使用分頁插件處理時，仍然支持默認的內(nèi)存分頁
                resultList = executor.query(ms, parameter, rowBounds, resultHandler, cacheKey, boundSql);
            }

 @Override
    private PageParams pageParams;
    public boolean skip(MappedStatement ms, Object parameterObject, RowBounds rowBounds) {
        if (ms.getId().endsWith(MSUtils.COUNT)) {
            throw new RuntimeException("在系統(tǒng)中發(fā)現(xiàn)了多個分頁插件，請檢查系統(tǒng)配置!");
        }
        Page page = pageParams.getPage(parameterObject, rowBounds);
        if (page == null) {
            return true;
        } else {
            //設(shè)置默認的 count 列
            if (StringUtil.isEmpty(page.getCountColumn())) {
                page.setCountColumn(pageParams.getCountColumn());
            }
            autoDialect.initDelegateDialect(ms);
            return false;
        }
    }

    /**
     * 獲取分頁參數(shù)
     *
     * @param parameterObject
     * @param rowBounds
     * @return
     */
    public Page getPage(Object parameterObject, RowBounds rowBounds) {
        Page page = PageHelper.getLocalPage();
        if (page == null) {
            if (rowBounds != RowBounds.DEFAULT) {
                if (offsetAsPageNum) {
                    page = new Page(rowBounds.getOffset(), rowBounds.getLimit(), rowBoundsWithCount);
                } else {
                    page = new Page(new int[]{rowBounds.getOffset(), rowBounds.getLimit()}, rowBoundsWithCount);
                    //offsetAsPageNum=false的時候，由于PageNum問題，不能使用reasonable，這里會強制為false
                    page.setReasonable(false);
                }
                if(rowBounds instanceof PageRowBounds){
                    PageRowBounds pageRowBounds = (PageRowBounds)rowBounds;
                    page.setCount(pageRowBounds.getCount() == null || pageRowBounds.getCount());
                }
            } else if(parameterObject instanceof IPage || supportMethodsArguments){
                try {
                    page = PageObjectUtil.getPageFromObject(parameterObject, false);
                } catch (Exception e) {
                    return null;
                }
            }
            if(page == null){
                return null;
            }
            PageHelper.setLocalPage(page);
        }
        //分頁合理化
        if (page.getReasonable() == null) {
            page.setReasonable(reasonable);
        }
        //當設(shè)置為true的時候，如果pagesize設(shè)置為0（或RowBounds的limit=0），就不執(zhí)行分頁，返回全部結(jié)果
        if (page.getPageSizeZero() == null) {
            page.setPageSizeZero(pageSizeZero);
        }
        return page;
    }

    /**
     * 獲取 Page 參數(shù)
     *
     * @return
     */
    public static  Page getLocalPage() {
        return LOCAL_PAGE.get();
    }

果然如此，至此真相已經(jīng)揭開。

如： 先查出最近一個月注冊的 10 個用戶，再根據(jù)這些用戶查出他們所有的訂單。第一次查詢需要分頁，第二次并不需要

來看看作者怎么實現(xiàn)的？

    try{
        # 分頁攔截邏輯
    } finally {
         dialect.afterAll();
    }

    @Override
  public void afterAll() {
      //這個方法即使不分頁也會被執(zhí)行，所以要判斷 null
      AbstractHelperDialect delegate = autoDialect.getDelegate();
      if (delegate != null) {
          delegate.afterAll();
          autoDialect.clearDelegate();
      }
      clearPage();
  }

   /**
   * 移除本地變量
   */
  public static void clearPage() {
      LOCAL_PAGE.remove();
  }

將分頁對象放入 ThreadLocal

根據(jù) ThreadLocal 判斷是否進行分頁

無論分頁與不分頁都需要清除 ThreadLocal

            
                com.github.pagehelper
                pagehelper
                5.1.8