如何實現一個mybaits 分頁外掛

yangrd發表於2021-12-08

前言:

在java web專案中經常會用到分頁這個功能,而以常用的的持久層框架mybatis為例,並沒有提供原生的物理分頁功能相關介面,不過mybaits 提供了相應的外掛功能可以方便我們做一些相應的擴充套件 ,這裡我們資料庫選為mysql ,一般情況下會直接使用第三放的外掛 如 mybatis-helper , mybatis-plus ,他們都提供了分頁這個功能,知其然知其所以然,如果不使用這些類庫我們要如何做呢?

實現:

首先在mysql講到分頁我們會想到limit 關鍵字;然後呢前臺用到分頁 還需要有一個總頁數 ,總頁數的背後是總條數和每頁多少條;關鍵點:通過外掛實現 分頁+總條數
這是一個簡單的demo

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.RequiredArgsConstructor;
import lombok.experimental.Delegate;
import org.apache.ibatis.binding.MapperMethod;
import org.apache.ibatis.cache.CacheKey;
import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.mapping.ParameterMapping;
import org.apache.ibatis.plugin.Interceptor;
import org.apache.ibatis.plugin.Intercepts;
import org.apache.ibatis.plugin.Invocation;
import org.apache.ibatis.plugin.Signature;
import org.apache.ibatis.session.ResultHandler;
import org.apache.ibatis.session.RowBounds;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Component;

import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.List;
import java.util.stream.Collectors;

/**
 * @author yangrd
 * @date 2021/12/7
 */
@RequiredArgsConstructor

@Component
@Intercepts({@Signature(
        type = Executor.class,
        method = "query",
        args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class, CacheKey.class, BoundSql.class})})
public class MyTestInterceptor implements Interceptor {

    private final JdbcTemplate jdbcTemplate;

    @Override
    public Object intercept(Invocation invocation) throws Throwable {

        BoundSql boundSql = (BoundSql) invocation.getArgs()[5];

        String tempSql = boundSql.getSql();

        MapperMethod.ParamMap<Object> parameterObject = (MapperMethod.ParamMap<Object>) boundSql.getParameterObject();
        List<String> argNames = boundSql.getParameterMappings().stream().map(ParameterMapping::getProperty).collect(Collectors.toList());
        Object[] args = argNames.stream().map(parameterObject::get).toArray();

        Long count = count(tempSql, args);

        Field field = BoundSql.class.getDeclaredField("sql");
        field.setAccessible(true);
        field.set(boundSql, String.format("%s limit 1, 10", tempSql));

        return Page.of(count, (ArrayList<?>) invocation.proceed());
    }

    @Data
    @AllArgsConstructor(staticName = "of")
    public static class Page<T> implements List<T> {

        private Long total;

        @Delegate
        private List<T> list;

    }

    private Long count(String tempSql, Object[] args) {

        String countSql = String.format("select count(*) from (%s) t", tempSql);
        return jdbcTemplate.queryForObject(countSql, Long.class, args);
    }
}

總結:

這是一個極其簡單的demo 權當拋磚引玉 ,如判斷是否需要分頁、第幾頁、 每頁多條數這些地方還需要完善,但它向我們展示了 mybatis中如何分頁的核心原理,我想我們在這裡結束了這個示例,但在這個示例之外如果能給你帶來一些思考自然是極好的。

相關文章