mybatis系列-tkmybatis-10-pagehelper分页原理及源码分析

最新推荐文章于 2024-05-19 18:26:58 发布
最新推荐文章于 2024-05-19 18:26:58 发布
阅读量1.1k 收藏 1
点赞数 1
分类专栏： Mybatis 文章标签： mybatis Pagehelper 源码分析
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u011923621/article/details/116499977
版权

最近在写Mybatis系列文章，pageHelper在物理分页上用的比较多，这里就通过源码对它的原理进行分析

tkmybatis源码版本：

<dependency>

    <groupId>com.github.pagehelper</groupId>

    <artifactId>pagehelper-spring-boot-starter</artifactId>

    <version>1.2.12</version>

</dependency>

目录

一、使用案例：

二、整体流程：

三、源码解析:

1、添加mybatis拦截器

    a、加载PageHelperAutoConfiguration配置

   b、添加mybatis拦截器

2、执行分页查询

    a、Page实例创建

 b、查询操作 

3、拦截器是怎么生效的

一、使用案例：

参考《003-数据库-tkmybatis-04-SpringBoot整合TkMybatis+PageHelper实现分页查询》

二、整体流程：

pageHelper实现物理分页的流程大概分为以下几步：

  • 在依赖包pagehelper-spring-boot-autoconfigure.jar中的spring.factories文件内默认配置了jar包被Spring加载后自动加载到容器中的配置类com.github.pagehelper.autoconfigure.PageHelperAutoConfiguration，这是一切的起点（可参考Spring如何通过SPI机制实现服务动态配置）

  • 在PageHelperAutoConfiguration配置类中的@PostConstruct方法里为mybatis的每一个SqlSessionFactory中的Configuration添加mybatis的拦截器

  • 执行查询操作

  • 调用拦截StatementHandler（Sql语法的构建处理）方法，按照物理库的不同重构SQL实现分页

  • 返回查询结果

 

三、源码解析:

 

1、添加mybatis拦截器

     像整体流程中说的那样，Spring加载pageHelper的时候，pageHelper会首先通过配置类PageHelperAutoConfiguration，向SqlSessionFactory添加mybatis的拦截器，我们来看下具体过程。

 

    a、加载PageHelperAutoConfiguration配置

        如下图所示，pagehelper-spring-boot-autoconfigure.jar中的spring.factories设置了org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.github.pagehelper.autoconfigure.PageHelperAutoConfiguration，所以Spring在加载该jar包的时候，就会将该PageHelperAutoConfiguration类作为一个配置bean加入到容器中。

   b、添加mybatis拦截器

        我们来分析下PageHelperAutoConfiguration类，看下是怎么添加拦截器的。如下图所示，PageHelperAutoConfiguration类注解有几个限制，必须存在SqlSessionFactory类的实例才会生效，在mybatis配置完成后才开始执行。

重点看下 @PostConstruct注解的方法，在该bean完成参数注入后，容器会调用该方法。

        注意这里会有多个SqlSessionFactory，像mybatis实现多数据源操作的时候，就会添加多个SqlSessionFactory。所以在PageHelper中会对每个SqlSessionFactory都添加拦截。

到这里，拦截器就添加完成了，拦截器内进行了什么操作，我们在查询的时候再分析。

 

2、执行分页查询

    a、Page实例创建

    下图就是我们执行分页查询时写的代码，PageHelper.startPage这个静态方法执行后，后续查询就会返回分页的结果。

跟进去startPage，看里面做了什么。

    如下图所示，startPage方法，创建了Page对象，然后通过setLocalPage方法，将该对象放到了ThreadLocal中（为了保证线程安全，即一个线程一个Page对象用于分页）

 b、查询操作 

        设置好了Page对象，这个对象是怎么用的呢，我们继续看执行查询操作的时候，发生了什么。以上一步截图中的List<Orders> result = ordersMapper.selectAll()查询为例。我们在第1步添加的拦截器PageInterceptor中的intercept方法添加断点，会发现，执行selectAll操作的时候，系统进到了拦截器中断点的位置，我们来看下，拦截器做了些什么。（拦截器是怎么生效的，即mybatis是怎么调用的该拦截器的intercept方法，这个复杂一点，我们放到最后说，先看下intercept方法里做了些什么）

        intercept的操作如下图所示，这里可以看到，Page是否设置，影响着我们是否进行分页。另外有一个需要注意，在查询总数的时候，即count函数里面，PageHelper会根据MappedStatement的Id和"_COUNT"后缀，创建唯一的标识countMsId，如果查询条件没有改变（分页条件除外），则该countMsId是一样的，PageHelper会将count查询的结果用countMsId作为key存在Map中，供下次查询使用，从而避免每次分页查询的时候都去在数据库中重新计算count的值。

    再进一步看下pageQuery中是如何进行分页的。

在生成pageSql的时候，系统会根据数据库类型，选择不同的dialect进行pageSql的创建，比如我们这里用的是MySqlDialect。pageSql创建好后，后面执行的分页查询executor.query这些就是mybatis的查询操作了，我们这里就不细讲。

至此，我们就完成了查询Sql的修改以及分页查询。

3、拦截器是怎么生效的

        在第2步中，还有个遗留问题，拦截器是怎么生效的？其实这部分属于mybatis的内容，这里简单分析一下。回看下第1步，在下面的函数中，pageHelper添加了拦截器。

我们分析下addInterceptor方法所属的类，该类中还有个pluginAll方法。该方法会在执行SQL的时候调用。我们知道，每次执行SQL，mybatis都会为该操作生成一个sqlsession的对象，sqlsession对象生成时会生成一个executor（sql的实际执行类，在前面我们也能看见，改造后的分页sql就是用该类的方法来执行实际查询的），在生成executor的时候，mybatis会依次调用interceptors中添加的拦截器（注意这个拦截器不是spring的拦截器）的plugin方法，对executor进行处理。

我们继续看下PageInterceptor这个PageHelper的拦截器，在plugin方法中做了什么。

如下图，在wrap方法中，创建了executor的代理类Plugin（可以参考JDK动态代理是如何实现的）。

executor在执行Sql处理的时候，就会跳转到Plugin的invoke方法中，返回该方法的结果。invoke方法如下，因为在创建代理类Plugin时就把PageInterceptor传入了进去，所以在invoke方法中，就实现了PageInterceptor的intercept方法对SQL操作进行处理。至此就解决了拦截器是怎么生效的问题，后续的intercept的内容，就是第2步b部分的内容了。

 

 

 

 

 

 

 

 

 

 

 

 

 

 

tinygodd
关注
  • 1
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
mybatis自动生成代码分页功能 mysql 数据库
03-27
NULL 博文链接：https://smallbee.iteye.com/blog/1155167
mybatis-plus-boot-starter-3.1.0.jar
04-13
mybatis-plus-boot-starter.jar 各个版本下载， ...Mybatis-Plus（简称MP）是一个基于MyBatis的增强工具库，它简化了与数据库的交互操作并提供了一系列增强功能，使开发者能够更加方便快捷地进行数据库访问。
tk-mybatis使用介绍，springboot整合tk-mybatis、PageHelper实现分页查询
沐雨橙风ιε的博客
08-15 2747
目录第一步：准备数据库第二步：创建一个springboot项目 第三步：添加tk-mybatis的依赖第四步：修改配置文件第五步：创建数据库表对应的实体类第六步：持久层接口继承自Mapper接口第七步：使用tk-mybatis的API完成crud扩展：使用tk-mybatis整合PageHelper实现分页查询1、添加PageHelper依赖2、设置分页拦截器3、在所有代码之前开启分页创建数据库tkmybatis，然后执行以下脚本，为了方便起见，使用之前文章用的数据，也是我的歌单。 本篇文章将创建一个名
tk.mybatis零sql语句单表分页查询
最新发布
qiqin5978的博客
05-19 227
【代码】tk.mybatis零sql语句单表分页查询。
TK-MyBatis 分页查询
冉野 、
08-10 2万+
记 tkMybatis 查询出一个  List集合 该集合已经做好了一层分页Page封装 即查询出的list 使用类型判断 instanceof Page 为true 但是，中途不明白这是一个带分页的集合，把查询出的结果集又做了一层封装 需要返回的对象类型为GoodsCategoryDTO，代码如下：     // 商品集合              List&lt;GoodsCategory...
Java 之 tk.mybatis生成器与 sql 分页查询
yin__ren的博客
09-07 1787
一、前言 三种分页的实现方式： 每次取查询结果的所有数据，然后根据页面显示指定的记录 根据页面只取一页的数据，然后显示这一页，这里要构造 sql 语句 取一定页数的数据，就是前两种的折中 实现分页的步骤： 创建一个用于封装分页相关属性及操作的类 从页面增加分页导航条的功能 实现分页查询功能，从页面请求->Servlet->DAO的实现 二、自定义实现 1、借助数组分页(先查询所有数据，再分页) 原理：先获取数据库中所有满足条件的记录，保存在应用的临时数组中，再通过 List 的
完成对List操作后，再手动使用PageInfo对List进行分页，保证分页信息正确
YHY的日常
09-15 1080
/** * pagehelper手动分页 * @param currentPage 当前页 * @param pageSize * @param list * @param <T> * @return */ public static <T> PageInfo<T> getPageInfo(int currentPage, int pageSize, List<T> list) {
mybatis-plus源码（mybatis-plus-3.5.1.zip）
03-03
此源码包`mybatis-plus-3.5.1.zip`包含了MyBatis-Plus 3.5.1版本的全部源代码，有助于我们深入理解其内部实现机制和工作原理。 MyBatis-Plus的主要功能包括： 1. **CRUD操作**：MyBatis-Plus提供了简化版的CRUD...
Mybatis-PageHelper:Mybatis通用分页插件
05-10
MyBatis Pagination - PageHelper If you are using MyBatis, it is recommended to try this pagination plugin. This must be the MOST CONVENIENT pagination plugin. PageHelper supports any complex single-...
Mybatis PageHelper分页插件-其他
06-12
Mybatis PageHelper分页插件是一个应用于Mybatis中的分页插件系统。 如果你也在用Mybatis，建议尝试该分页插件，这一定是一个非常方便使用的分页插件。 该插件目前支持以下数据库的物理分页： 1、Oracle 2、Mysql 3...
mybatis-3.5.9 源码（mybatis-3-mybatis-3.5.9.zip）
02-07
MyBatis 是一款著名的持久层框架...通过对 MyBatis-3.5.9 源码的阅读和分析，我们可以深入了解其实现原理，为日常开发和性能优化提供有力支持。同时，这也有助于我们更好地理解和定制 MyBatis，使其更加符合项目需求。
Mybatis分页方式详解
深圳市多克创新科技有限公司
02-13 5834
Mybatis分页方式详解
TkMyBatis PageHelper
tiancxz的专栏
02-02 1239
tk.mybatis 是在 MyBatis 框架的基础上提供了很多工具，让开发更加高效 POM 在pom.xml文件中引入mapper-spring-boot-starter依赖，该依赖会自动引入 MyBaits 相关依赖 <dependency> <groupId>tk.mybatis</groupId> <artifac...
tk.mybatis复杂and，or条件查询，排序和PageHelper分页注意的点
Seven71111的博客
03-19 3749
补充几个点 like方法前后不会自动补(%xxx%)百分号 一个weekendCriteria或者一个criteria为一个括号 mysql分页页数索引下标从0开始，limit(pageNum,pageSize) mysql插件pagehelper分页的pageNum区别于mysql，pagehelper的pageNum是指第几页的数据 栗子：数据库里五条数据：1,2,3,4,5 ...
tkmybatis 分页条件查询 自定义语句
weixin_37763484的博客
08-01 6698
比较简单的tkmybatis使用入门，配置比较少，可以直接用。 数据： SET FOREIGN_KEY_CHECKS=0; -- ---------------------------- -- Table structure for test -- ---------------------------- DROP TABLE IF EXISTS `test`; CREATE TABLE `test` ( `id` int(11) NOT NULL AUTO_INCREMENT, `userna
Mybatis实现分页查询
热门推荐
weixin_45939128的博客
11-17 2万+
Mybatis实现分页查询
Mybatis之分页查询
rua的博客
06-30 2116
mybatis分页查询
mybatis实现分页查询（两种方式：1pageHelper插件 2手写）
丨康有为丨的博客
12-20 2316
mybatis实现分页查询（两种方式：1pageHelper插件 2手写）
Mybatis 分页查询(实战版)
qq_46703281的博客
11-08 3021
mybati或mybatis-plus借助Sql语句进行分页查询
spring boot整合mybatis-plus和pagehelper分页插件,附项目源码
08-09
spring boot整合mybatis-plus和pagehelper分页插件是一种常见的开发方式，可以实现数据库的分页查询功能。下面是一个简单示例项目的源码，以供参考： 首先，需要在pom.xml文件中添加相关依赖： ```xml <dependencies> <!-- Spring Boot --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency> <!-- MyBatis Plus --> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.4.0</version> </dependency> <!-- PageHelper --> <dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper-spring-boot-starter</artifactId> <version>1.3.0</version> </dependency> <!-- MySQL Connector --> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>8.0.27</version> </dependency> </dependencies> ``` 在application.properties（或application.yml）文件中配置数据库连接信息： ```yaml spring.datasource.url=jdbc:mysql://localhost:3306/mydatabase spring.datasource.username=root spring.datasource.password=123456 spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver mybatis-plus.configuration.map-underscore-to-camel-case=true ``` 创建一个简单的实体类User： ```java public class User { private Long id; private String username; private String password; // 省略getter和setter方法 } ``` 创建一个Mapper接口UserMapper： ```java @Mapper public interface UserMapper extends BaseMapper<User> { // 省略其他方法 List<User> getUsersByPage(Page<User> page, @Param("username") String username); } ``` 创建一个Service接口UserService以及其实现类UserServiceImpl： ```java @Service public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService { @Autowired private UserMapper userMapper; @Override public IPage<User> getUsersByPage(Page<User> page, String username) { return userMapper.getUsersByPage(page, username); } } ``` 在Controller中注入UserService，并进行分页查询操作： ```java @RestController public class UserController { @Autowired private UserService userService; @GetMapping("/users") public IPage<User> getUsers(@RequestParam(value = "page", defaultValue = "1") Integer pageNum, @RequestParam(value = "size", defaultValue = "10") Integer pageSize, @RequestParam(value = "username", required = false) String username) { Page<User> page = new Page<>(pageNum, pageSize); return userService.getUsersByPage(page, username); } } ``` 至此，就完成了spring boot整合mybatis-plus和pagehelper分页插件的配置和使用。 请注意，这是一个简单示例项目，实际使用中可能需要根据需求进行适当调整和修改。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值