若依框架的startPage( )函数怎么自动关联查询SQL语句？

2023-09-28 09:29 由 Mysticbinary 发表于 #后端开发

Question Description

使用JAVA语言的若依框架的时候，发现只要使用了startPage()函数, 并不需要前端传递分页的数据，也不需要注解，就能完成分页功能。预判他应该是使用类似拦截器的机制，但还是感觉很神奇，感觉知道个大概不过瘾，还是要更细致的了解才能满足，就想研究一下并记录下来。

/**
 * 查询test用户管理列表
 */
@RequiresPermissions("user:manage:list")
@PostMapping("/list")
@ResponseBody
public TableDataInfo list(TUser tUser)
{
    startPage();
    // 获取 t_table1 表数据
    List<T_table1> list = T_table1Service.selectT_table1List(new T_table1());
    return getDataTable(list);
}

开启 startPage（）函数
17:43:42.395 [http-nio-80-exec-26] DEBUG c.r.k.m.T.selectTProductList - [debug,137] - ==>  Preparing: select * from t_table1 LIMIT ?
17:43:42.396 [http-nio-80-exec-26] DEBUG c.r.k.m.T.selectTProductList - [debug,137] - ==> Parameters: 10(Integer)
17:43:42.429 [http-nio-80-exec-26] DEBUG c.r.k.m.T.selectTProductList - [debug,137] - <==      Total: 10

关掉 startPage（）函数
17:53:13.356 [http-nio-80-exec-12] DEBUG c.r.k.m.T.selectTProductList - [debug,137] - ==>  Preparing: select * from t_table1
17:53:13.357 [http-nio-80-exec-12] DEBUG c.r.k.m.T.selectTProductList - [debug,137] - ==> Parameters: 
17:53:13.371 [http-nio-80-exec-12] DEBUG c.r.k.m.T.selectTProductList - [debug,137] - <==      Total: 53

使用startPage()之后，去执行SQL查询的语句就会不同，那么问题来了，他是怎么关联上查询语句的？ , 怎么能自动的给查询语句自动加上 LIMIT 条件的 ?

Principle

若依框架（RuoYi）是一个WEB框架，主要作用是用于开发后台管理系统，该框架内置了一些常用的功能模块，比如 分页功能、...。

若依框架中的分页功能是通过使用 MyBatis 分页插件实现的。MyBatis 是一款流行的持久层框架，它提供了对数据库的访问和操作功能，并且支持插件扩展。

在若依框架中，当你调用 startPage() 函数时，它会利用 MyBatis 分页插件拦截 SQL 查询语句，并自动解析出分页相关的信息，如当前页码、每页显示的记录数等。然后，它会在查询语句中添加相应的 SQL 片段，实现分页查询。

具体而言，startPage() 函数会将分页信息存储在一个线程本地的 PageHelper 对象中。该对象使用了线程本地变量，确保每个线程独立维护自己的分页信息，避免了多线程并发时的混淆。

当执行数据库查询时，分页插件会拦截查询语句，根据 PageHelper 对象中保存的分页信息，动态生成对应的分页 SQL，并在查询数据库时应用该 SQL，从而只返回分页后的结果数据。

总结一下，若依框架的分页功能是通过 MyBatis 分页插件实现的。它利用了 MyBatis 拦截器机制，在查询语句执行前动态生成分页 SQL，从而在不需要前端传递分页数据和注解的情况下，实现了简便的分页功能。

Reference

若依官网——分页实现
https://doc.ruoyi.vip/ruoyi/document/htsc.html#分页实现

若依框架---分页功能
https://blog.51cto.com/u_15949848/6056021

童小纯呀若依框架---PageHelper分页(一) ~ （十五）
https://blog.51cto.com/search/user?uid=15939848&q=若依框架---PageHelper分页