当前位置：首页 > news >正文

MyBatis-Plus 分页查询（PageHelper）

news 来源：原创 2025/6/20 13:05:28

在现代应用中，分页查询是处理大数据量的一项重要操作。它不仅能提升性能，还能改善用户体验。MyBatis-Plus（MP）提供了简便的分页查询功能，极大地简化了开发者的工作。此外，PageHelper 是另一个广泛使用的分页插件，它也能与 MyBatis-Plus 配合使用，提供更丰富的分页功能。

本文将介绍 MyBatis-Plus 分页查询 的原理，如何集成和配置 PageHelper，以及如何优化分页查询性能。

1. 分页查询的原理

分页查询的基本思想是，将查询结果分为若干个页面，每个页面只显示一部分数据。分页查询需要两个关键信息：

页码：指定当前要查询的是第几页。
每页条数：指定每页显示多少条数据。

通常，分页查询会使用 SQL LIMIT 子句，来限制每次查询的数据量。例如，MySQL 查询语句：

SELECT * FROM user LIMIT 0, 10;  -- 第 1 页，每页 10 条数据
SELECT * FROM user LIMIT 10, 10; -- 第 2 页，每页 10 条数据

分页查询的常见问题

性能问题：在数据量较大的表上进行分页查询时，OFFSET 的计算和查询数据的过程会变得较慢，尤其是在页数较大的情况下。
数据一致性问题：分页查询可能会出现数据的不一致，特别是在数据频繁更新的情况下。

2. PageHelper 集成与配置

PageHelper 是一个基于 MyBatis 的分页插件，它通过拦截器拦截 SQL 查询，自动为 SQL 增加分页信息。它为 MyBatis 提供了简洁的分页支持，能够与 MyBatis-Plus 配合使用。

2.1 引入依赖

要在项目中使用 PageHelper，首先需要在 pom.xml 中添加相关依赖。

<dependencies>
    <!-- MyBatis-Plus 核心依赖 -->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-core</artifactId>
        <version>3.4.3</version>
    </dependency>
    
    <!-- PageHelper 插件 -->
    <dependency>
        <groupId>com.github.pagehelper</groupId>
        <artifactId>pagehelper</artifactId>
        <version>5.1.10</version>
    </dependency>
</dependencies>

2.2 配置 PageHelper 插件

在 Spring Boot 项目中，需要在配置类中添加 PageHelper 插件的配置。

配置 MyBatis-Plus 分页插件

MyBatis-Plus 提供了分页插件，可以通过以下配置启用：

import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MybatisPlusConfig {

    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        // 设置分页插件
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor());
        return interceptor;
    }
}

配置 PageHelper 插件

在 application.properties 或 application.yml 中，添加 PageHelper 的配置：

# 配置 PageHelper 插件
pagehelper.helperDialect=mysql  # 数据库方言，支持 MySQL、Oracle 等
pagehelper.reasonable=true      # 合理化查询，防止查询过大的数据

2.3 使用 PageHelper 开启分页

在代码中，我们可以通过 PageHelper.startPage(pageNum, pageSize) 来启动分页查询。startPage 会拦截查询语句并在 SQL 中加上分页参数。

import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;

public List<User> getUserList(int pageNum, int pageSize) {
    // 开启分页
    PageHelper.startPage(pageNum, pageSize);
    List<User> userList = userMapper.selectAllUsers();
    // 获取分页信息
    PageInfo<User> pageInfo = new PageInfo<>(userList);
    return pageInfo.getList();  // 返回分页后的数据
}

startPage(pageNum, pageSize)：启动分页，pageNum 是页码，pageSize 是每页显示的条数。
PageInfo：分页查询结果，提供了如总记录数、总页数等分页信息。

3. 使用 Page 对象进行分页查询

MyBatis-Plus 提供了 Page 类用于分页查询，它不仅支持常规的分页功能，还集成了统计总记录数和总页数等信息。

3.1 `Page` 对象的使用

Page 类是 MyBatis-Plus 提供的分页对象，使用 Page 对象进行分页查询时，它会自动处理分页的参数（如页码、每页大小），并返回分页结果。

分页查询示例

import com.baomidou.mybatisplus.extension.plugins.pagination.Page;

public List<User> getUserList(int pageNum, int pageSize) {
    Page<User> page = new Page<>(pageNum, pageSize);
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.eq("status", 1);  // 查询状态为 1 的用户

    // 分页查询
    IPage<User> userPage = userMapper.selectPage(page, queryWrapper);
    
    System.out.println("Total records: " + userPage.getTotal());  // 获取总记录数
    System.out.println("Total pages: " + userPage.getPages());  // 获取总页数
    
    return userPage.getRecords();  // 获取当前页数据
}

在这个示例中：

Page<User>：用于表示分页信息，pageNum 是页码，pageSize 是每页的记录数。
selectPage：MyBatis-Plus 提供的分页查询方法，支持分页查询并返回 IPage 对象，其中包含分页数据和总记录数等信息。

3.2 `Page` 对象的常用方法

getTotal()：获取总记录数。
getPages()：获取总页数。
getRecords()：获取当前页的数据。
getCurrent()：获取当前页码。
getSize()：获取每页的数据条数。

4. 分页插件的使用与优化

4.1 分页插件的优化

合理化查询

为了避免查询过多数据，MyBatis-Plus 分页插件提供了 合理化查询 功能。合理化查询可以防止查询非常大的页码，避免数据库性能瓶颈。

pagehelper.reasonable=true

reasonable=true：启用合理化查询。启用后，查询页码大于总页数时会自动查询最后一页，避免查询过大的数据。

性能优化建议

避免使用 SELECT * 查询：
使用 SELECT * 查询会返回表中的所有列，增加了不必要的数据传输和内存开销。建议只查询必要的字段：
```
queryWrapper.select("id", "name", "age");
```
避免在高并发环境中查询大量数据：
分页查询时，尽量避免查询过大的数据集，尤其是在高并发环境中。可以通过合理设计分页策略和 SQL 条件来减少查询的数据量。
使用索引：
确保查询条件涉及的字段（如主键、外键）有索引，能够大大提高分页查询的性能。
异步分页查询：
在数据量较大时，可以考虑使用异步分页查询，减轻数据库的负载，并加快响应时间。

5. 总结

分页查询的原理：分页查询通过限制每次查询的数据条数，减少了数据库负载，提高了查询效率。
PageHelper 集成与配置：PageHelper 插件通过拦截 SQL 查询并增加分页参数，简化了分页查询的配置。
使用 Page 对象进行分页查询：MyBatis-Plus 提供了 Page 对象，支持分页查询、统计总记录数、总页数等信息，简化了分页查询的实现。
分页插件的使用与优化：通过合理配置分页插件，启用合理化查询、避免全表扫描、使用索引等方式，可以大幅提升分页查询的性能。

通过合理使用 MyBatis-Plus 和 PageHelper，开发者能够在处理大数据量时，轻松实现高效的分页查询，提升应用的性能和用户体验。 🚀