教你手撕MybatisPlus分页原理

在日常开发中经常会使用分页查询操作,而分页语句以及分页对象的处理,对于程序员来说是一个绕不开的小难题，虽然有很多Mybatis分页插件可以简化部分步骤,但是使用起来依旧比较繁琐。MybatisPlus的出现,进一步减低了进行分页操作的门槛。本文带着大家学会使用MybatisPlus是分页插件，并对其原理进行一定的分析。接下来我们主要在Spring boot环境下看看如何使用MybatisPlus进行分页查询。

关于分页插件，我们还需要知道以下两点：

内置分页插件 ：MybatisPlus基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询.
分页插件支持多种数据库 ：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库

1.MybatisPlus分页快速入门

1.1准备操作

我们将通过一个简单的 Demo 来阐述 MyBatis-Plus 的强大功能，在此之前，我们假设您已经：

拥有 Java 开发环境以及相应 IDE
初始化 Spring Boot项目
熟悉 Maven
已经导入mybatisplus依赖,并完成相关配置信息.

现在有一张表 t_user 结构如下

编写实体类User:(使用lombok简化)


class="prettyprint hljs kotlin" style="padding: 0.5em; font-family: Menlo, Monaco, Consolas, "Courier New", monospace; color: rgb(68, 68, 68); border-radius: 4px; display: block; margin: 0px 0px 1.5em; font-size: 14px; line-height: 1.5em; word-break: break-all; overflow-wrap: break-word; white-space: pre; background-color: rgb(246, 246, 246); border: none; overflow-x: auto; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">@Data
@TableName("tb_user")
public class  User  { 
    //告知id是主键  采用的自增形式
    @TableId(type=  IdType.AUTO)
    private Long id;
    @TableField("user_name")
    private String userName;
 
    private String password;
 
    private String name;
 
    private Integer age;
 
    private String email;
}

编写 Mapper 包下的 UserMapper 接口


<pre class="prettyprint hljs php" style="padding: 0.5em; font-family: Menlo, Monaco, Consolas, "Courier New", monospace; color: rgb(68, 68, 68); border-radius: 4px; display: block; margin: 0px 0px 1.5em; font-size: 14px; line-height: 1.5em; word-break: break-all; overflow-wrap: break-word; white-space: pre; background-color: rgb(246, 246, 246); border: none; overflow-x: auto; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">public interface  UserMapper  extends  BaseMapper<User>  { 
 
}

1.2 完成分页查询需求

1.2.1 导入核心插件MybatisPlusInterceptor

由于mp分页是基于插件产生,所以我们需要先导入核心插件到springboot中.


class="prettyprint hljs java" style="padding: 0.5em; font-family: Menlo, Monaco, Consolas, "Courier New", monospace; color: rgb(68, 68, 68); border-radius: 4px; display: block; margin: 0px 0px 1.5em; font-size: 14px; line-height: 1.5em; word-break: break-all; overflow-wrap: break-word; white-space: pre; background-color: rgb(246, 246, 246); border: none; overflow-x: auto; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">@Configuration
@MapperScan("com.itheima.mapper")
public class  MybatisPlusConfig  { 
 
    /**
     * 新的分页插件,一缓和二缓遵循mybatis的规则,需要设置 MybatisConfiguration#useDeprecatedExecutor = false 避免缓存出现问题(该属性会在旧插件移除后一同移除)
     */
    @Bean
    public  MybatisPlusInterceptor  mybatisPlusInterceptor()  { 
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
                                        // 配置分页插件
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }
 
    @Bean
    public  ConfigurationCustomizer  configurationCustomizer()  { 
        return configuration -> configuration.setUseDeprecatedExecutor(false);
    }
}

1.2.2 使用Mpper分页查询接口


<pre class="prettyprint hljs dart" style="padding: 0.5em; font-family: Menlo, Monaco, Consolas, "Courier New", monospace; color: rgb(68, 68, 68); border-radius: 4px; display: block; margin: 0px 0px 1.5em; font-size: 14px; line-height: 1.5em; word-break: break-all; overflow-wrap: break-word; white-space: pre; background-color: rgb(246, 246, 246); border: none; overflow-x: auto; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">// 根据 entity 条件，查询全部记录（并翻页）
IPage<T> selectPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 根据 Wrapper 条件，查询全部记录（并翻页）
IPage> selectMapsPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

实现基本分页查询测试


class="prettyprint hljs java" style="padding: 0.5em; font-family: Menlo, Monaco, Consolas, "Courier New", monospace; color: rgb(68, 68, 68); border-radius: 4px; display: block; margin: 0px 0px 1.5em; font-size: 14px; line-height: 1.5em; word-break: break-all; overflow-wrap: break-word; white-space: pre; background-color: rgb(246, 246, 246); border: none; overflow-x: auto; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">@SpringBootTest
class  PageQueryTests  { 
    @Autowired
    private UserMapper userMapper;
 
    @Test
    void  testSelectPage()  { 
        //当前页码
        int current = 2;
        //每页条数
        int size = 2;
        //构建 分页构造器
        IPage page = new Page(current, size);
        //构建 条件构造器
        QueryWrapper wrapper = new QueryWrapper<>();
        wrapper.lt("age",23);
        //执行查询 
        userMapper.selectPage(page, wrapper);
        //它会自动完成 数据的封装 并把查询出来的数据 存储到page对象的一个属性中
        // setRecords  把数据存到 Records 里面了
        // 总条数  总页数 --page也有封装
        //获取page的 Records属性
        List records = page.getRecords();//当前页数据
        long total = page.getTotal();//总条数
        long pages = page.getPages();//总页数
 
        System.out.println("当前数据总共有:"+total);
        System.out.println("共"+pages+"页");
        System.out.println("当前页数据:"+records);
    }

查询结果如下

1.3 代码套路总结

构建分页构造器(需要传递分页条件 current,size)
构建条件构造器(支持条件分页查询)
执行查询方法,完成查询
解析查询后结果

2.MybatisPlus原理分析

2.1 mybatisplus插件介绍

MybatisPlus核心插件 MybatisPlusInterceptor,基于该插件mp实现了丰富的特性,

该插件是核心插件,目前代理了 Executor#query 和 Executor#update 和 StatementHandler#prepare 方法.

也就是说该插件可以对查询的执行,增删改的执行以及预处理对象进行功能性的增强.

那么是如何对sql实现拦截增强的呢,我们就要研究一下该分页插件的拦截器集合属性.

<pre class="prettyprint hljs php" style="padding: 0.5em; font-family: Menlo, Monaco, Consolas, "Courier New", monospace; color: rgb(68, 68, 68); border-radius: 4px; display: block; margin: 0px 0px 1.5em; font-size: 14px; line-height: 1.5em; word-break: break-all; overflow-wrap: break-word; white-space: pre; background-color: rgb(246, 246, 246); border: none; overflow-x: auto; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">private List<InnerInterceptor> interceptors = new ArrayList<>();pre>

InnerInterceptor

我们提供的插件都将基于此接口来实现功能

目前已有的功能:s

自动分页: PaginationInnerInterceptor
多租户: TenantLineInnerInterceptor
动态表名: DynamicTableNameInnerInterceptor
乐观锁: OptimisticLockerInnerInterceptor
sql 性能规范: IllegalSQLInnerInterceptor
防止全表更新与删除: BlockAttackInnerInterceptor

由上可知,如果想要研究分页的实现原理就要研究分页拦截器"PaginationInnerInterceptor"

2.2 PaginationInnerInterceptor 运行原理

当我们执行该语句时,会在执行sql之前被拦截器拦截

<pre class="prettyprint hljs less" style="padding: 0.5em; font-family: Menlo, Monaco, Consolas, "Courier New", monospace; color: rgb(68, 68, 68); border-radius: 4px; display: block; margin: 0px 0px 1.5em; font-size: 14px; line-height: 1.5em; word-break: break-all; overflow-wrap: break-word; white-space: pre; background-color: rgb(246, 246, 246); border: none; overflow-x: auto; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">userMapper.selectPage(page, wrapper);pre>

先从我们在mybatis-plus的配置说起