更新時(shí)間:2022-08-11 來(lái)源:黑馬程序員 瀏覽量:
在日常開發(fā)中經(jīng)常會(huì)使用分頁(yè)查詢操作,而分頁(yè)語(yǔ)句以及分頁(yè)對(duì)象的處理,對(duì)于程序員來(lái)說(shuō)是一個(gè)繞不開的小難題,雖然有很多Mybatis分頁(yè)插件可以簡(jiǎn)化部分步驟,但是使用起來(lái)依舊比較繁瑣。MybatisPlus的出現(xiàn),進(jìn)一步減低了進(jìn)行分頁(yè)操作的門檻。本文帶著大家學(xué)會(huì)使用MybatisPlus是分頁(yè)插件,并對(duì)其原理進(jìn)行一定的分析。接下來(lái)我們主要在Spring boot環(huán)境下看看如何使用MybatisPlus進(jìn)行分頁(yè)查詢。
關(guān)于分頁(yè)插件,我們還需要知道以下兩點(diǎn):
內(nèi)置分頁(yè)插件:MybatisPlus基于 MyBatis 物理分頁(yè),開發(fā)者無(wú)需關(guān)心具體操作,配置好插件之后,寫分頁(yè)等同于普通 List 查詢。
分頁(yè)插件支持多種數(shù)據(jù)庫(kù):支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多種數(shù)據(jù)庫(kù)。
1.MybatisPlus分頁(yè)快速入門
1.1準(zhǔn)備操作
我們將通過(guò)一個(gè)簡(jiǎn)單的 Demo 來(lái)闡述 MyBatis-Plus 的強(qiáng)大功能,在此之前,我們假設(shè)您已經(jīng):
- 擁有 Java 開發(fā)環(huán)境以及相應(yīng) IDE
- 初始化 Spring Boot項(xiàng)目
- 熟悉 Maven
- 已經(jīng)導(dǎo)入mybatisplus依賴,并完成相關(guān)配置信息。
現(xiàn)在有一張表 t_user 結(jié)構(gòu)如下
編寫實(shí)體類User:(使用lombok簡(jiǎn)化)
@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 完成分頁(yè)查詢需求
1.2.1 導(dǎo)入核心插件MybatisPlusInterceptor
由于mp分頁(yè)是基于插件產(chǎn)生,所以我們需要先 導(dǎo)入核心插件到springboot中。
@Configuration @MapperScan("com.itheima.mapper") public class MybatisPlusConfig { /** * 新的分頁(yè)插件,一緩和二緩遵循mybatis的規(guī)則,需要設(shè)置 MybatisConfiguration#useDeprecatedExecutor = false 避免緩存出現(xiàn)問題(該屬性會(huì)在舊插件移除后一同移除) */ @Bean public MybatisPlusInterceptor mybatisPlusInterceptor() { MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor(); // 配置分頁(yè)插件 interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL)); return interceptor; } @Bean public ConfigurationCustomizer configurationCustomizer() { return configuration -> configuration.setUseDeprecatedExecutor(false); } }
1.2.2 使用Mpper分頁(yè)查詢接口
// 根據(jù) entity 條件,查詢?nèi)坑涗洠ú⒎?yè)) IPage<T> selectPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper); // 根據(jù) Wrapper 條件,查詢?nèi)坑涗洠ú⒎?yè)) IPage<Map<String, Object>> selectMapsPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
實(shí)現(xiàn) 基本分頁(yè)查詢測(cè)試
@SpringBootTest class PageQueryTests { @Autowired private UserMapper userMapper; @Test void testSelectPage() { //當(dāng)前頁(yè)碼 int current = 2; //每頁(yè)條數(shù) int size = 2; //構(gòu)建 分頁(yè)構(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); //它會(huì)自動(dòng)完成 數(shù)據(jù)的封裝 并把查詢出來(lái)的數(shù)據(jù) 存儲(chǔ)到page對(duì)象的一個(gè)屬性中 // setRecords 把數(shù)據(jù)存到 Records 里面了 // 總條數(shù) 總頁(yè)數(shù) --page也有封裝 //獲取page的 Records屬性 List<User> records = page.getRecords();//當(dāng)前頁(yè)數(shù)據(jù) long total = page.getTotal();//總條數(shù) long pages = page.getPages();//總頁(yè)數(shù) System.out.println("當(dāng)前數(shù)據(jù)總共有:"+total); System.out.println("共"+pages+"頁(yè)"); System.out.println("當(dāng)前頁(yè)數(shù)據(jù):"+records); }
查詢結(jié)果如下
1.3 代碼套路總結(jié)
* 構(gòu)建分頁(yè)構(gòu)造器(需要傳遞分頁(yè)條件 current,size)
* 構(gòu)建條件構(gòu)造器(支持條件分頁(yè)查詢)
* 執(zhí)行查詢方法,完成查詢
* 解析查詢后結(jié)果
2.MybatisPlus原理分析
2.1 mybatisplus插件介紹
MybatisPlus核心插件 MybatisPlusInterceptor,基于該插件mp實(shí)現(xiàn)了豐富的特性,
該插件是核心插件,目前代理了 `Executor#query` 和 `Executor#update` 和 `StatementHandler#prepare` 方法。
也就是說(shuō)該插件可以對(duì)查詢的執(zhí)行,增刪改的執(zhí)行以及預(yù)處理對(duì)象進(jìn)行功能性的增強(qiáng)。
那么是如何對(duì)sql實(shí)現(xiàn)攔截增強(qiáng)的呢,我們就要研究一下該分頁(yè)插件的攔截器集合屬性。
private List<InnerInterceptor> interceptors = new ArrayList<>();
InnerInterceptor
我們提供的插件都將基于此接口來(lái)實(shí)現(xiàn)功能
目前已有的功能:s
- 自動(dòng)分頁(yè): PaginationInnerInterceptor
- 多租戶: TenantLineInnerInterceptor
- 動(dòng)態(tài)表名: DynamicTableNameInnerInterceptor
- 樂觀鎖: OptimisticLockerInnerInterceptor
- sql 性能規(guī)范: IllegalSQLInnerInterceptor
- 防止全表更新與刪除: BlockAttackInnerInterceptor
由上可知,如果想要研究分頁(yè)的實(shí)現(xiàn)原理就要研究分頁(yè)攔截器"<font color='red'>PaginationInnerInterceptor</font>"
2.2 PaginationInnerInterceptor 運(yùn)行原理
當(dāng)我們執(zhí)行該語(yǔ)句時(shí),會(huì)在執(zhí)行sql之前被攔截器攔截
userMapper.selectPage(page, wrapper);
先從我們?cè)趍ybatis-plus的配置說(shuō)起
我們對(duì) 分頁(yè)插件進(jìn)行攔截會(huì)發(fā)現(xiàn),當(dāng)我們執(zhí)行sql的時(shí)候mybatis-plus會(huì)對(duì)所有SQL語(yǔ)句進(jìn)行攔截并做各種判斷與附加操作,會(huì)進(jìn)入到Mybatis-Plus全局?jǐn)r截器.
下圖中是針對(duì)分頁(yè)情況下的特定操作
由82行可知,當(dāng)前sql執(zhí)行時(shí),被攔截器攔截,發(fā)現(xiàn)是查詢語(yǔ)句,就會(huì)先執(zhí)行winllDoQuery方法,其次做完在執(zhí)行 beforeQuery。
因?yàn)樵谂渲弥衝ew出來(lái)的是 PaginationInnerInterceptor 對(duì)象,所以這里的方法就會(huì)走該對(duì)象中的方法
從源碼中不難看出,此處對(duì)查詢參數(shù)做了提取并通過(guò)`ParameterUtils.findPage()`方法進(jìn)行了轉(zhuǎn)換判斷,繼續(xù)往里看:
可以看到方法中是提取`Map`類型參數(shù)中的`IPage`類型參數(shù)或者是直接傳入`IPage`類型的參數(shù)進(jìn)行提取,如果有則直接返回`IPage`類型的參數(shù),如果為空則返回null不進(jìn)行count查詢。
上面就是我們?cè)诳吹降腸ount查詢
那么在什么時(shí)候?qū)崿F(xiàn)的分頁(yè)查詢呢? 剛才在追蹤源碼的時(shí)候也發(fā)現(xiàn)了 winllDoQuery方法執(zhí)行完調(diào)用了 beforeQuery().`beforeQuery()`方法對(duì)分頁(yè)查詢進(jìn)行了攔截。
3.結(jié)束語(yǔ)
其實(shí)我們發(fā)現(xiàn),mybatisplus的分頁(yè)實(shí)現(xiàn)其實(shí)是借助了攔截器的攔截功能,在查詢之前進(jìn)行了兩次攔截,最終完成封裝操作,通過(guò)本文的介紹,你是否比之前更加清晰了呢。