快捷導(dǎo)航

mybatis-plus的分頁攔截器(PaginationInterceptor)分頁失敗問題及解決

更新時(shí)間：2025年05月22日 09:29:35 作者：thewindkee

這篇文章主要介紹了mybatis-plus的分頁攔截器(PaginationInterceptor)分頁失敗問題及解決,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教

背景

項(xiàng)目中使用到了mybatis-plus的3.0.5版本，分頁攔截器是PaginationInterceptor。

代碼如下：

    @Transactional(readOnly = true)
    public void test() {
        int current =1;
        while (true) {
            final LambdaQueryWrapper<Foo> query = Condition.<Foo>lambda().gt(AppProject::getBusiId, 1);
            //傳入增長頁數(shù)來查詢
            Page<Foo> page = new Page<>(current++, 1000);
            Page<Foo> result = fooMapper.selectPage(page, query);
            //...業(yè)務(wù)
            if (result .getRecords() == null && || CollectionUtils.isEmpty(result .getRecords())) {
                break;
            }
        }
    }

現(xiàn)象

1.無法從while中跳出循環(huán)。

2.打印sql日志只打印了一次。

猜測

懷疑分頁失敗了。
由于只有一次日志，懷疑之后都走到了緩存。

證明過程

1.使用arthas看看sql是怎樣的

tt org.apache.ibatis.mapping.SqlSource getBoundSql '{params,returnObj,throwExp}'

拿出來的sql的確沒有LIMIT

TODO 待修改

打開sql日志，也有觀察到Limit語句，雖然只出現(xiàn)了一次，但說明是有分頁的。

因此：猜測1不成立。

2.查看PaginationInterceptor

PaginationInterceptor攔截的是StatementHandler#prepare，在prepare方法執(zhí)行的時(shí)候，才會(huì)添加Limit語句。而在調(diào)用添加Limit語句之前，已經(jīng)拿了緩存中的數(shù)據(jù)，不會(huì)真正執(zhí)行查詢了。

調(diào)用順序?yàn)椋?/li>

由上圖可以看出，當(dāng)生成cacheKey的時(shí)候，由于此時(shí)的boundSql還未被攔截，不含有Limit語句，每次boundSql都一樣，導(dǎo)致cacheKey都一樣。

因此：

只有第一次查詢會(huì)走不到緩存，然后被prepare階段被攔截，添加Limit語句后查詢數(shù)據(jù)庫。將數(shù)據(jù)放入一級(jí)緩存中。
第二次查詢開始，由于有事務(wù)，會(huì)嘗試?yán)靡患?jí)緩存中的數(shù)據(jù)，且cacheKey一樣，緩存有對(duì)應(yīng)的數(shù)據(jù)，就直接返回了緩存中的數(shù)據(jù)。

生成緩存key

  public <E> List<E> query(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler) throws SQLException {
    BoundSql boundSql = ms.getBoundSql(parameter);
    CacheKey key = createCacheKey(ms, parameter, rowBounds, boundSql);
    return query(ms, parameter, rowBounds, resultHandler, key, boundSql);
 }

優(yōu)先查一級(jí)緩存，無緩存則查數(shù)據(jù)庫

 public <E> List<E> query(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql) throws SQLException {
    ErrorContext.instance().resource(ms.getResource()).activity("executing a query").object(ms.getId());
    if (closed) {
      throw new ExecutorException("Executor was closed.");
    }
    if (queryStack == 0 && ms.isFlushCacheRequired()) {
      clearLocalCache();
    }
    List<E> list;
    try {
      queryStack++;
      list = resultHandler == null ? (List<E>) localCache.getObject(key) : null;
      if (list != null) {
        handleLocallyCachedOutputParameters(ms, key, parameter, boundSql);
      } else {
        list = queryFromDatabase(ms, parameter, rowBounds, resultHandler, key, boundSql);
      }
    } finally {
      queryStack--;
    }
    if (queryStack == 0) {
      for (DeferredLoad deferredLoad : deferredLoads) {
        deferredLoad.load();
      }
      // issue #601
      deferredLoads.clear();
      if (configuration.getLocalCacheScope() == LocalCacheScope.STATEMENT) {
        // issue #482
        clearLocalCache();
      }
    }
    return list;
  }

添加Limit語句

/**
 * <p>
 * MYSQL 數(shù)據(jù)庫分頁語句組裝實(shí)現(xiàn)
 * </p>
 *
 * @author hubin
 * @since 2016-01-23
 */
public class MySqlDialect implements IDialect {

    @Override
    public String buildPaginationSql(String originalSql, long offset, long limit) {
        StringBuilder sql = new StringBuilder(originalSql);
        sql.append(" LIMIT ").append(offset).append(StringPool.COMMA).append(limit);
        return sql.toString();
    }
}