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

深度解析：MyBatis-Plus实现分页查询的封装！

article 2025/1/30 13:53:41

全文目录：

- 开篇语
- 前言
- 摘要
- 概述
- - 什么是分页查询？
  - 为什么选择 MyBatis-Plus？
  - 本文目标
- 源码解析
- - 分页插件核心逻辑
- 使用案例分享
- - 1. 配置 MyBatis-Plus 分页插件
  - 2. 定义分页查询方法
  - 3. Controller 层调用
- 应用场景案例
- 优缺点分析
- - 优点
  - 缺点
- 核心类方法介绍
- 测试用例
- 小结
- 总结
- 文末

开篇语

哈喽，各位小伙伴们，你们好呀，我是喵手。运营社区：C站/掘金/腾讯云/阿里云/华为云/51CTO；欢迎大家常来逛逛

今天我要给大家分享一些自己日常学习到的一些知识点，并以文字的形式跟大家一起交流，互相学习，一个人虽可以走的更快，但一群人可以走的更远。

我是一名后端开发爱好者，工作日常接触到最多的就是Java语言啦，所以我都尽量抽业余时间把自己所学到所会的，通过文章的形式进行输出，希望以这种方式帮助到更多的初学者或者想入门的小伙伴们，同时也能对自己的技术进行沉淀，加以复盘，查缺补漏。

小伙伴们在批阅的过程中，如果觉得文章不错，欢迎点赞、收藏、关注哦。三连即是对作者我写作道路上最好的鼓励与支持！

前言

在上期内容中，我们深入探讨了 MyBatis-Plus 的基础使用和核心功能，包括其增强版 CRUD 操作、内置 SQL 方法以及与 MyBatis 的无缝兼容。这些特性极大地简化了 Java 开发者日常处理数据库操作的代码量。然而，在实际的开发场景中，仅仅依赖这些基础功能是不够的，分页查询作为最常见的数据查询需求之一，对 MyBatis-Plus 的分页功能封装则成为项目开发中不可或缺的一部分。

本期内容，我们将聚焦 MyBatis-Plus 的分页查询封装。通过剖析其核心实现，结合源码解析和实战案例，带领大家从理论到实操全面掌握这一技能。不仅如此，我们还将探索分页封装的优缺点及优化策略，帮助开发者更高效地满足复杂业务需求。

摘要

分页查询是现代软件开发中几乎必不可少的功能，尤其在大数据处理的场景中更显重要。MyBatis-Plus 提供了强大的分页插件，可以快速实现分页功能，而通过对分页查询的封装，能够进一步提高代码复用性和维护性。本篇文章将详细介绍 MyBatis-Plus 分页功能的实现方法、源码解析、使用案例及应用场景。最后，我们还会从优缺点分析、核心方法解读和测试用例的设计入手，全面总结 MyBatis-Plus 分页封装的最佳实践。

概述

什么是分页查询？

分页查询是一种将数据分块显示的技术，通常用于解决海量数据在前端展示时的性能问题。通过分页查询，用户可以分批次查看数据，同时减少对数据库资源的占用。

为什么选择 MyBatis-Plus？

MyBatis-Plus 是 MyBatis 的增强版，它以极少的学习成本为 MyBatis 提供了丰富的功能扩展，例如自动 CRUD、条件构造器、分页插件等。特别是分页功能，MyBatis-Plus 通过插件机制实现了对 SELECT 查询语句的自动处理，开发者只需简单配置即可完成分页功能。

本文目标

理解 MyBatis-Plus 分页插件的工作原理
掌握分页查询的封装技巧
通过实战案例学习最佳实践
深入分析封装后的优缺点和改进方向

源码解析

在 MyBatis-Plus 中，分页功能的核心实现依赖于 分页插件（PaginationInterceptor）和分页对象 Page。接下来我们通过源码剖析其核心原理。

分页插件核心逻辑

MyBatis-Plus 的分页插件会在 SQL 执行前自动拦截查询语句，并在语句末尾追加分页条件。其执行流程大致如下：

拦截 SQL 执行
PaginationInnerInterceptor 通过 MyBatis 的拦截器机制拦截 SELECT 查询语句。
解析分页参数
根据用户传入的分页对象（如 Page），获取分页参数（如当前页、每页条数）。
追加分页 SQL
将 LIMIT 和 OFFSET 条件附加到原始 SQL。
返回分页结果
执行分页后的 SQL，返回分页后的数据以及总记录数。

分页插件的核心源码片段如下：

@Override
public void beforeQuery(Executor executor, MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {
    // 1. 检查是否需要分页
    if (rowBounds instanceof Page<?>) {
        Page<?> page = (Page<?>) rowBounds;

        // 2. 获取分页参数
        long current = page.getCurrent();
        long size = page.getSize();

        // 3. 拼接分页 SQL
        String originalSql = boundSql.getSql();
        String paginatedSql = originalSql + " LIMIT " + (current - 1) * size + ", " + size;

        // 4. 替换 SQL
        ReflectionUtil.setFieldValue(boundSql, "sql", paginatedSql);
    }
}

使用案例分享

1. 配置 MyBatis-Plus 分页插件

在 Spring Boot 项目中，可以通过配置类引入分页插件：

@Configuration
public class MyBatisPlusConfig {

    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }
}

2. 定义分页查询方法

通过分页插件和分页对象 Page，可以轻松实现分页查询：

@Service
public class UserService {

    @Autowired
    private UserMapper userMapper;

    public IPage<User> getUsersByPage(int page, int size) {
        Page<User> userPage = new Page<>(page, size);
        return userMapper.selectPage(userPage, null);
    }
}

3. Controller 层调用

@RestController
@RequestMapping("/users")
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping("/list")
    public IPage<User> listUsers(@RequestParam int page, @RequestParam int size) {
        return userService.getUsersByPage(page, size);
    }
}

应用场景案例

后台管理系统
在后台系统中，例如用户管理、订单管理等模块，分页查询是必不可少的功能，用于高效显示列表数据。
电商平台
在商品展示页面，通过分页显示商品列表可以优化前端性能并减轻后端压力。
日志分析系统
日志数据量大且更新频率高，通过分页封装实现高效的数据查询和展示。

优缺点分析

优点

高效便捷：基于 MyBatis-Plus 提供的分页插件，分页查询的实现变得简单易用。
低耦合：通过封装，业务代码与分页逻辑解耦，便于维护。
高扩展性：可以灵活扩展分页查询的条件。

缺点

依赖插件机制：分页插件深度绑定到 MyBatis-Plus，难以适配其他 ORM 框架。
大数据性能限制：对于超大数据量分页查询，仍需优化 SQL 或采用更高效的方案。

核心类方法介绍

Page<T>
MyBatis-Plus 提供的分页对象，用于封装分页参数和结果。
- Page<T>(long current, long size)：指定当前页和每页条数。
- getRecords()：获取分页结果。
- getTotal()：获取总记录数。
PaginationInnerInterceptor
分页插件的核心类，负责拦截和修改 SQL。

测试用例

使用 JUnit 测试分页查询功能：

@SpringBootTest
public class UserServiceTest {

    @Autowired
    private UserService userService;

    @Test
    public void testGetUsersByPage() {
        IPage<User> page = userService.getUsersByPage(1, 10);
        Assertions.assertNotNull(page.getRecords());
        Assertions.assertTrue(page.getTotal() > 0);
    }
}