当前位置:   article > 正文

简化Mybatis分页操作,让我们来聊聊 PageHelper 及实现原理_pagehelper配置详解

pagehelper配置详解

PageHelper 是一款开源的 MyBatis 分页插件,可以在实际应用中方便地实现分页功能。PageHelper 能够有效地缩减开发人员的分页处理代码量,提升开发效率。

一、PageHelper 简介

1.1 PageHelper 的作用

面向关系型数据库的 SQL 查询和数据导出时,如果数据条数非常大,直接将所有数据一次性查出或者导出显然是不可行的。这时候就需要进行分页查询或分页导出,将查询或导出的数据按照指定大小分页加载或写入,从而提高查询或导出的效率。而分页查询或分页导出的实现过程比较繁琐,需要考虑很多细节问题,容易出错。因此,出现了一些支持分页查询或分页导出的插件或工具类,例如 MyBatis 的分页插件 PageHelper。

1.2 PageHelper 的特点

PageHelper 的特点主要有以下几点:

(1)无侵入性:使用 PageHelper 对 MyBatis 进行分页处理时,不需要修改原有的 SQL 语句,也不需要修改 Mapper 接口和 XML 文件。

(2)易用性:使用 PageHelper 只需要在项目中引入相关依赖,然后通过代码或配置即可实现分页功能。

(3)强大的功能:PageHelper 支持多种数据库,支持复杂的分页查询功能,例如排序、聚合查询、连表查询等。

(4)高度自定义:PageHelper 支持自定义拦截器,并且提供了丰富的配置选项,可以根据实际需要进行自定义设置。

二. PageHelper 的使用

2.1 引入 PageHelper

在项目中使用 PageHelper 首先需要在 pom.xml 文件中引入相关的依赖:

  1. xml复制代码<dependency>
  2. <groupId>com.github.pagehelper</groupId>
  3. <artifactId>pagehelper</artifactId>
  4. <version>5.2.0</version>
  5. </dependency>

此外,如果需要使用 PageHelper 的自动配置功能,还需要引入 MyBatis-Spring-Boot-Starter 和 Spring Boot Starter JDBC 或 MyBatis-Starter 等相关依赖。

2.2 配置 PageHelper

在 Spring Boot 中使用 PageHelper 可以通过配置文件或者 Java 代码进行配置。以下是通过配置文件进行配置的示例:

  1. properties复制代码# PageHelper 配置
  2. pagehelper.helperDialect=mysql
  3. pagehelper.reasonable=true
  4. pagehelper.supportMethodsArguments=true
  5. pagehelper.params=count=countSql

其中,helperDialect 属性指定了当前项目所使用的数据库类型,reasonable 属性指定了是否启用合理化查询(即优化分页查询性能),supportMethodsArguments 属性指定了是否支持接口参数来传递分页参数,params 属性指定了 PageHelper 的参数名称。

2.3 使用 PageHelper

使用 PageHelper 进行分页查询非常简单,只需在代码中加入对 PageHelper 的支持,并按照要求传递分页参数即可。以下是一个示例:

  1. java复制代码//1 个参数为当前页码数,第 2 个参数为每页显示的条数
  2. PageHelper.startPage(1, 10);
  3. List<User> userList = userDao.selectUserList();
  4. // 通过 PageInfo 获取分页信息
  5. PageInfo<User> pageInfo = new PageInfo<>(userList);
  6. System.out.println(pageInfo.getTotal());

上述代码首先调用了 PageHelper 的 startPage 方法,传入了当前页码数和每页显示的条数,然后调用了 UserDao 的 selectUserList() 方法查询用户列表。最后通过 PageInfo 获取分页信息,包括总记录数、当前页码数、每页显示的条数等信息。

三. PageHelper 的优缺点

3.1 优点

PageHelper 的优点主要有以下几点:

(1)使用方便:PageHelper 实现了 MyBatis 的 Interceptor 接口,并提供了强大的分页查询 API,可以方便地完成分页查询操作。

(2)性能优化:PageHelper 在分页查询时自动优化 SQL 语句,减少了很多重复性工作,提升了分页查询的性能。

(3)支持多种数据库:PageHelper 支持多种关系型数据库,例如 MySQL、Oracle 等,可以轻松切换不同的数据库。

(4)自定义扩展:PageHelper 提供了自定义拦截器和配置选项,可以根据实际需要进行自定义扩展。

3.2 缺点

PageHelper 的缺点主要有以下几点:

(1)一定程度上增加了项目的复杂度:在项目中引入 PageHelper ,需要修改项目的依赖、配置和代码,一定程度上增加了项目的复杂度。

(2)部分灵活性较差:由于 PageHelper 是直接在 MyBatis 插件机制中实现的,因此在某些情况下会出现灵活性较差的情况。

(3)文档不够丰富:PageHelper 的官方文档相对简单,部分功能使用方法没有详细介绍,需要开发者自行查询相关资料。

四. PageHelper 的注意事项

在使用 PageHelper 进行分页查询时,需要注意以下几点:

(1)避免一次加载过多的数据:虽然 PageHelper 可以优化分页查询性能,但是如果一次加载过多的数据,依然会影响查询效率。因此,应该更加精细地控制每页显示的数据量,尽量避免一次加载过多的数据。

(2)Java 版本兼容性:PageHelper 的不同版本对于 Java 版本的兼容性可能会有所不同,因此在使用 PageHelper 时需要注意当前所使用的 Java 版本和 PageHelper 的版本是否匹配。

(3)类似于 limit 关键字的语法:PageHelper 使用了类似于 limit 关键字的语法,这可能会受到不同数据库支持的限制,因此需要在实际使用时进行测试。

(4)分页参数设置:在使用 PageHelper 进行分页查询时,需要按照要求设置分页参数,如 pageNum 和 pageSize 等参数,否则可能会导致查询结果不正确。

五、实现原理

主要是通过拦截器(Interceptor)来实现。在 MyBatis 中,提供了 Interceptor 接口用于对 SQL 语句进行拦截和处理,PageHelper 就是实现了这个接口,从而实现了对 SQL 语句的拦截和分页处理。

PageHelper 在拦截器中主要做了如下几个事情:

  1. 解析分页参数:通过拦截 Executor 的 query() 方法,获取传入的参数,解析出当前所在的页码、每页显示的数据量等分页参数。
  2. 生成分页 SQL:通过拦截 StatementHandler 的 prepare() 方法,将原始的 SQL 语句修改为分页查询的 SQL 语句,具体实现方式是根据当前数据库类型,使用相应的方言(Dialect)生成分页查询语句。
  3. 执行分页查询:通过拦截 Executor 的 query() 方法,将修改后的 SQL 语句执行,并将结果保存在 Page 对象中,同时返回分页查询结果 List。
  4. 生成分页信息:通过自定义 Page 对象,保存当前页码、每页显示的数据量、总记录数以及分页查询结果 List,最终返回 PageInfo 对象,包含了分页查询的所有信息。

其中,涉及到的一些核心代码如下:

  1. java复制代码// 分页查询拦截器
  2. public class PageInterceptor implements Interceptor {
  3. @Override
  4. public Object intercept(Invocation invocation) throws Throwable {
  5. // 解析分页参数
  6. Page<Object> page = getPageParam(invocation);
  7. // 生成分页 SQL
  8. String pageSql = generatePageSql(page, invocation);
  9. // 替换原始 SQL 语句为分页 SQL
  10. setSql(invocation, pageSql);
  11. // 执行分页查询
  12. List<?> result = (List<?>) invocation.proceed();
  13. // 生成分页信息
  14. PageInfo<?> pageInfo = new PageInfo<>(result, page.getPageSize());
  15. return pageInfo;
  16. }
  17. }
  18. // 获取分页参数
  19. private Page<Object> getPageParam(Invocation invocation) {
  20. Object[] args = invocation.getArgs();
  21. for (Object arg : args) {
  22. if (arg instanceof Page) {
  23. return (Page<Object>) arg;
  24. }
  25. }
  26. return null;
  27. }
  28. // 生成分页 SQL
  29. private String generatePageSql(Page<?> page, Invocation invocation) {
  30. MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0];
  31. String sql = mappedStatement.getBoundSql(page).getSql();
  32. Dialect dialect = getDialect(mappedStatement.getConfiguration().getEnvironment().getDataSource());
  33. return dialect.generatePageSql(sql, page.getStartRow(), page.getPageSize());
  34. }
  35. // 设置 SQL 语句
  36. private void setSql(Invocation invocation, String sql) {
  37. Object[] args = invocation.getArgs();
  38. MappedStatement mappedStatement = (MappedStatement) args[0];
  39. BoundSql boundSql = mappedStatement.getBoundSql(args[1]);
  40. MetaObject metaObject = SystemMetaObject.forObject(boundSql);
  41. metaObject.setValue("sql", sql);
  42. }

以上代码中,getPageParam() 方法用于获取传入的分页参数,generatePageSql() 方法用于根据当前数据库类型生成分页 SQL 语句,setSql() 方法用于将原始的 SQL 语句替换为分页 SQL 语句。此外,还需要实现 Dialect 接口来提供不同数据库类型的方言实现。

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/Gausst松鼠会/article/detail/88076
推荐阅读
相关标签
  

闽ICP备14008679号