介绍一下 PageHelper 实现分页原理，39. MyBatis-Plus的分页插件如何使用？与MyBatis的分页实现有何不同？

PageHelper 是一个基于 MyBatis 的分页插件，其实现分页的原理主要通过 MyBatis 的拦截器机制来完成。

以下是 PageHelper 实现分页的详细原理：

1. 拦截器机制

PageHelper 实现了 MyBatis 的 Interceptor 接口，通过拦截器机制对 SQL 语句进行拦截和处理。

在执行查询之前，PageHelper 会自动将下一次查询作为分页查询处理。

2. 分页参数存储

  • • 调用 PageHelper 的 startPage 方法时，会创建一个 Page 对象，将分页参数（如当前页码 pageNum 和每页显示条数 pageSize）设置到这个 Page 对象中。

  • • 这个 Page 对象会被存储到当前线程的 ThreadLocal 变量中，以确保分页参数的安全性和准确性。

3. SQL 语句拦截与修改

  • • 当 MyBatis 执行查询时，PageHelper 的拦截器会拦截到 SQL 查询语句。

  • • 在拦截器中，PageHelper 会获取到 ThreadLocal 中保存的分页参数。

  • • 根据分页参数和数据库类型（通过方言 Dialect 来适配不同的数据库），PageHelper 会自动修改原始的 SQL 语句，添加分页相关的 SQL 片段（如 LIMIT 语句）来实现分页功能。

4. 执行分页查询

  • • 修改后的分页 SQL 语句会被执行，返回分页结果。

  • • 分页结果会被封装到 Page 对象中，包括查询到的数据列表、总记录数等信息。

5. 获取分页结果

  • • 开发者可以通过 Page 对象或将其转换为 PageInfo 对象来获取分页查询的结果，包括总记录数、总页数、当前页数据等。

6. 清理 ThreadLocal 变量

  • • 在查询结束后，PageHelper 通常会清理 ThreadLocal 中保存的分页参数，避免对其他查询造成干扰。

7. 自定义与配置

  • • PageHelper 提供了丰富的配置选项和自定义功能，如是否支持带有“for update”的查询语句、是否支持嵌套查询等。

  • • 开发者可以通过配置文件或注解等方式来灵活配置和使用 PageHelper。

示例讲解

1. 引入依赖

首先，在 Spring Boot 项目的 pom.xml 文件中引入必要的依赖，包括 MyBatis-Plus、PageHelper 和数据库驱动等。

 
  1. <dependencies>
  2.     <!-- Spring Boot 相关依赖 -->
  3.     <dependency>
  4.         <groupId>org.springframework.boot</groupId>
  5.         <artifactId>spring-boot-starter</artifactId>
  6.     </dependency>
  7.     <dependency>
  8.         <groupId>org.springframework.boot</groupId>
  9.         <artifactId>spring-boot-starter-data-jpa</artifactId>
  10.     </dependency>
  11.     
  12.     <!-- MyBatis-Plus 依赖 -->
  13.     <dependency>
  14.         <groupId>com.baomidou</groupId>
  15.         <artifactId>mybatis-plus-boot-starter</artifactId>
  16.     </dependency>
  17.     
  18.     <!-- PageHelper 依赖 -->
  19.     <dependency>
  20.         <groupId>com.github.pagehelper</groupId>
  21.         <artifactId>pagehelper-spring-boot-starter</artifactId>
  22.     </dependency>
  23.     
  24.     <!-- 数据库驱动依赖，以 MySQL 为例 -->
  25.     <dependency>
  26.         <groupId>mysql</groupId>
  27.         <artifactId>mysql-connector-java</artifactId>
  28.     </dependency>
  29. </dependencies>
 

2. 配置 PageHelper

在 application.yml 或 application.properties 文件中配置 PageHelper 的相关参数。

 
  1. # application.yml 示例
  2. pagehelper:
  3.   helperDialect: mysql
  4.   reasonable: true
  5.   supportMethodsArguments: true
  6.   params: count=countSql
 

3. 创建 Mapper 接口和实体类

假设有一个 User 实体类，对应的 Mapper 接口如下：

 
  1. // User.java - 实体类
  2. public class User {
  3.     private Long id;
  4.     private String name;
  5.     // ... 其他字段和 getter/setter 方法
  6. }
  7.  
  8. // UserMapper.java - Mapper 接口
  9. @Mapper
  10. public interface UserMapper {
  11.     // 这里不需要编写分页相关的 SQL 语句
  12.     List<User> selectUserList();
  13. }
 

4. 编写 Service 层代码

在 Service 层中使用 PageHelper 进行分页查询。

 
  1. @Service
  2. public class UserService {
  3.     @Autowired
  4.     private UserMapper userMapper;
  5.  
  6.     public PageInfo<User> selectUserPage(int pageNum, int pageSize) {
  7.         // 开始分页，设置分页参数
  8.         PageHelper.startPage(pageNum, pageSize);
  9.  
  10.         // 执行查询，注意这里调用的是 Mapper 接口中的普通查询方法
  11.         List<User> userList = userMapper.selectUserList();
  12.  
  13.         // 使用 PageInfo 包装查询结果
  14.         PageInfo<User> pageInfo = new PageInfo<>(userList);
  15.  
  16.         return pageInfo;
  17.     }
  18. }
 

5. 编写 Controller 层代码

在 Controller 层中调用 Service 层的方法进行分页查询，并返回结果。

 
  1. @RestController
  2. @RequestMapping("/user")
  3. public class UserController {
  4.     @Autowired
  5.     private UserService userService;
  6.  
  7.     @GetMapping("/page")
  8.     public PageInfo<User> getUserPage(@RequestParam int pageNum, @RequestParam int pageSize) {
  9.         return userService.selectUserPage(pageNum, pageSize);
  10.     }
  11. }
 

6. 分页原理讲解

在这个示例中，PageHelper 的分页原理如下：

  1. 1. 拦截器机制：PageHelper 注册为一个 MyBatis 拦截器，当 MyBatis 执行查询操作时，会触发这个拦截器。

  2. 2. 分页参数存储：调用 PageHelper.startPage(pageNum, pageSize) 方法时，PageHelper 会创建一个 Page 对象，将分页参数设置到这个对象中，并将其存储到当前线程的 ThreadLocal 变量中。

  3. 3. SQL 语句拦截与修改：当 MyBatis 执行查询操作时，PageHelper 的拦截器会拦截到即将执行的 SQL 语句。拦截器会获取到 ThreadLocal 中保存的分页参数，并根据这些参数和数据库类型（通过方言 Dialect 来适配），自动修改原始的 SQL 语句，添加分页相关的 SQL 片段（如 LIMIT 语句）。

  4. 4. 执行分页查询：修改后的分页 SQL 语句会被执行，返回分页结果。这个结果是一个包含查询到的数据列表的集合。

  5. 5. 查询总记录数（可选）：PageHelper 默认会在执行分页查询之前，先执行一个 count 查询来获取总记录数。这个 count 查询是通过修改原始 SQL 语句为 count(*) 查询来实现的。获取到的总记录数会被设置到 Page 对象中。

  6. 6. 返回分页结果：执行完分页查询后，PageHelper 会将分页结果封装到 Page 对象中。开发者通常会将 Page 对象转换为 PageInfo 对象，以便获取到更丰富的分页信息（如总记录数、总页数、当前页码等）。

  7. 7. 清理 ThreadLocal 变量：在查询结束后，PageHelper 会清理 ThreadLocal 中保存的分页参数，避免对其他查询造成干扰。

MyBatis-Plus 提供了一个强大的分页插件，极大简化了分页查询的实现。与 MyBatis 传统的分页实现方式相比，MyBatis-Plus 的分页插件具有使用方便、性能好、支持多数据库等优点。

 

MyBatis-Plus 的分页插件如何使用？

 

1. 配置分页插件

要使用 MyBatis-Plus 的分页插件，首先需要在 MyBatis-Plus 的配置中注册分页插件。在 Spring Boot 项目中，可以通过配置类注册分页插件。

示例配置类：

 

 
  1. import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
  2. import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
  3. import org.springframework.context.annotation.Bean;
  4. import org.springframework.context.annotation.Configuration;
  5. ​
  6. @Configuration
  7. public class MyBatisPlusConfig {
  8. ​
  9.   @Bean
  10.   public MybatisPlusInterceptor mybatisPlusInterceptor() {
  11.       MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
  12.       interceptor.addInnerInterceptor(new PaginationInnerInterceptor());
  13.       return interceptor;
  14.   }
  15. }
 

  • MybatisPlusInterceptor：MyBatis-Plus 的插件管理器。

  • PaginationInnerInterceptor：分页插件，支持多种数据库（如 MySQL、PostgreSQL、Oracle 等），自动识别数据库类型并生成相应的分页查询语句。

 

2. 使用分页插件进行查询

MyBatis-Plus 提供了 Page 对象，用于封装分页参数和结果。你只需要在 Mapper 接口的方法中传入 Page 对象，MyBatis-Plus 就会自动生成分页 SQL 并返回分页结果。

示例：

假设我们有一个 UserMapper 接口用于查询用户数据：

 

 
  1. import com.baomidou.mybatisplus.core.mapper.BaseMapper;
  2. import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
  3. import org.apache.ibatis.annotations.Param;
  4. import org.apache.ibatis.annotations.Select;
  5. ​
  6. public interface UserMapper extends BaseMapper<User> {
  7. ​
  8.   @Select("SELECT * FROM user WHERE age >= #{age}")
  9.   Page<User> selectUsersByAge(Page<User> page, @Param("age") int age);
  10. }
 

调用分页查询：

 

 
  1. import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
  2. import org.springframework.beans.factory.annotation.Autowired;
  3. import org.springframework.stereotype.Service;
  4. ​
  5. @Service
  6. public class UserService {
  7. ​
  8.   @Autowired
  9.   private UserMapper userMapper;
  10. ​
  11.   public void getUsersByAge(int age) {
  12.       Page<User> page = new Page<>(1, 10); // 第1页，每页10条记录
  13.       Page<User> userPage = userMapper.selectUsersByAge(page, age);
  14. ​
  15.       System.out.println("Total Pages: " + userPage.getPages());
  16.       System.out.println("Total Records: " + userPage.getTotal());
  17.       userPage.getRecords().forEach(System.out::println);
  18.   }
  19. }
 

  • Page 对象：Page<User> 对象封装了分页参数（如当前页码、每页大小）和分页结果（如总页数、总记录数以及当前页的记录列表）。

  • 自动生成分页 SQL：当传入 Page 对象时，MyBatis-Plus 会自动在 SQL 语句后追加分页限制（如 LIMIT 子句），并执行分页查询。

 

MyBatis-Plus 的分页与 MyBatis 的分页实现的不同

 

1. 简化操作

  • MyBatis：传统的 MyBatis 实现分页通常需要手动编写分页 SQL 或者使用第三方分页插件（如 PageHelper）。开发者需要自己处理分页参数（如 LIMIT 和 OFFSET），以及在查询完成后计算总记录数。

  • MyBatis-Plus：MyBatis-Plus 内置分页插件，开发者只需要在查询方法中传入 Page 对象，插件会自动处理分页逻辑，包括生成分页 SQL、执行查询、计算总记录数等，极大简化了分页的实现。

 

2. 支持多种数据库

  • MyBatis：MyBatis 的分页实现通常依赖于数据库特定的分页语法（如 MySQL 的 LIMIT，Oracle 的 ROWNUM），如果项目需要支持多种数据库，分页 SQL 的编写会比较复杂。

  • MyBatis-Plus：MyBatis-Plus 的分页插件自动识别数据库类型，并生成相应的分页 SQL，开发者无需关心数据库差异。分页插件支持的数据库包括 MySQL、PostgreSQL、Oracle、SQL Server 等。

 

3. 更好的性能

  • MyBatis：在 MyBatis 中，如果需要分页查询和总记录数统计，通常需要执行两次查询，一次查询分页数据，另一次查询总记录数，这可能导致性能开销较大。

  • MyBatis-Plus：MyBatis-Plus 的分页插件可以在一次查询中完成分页数据和总记录数的统计，减少了数据库访问次数，提升了查询性能。

 

总结

  • 使用简便：MyBatis-Plus 的分页插件通过 Page 对象简化了分页查询的实现，不需要手动编写分页 SQL。

  • 自动适配：分页插件自动适配不同数据库的分页语法，支持多种数据库，提升了开发的便捷性和代码的可移植性。

  • 性能优化：分页插件能够在一次查询中完成分页数据和总记录数的统计，减少数据库访问次数，提升查询性能。

MyBatis-Plus 的分页插件不仅简化了分页查询的开发工作，还提升了查询性能和代码的可读性，使得分页功能的实现更加高效和简洁。

 

posted @ 2025-01-03 09:17  CharyGao  阅读(838)  评论(0)    收藏  举报