Java培訓：手撕MybatisPlus分頁原理

　　在日常開發(fā)中經(jīng)常會使用分頁查詢操作,而分頁語句以及分頁對象的處理,對于程序員來說是一個繞不開的小難題，雖然有很多Mybatis分頁插件可以簡化部分步驟,但是使用起來依舊比較繁瑣。MybatisPlus的出現(xiàn),進一步減低了進行分頁操作的門檻。本文帶著大家學會使用MybatisPlus是分頁插件，并對其原理進行一定的分析。接下來我們主要在Spring boot環(huán)境下看看如何使用MybatisPlus進行分頁查詢。

　　關于分頁插件，我們還需要知道以下兩點：

　　內(nèi)置分頁插件：MybatisPlus基于 MyBatis 物理分頁，開發(fā)者無需關心具體操作，配置好插件之后，寫分頁等同于普通 List 查詢。

　　分頁插件支持多種數(shù)據(jù)庫：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多種數(shù)據(jù)庫。

       1.MybatisPlus分頁快速入門

　　1.1準備操作

　　我們將通過一個簡單的 Demo 來闡述 MyBatis-Plus 的強大功能，在此之前，我們假設您已經(jīng)：

　　- 擁有 Java 開發(fā)環(huán)境以及相應 IDE

　　- 初始化 Spring Boot項目

　　- 熟悉 Maven

　　- 已經(jīng)導入mybatisplus依賴,并完成相關配置信息。

　　現(xiàn)在有一張表 t_user 結(jié)構(gòu)如下

　　編寫實體類User:(使用lombok簡化)

@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`接口

public interface UserMapper extends BaseMapper<User> {

}

　　~~~

　　1.2 完成分頁查詢需求

　　1.2.1 導入核心插件MybatisPlusInterceptor

　　由于mp分頁是基于插件產(chǎn)生,所以我們需要先 導入核心插件到springboot中。

@Configuration
@MapperScan("com.itheima.mapper")
public class MybatisPlusConfig {

    /**
     * 新的分頁插件,一緩和二緩遵循mybatis的規(guī)則,需要設置 MybatisConfiguration#useDeprecatedExecutor = false 避免緩存出現(xiàn)問題(該屬性會在舊插件移除后一同移除)
     */
    @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分頁查詢接口

// 根據(jù) entity 條件，查詢?nèi)坑涗洠ú⒎摚?
IPage<T> selectPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 根據(jù) Wrapper 條件，查詢?nèi)坑涗洠ú⒎摚?
IPage<Map<String, Object>> selectMapsPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

　　實現(xiàn) 基本分頁查詢測試

@SpringBootTest
class PageQueryTests {
    @Autowired
    private UserMapper userMapper;

    @Test
    void testSelectPage() {
        //當前頁碼
        int current = 2;
        //每頁條數(shù)
        int size = 2;
        //構(gòu)建 分頁構(gòu)造器
        IPage<User> page = new Page(current, size);
        //構(gòu)建 條件構(gòu)造器
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.lt("age",23);
        //執(zhí)行查詢 
        userMapper.selectPage(page, wrapper);
        //它會自動完成 數(shù)據(jù)的封裝 并把查詢出來的數(shù)據(jù) 存儲到page對象的一個屬性中
        // setRecords  把數(shù)據(jù)存到 Records 里面了
        // 總條數(shù)  總頁數(shù) --page也有封裝
        //獲取page的 Records屬性
        List<User> records = page.getRecords();//當前頁數(shù)據(jù)
        long total = page.getTotal();//總條數(shù)
        long pages = page.getPages();//總頁數(shù)

        System.out.println("當前數(shù)據(jù)總共有:"+total);
        System.out.println("共"+pages+"頁");
        System.out.println("當前頁數(shù)據(jù):"+records);
    }

　　
       查詢結(jié)果如下

　　
       1.3 代碼套路總結(jié)

　　* 構(gòu)建分頁構(gòu)造器(需要傳遞分頁條件 current,size)

　　* 構(gòu)建條件構(gòu)造器(支持條件分頁查詢)

　　* 執(zhí)行查詢方法,完成查詢

　　* 解析查詢后結(jié)果

　　2.MybatisPlus原理分析

　　2.1 mybatisplus插件介紹

　　MybatisPlus核心插件 MybatisPlusInterceptor,基于該插件mp實現(xiàn)了豐富的特性,

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

　　也就是說該插件可以對查詢的執(zhí)行,增刪改的執(zhí)行以及預處理對象進行功能性的增強。

　　那么是如何對sql實現(xiàn)攔截增強的呢,我們就要研究一下該分頁插件的攔截器集合屬性。

private List<InnerInterceptor> interceptors = new ArrayList<>();

　　InnerInterceptor

　　我們提供的插件都將基于此接口來實現(xiàn)功能

　　目前已有的功能:s

　　- 自動分頁: PaginationInnerInterceptor

　　- 多租戶: TenantLineInnerInterceptor

　　- 動態(tài)表名: DynamicTableNameInnerInterceptor

　　- 樂觀鎖: OptimisticLockerInnerInterceptor

　　- sql 性能規(guī)范: IllegalSQLInnerInterceptor

　　- 防止全表更新與刪除: BlockAttackInnerInterceptor

　　由上可知,如果想要研究分頁的實現(xiàn)原理就要研究分頁攔截器"<font color='red'>PaginationInnerInterceptor</font>"

　　2.2 PaginationInnerInterceptor 運行原理

　　當我們執(zhí)行該語句時,會在執(zhí)行sql之前被攔截器攔截

userMapper.selectPage(page, wrapper);

　　先從我們在mybatis-plus的配置說起

　　我們對 分頁插件進行攔截會發(fā)現(xiàn),當我們執(zhí)行sql的時候mybatis-plus會對所有SQL語句進行攔截并做各種判斷與附加操作,會進入到Mybatis-Plus全局攔截器.

　　下圖中是針對分頁情況下的特定操作

　　由82行可知,當前sql執(zhí)行時,被攔截器攔截,發(fā)現(xiàn)是查詢語句,就會先執(zhí)行winllDoQuery方法,其次做完在執(zhí)行 beforeQuery。

　　因為在配置中new出來的是 PaginationInnerInterceptor 對象,所以這里的方法就會走該對象中的方法

　　從源碼中不難看出,此處對查詢參數(shù)做了提取并通過`ParameterUtils.findPage()`方法進行了轉(zhuǎn)換判斷，繼續(xù)往里看:

　　可以看到方法中是提取`Map`類型參數(shù)中的`IPage`類型參數(shù)或者是直接傳入`IPage`類型的參數(shù)進行提取，如果有則直接返回`IPage`類型的參數(shù)，如果為空則返回null不進行count查詢。

　　上面就是我們在看到的count查詢

　　那么在什么時候?qū)崿F(xiàn)的分頁查詢呢? 剛才在追蹤源碼的時候也發(fā)現(xiàn)了 winllDoQuery方法執(zhí)行完調(diào)用了 beforeQuery().`beforeQuery()`方法對分頁查詢進行了攔截。

　　3.結(jié)束語

　　其實我們發(fā)現(xiàn),mybatisplus的分頁實現(xiàn)其實是借助了攔截器的攔截功能,在查詢之前進行了兩次攔截,最終完成封裝操作，通過本文的介紹，你是否比之前更加清晰了呢。