java

关注公众号 jb51net

关闭
首页 > 软件编程 > java > springboot分页查询使用

springboot项目中分页查询的使用示例解析

作者:coder lei

本文详细讲解SpringBoot中两种主流分页方案:MyBatis+PageHelper和MyBatisPlus的实现方式、原理、优缺点及实际应用场景,内容涵盖配置、代码示例、注意事项和对比总结,感兴趣的朋友一起看看吧

Spring Boot 分页查询详解

本文详细讲解 Spring Boot 中两种主流分页方案:MyBatis + PageHelper 和 MyBatis Plus 的实现方式、原理、优缺点及实际应用场景。内容涵盖配置、代码示例、注意事项和对比总结。

一、分页查询概述

分页查询是 Web 开发中处理大数据集的核心需求,其本质是 按需加载数据,避免一次性返回全部数据导致的性能问题。实现方式通常分为两类:

Spring Boot 中常用 物理分页,依赖 MyBatis 的插件机制动态修改 SQL。

二、MyBatis + PageHelper 分页方案

1. 核心依赖

<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper-spring-boot-starter</artifactId>
    <version>1.4.6</version>
</dependency>

2. 配置参数(application.yml)

pagehelper:
  helper-dialect: mysql       # 指定数据库方言(mysql/oracle/postgresql)
  reasonable: true            # 合理化分页参数(超出范围时自动修正)
  support-methods-arguments: true  # 支持接口参数传递分页

3. 分页实现代码

Service 层

public PageInfo<User> getUsersByPage(int pageNum, int pageSize) {
    try {
        // 开启分页:对紧接的第一个查询生效
        PageHelper.startPage(pageNum, pageSize);
        List<User> users = userMapper.selectAll();
        return new PageInfo<>(users);  // 包含总条数、总页数等信息
    } finally {
        PageHelper.clearPage();  // 清理 ThreadLocal
    }
}

Mapper 接口

@Select("SELECT * FROM user WHERE status = 1")
List<User> selectAll();

4. 分页原理

5. 注意事项

@Select("SELECT COUNT(*) FROM user WHERE status = 1")
Long countUsers();
// 指定自定义 COUNT 方法
PageHelper.startPage(1, 10).count(true).setCountSql("countUsers");

三、MyBatis Plus 分页方案

1. 核心依赖

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.5.3.1</version>
</dependency>

2. 分页插件配置

@Configuration
public class MybatisPlusConfig {
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        // 添加分页拦截器,指定数据库类型
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }
}

3. 分页实现代码

Service 层

public IPage<User> getUsersByPage(int pageNum, int pageSize) {
    // 创建分页对象
    Page<User> page = new Page<>(pageNum, pageSize);
    // 执行分页查询(自动处理 SQL)
    return userMapper.selectPage(page, new QueryWrapper<User>().eq("status", 1));
}

Mapper 接口

public interface UserMapper extends BaseMapper<User> {
    // 继承 BaseMapper 默认提供分页方法
}

4. 分页原理

5. 注意事项

// 关闭自动 COUNT 查询
Page<User> page = new Page<>(pageNum, pageSize, false);
List<User> users = userMapper.selectPage(page, wrapper);
// 手动执行 COUNT 查询
page.setTotal(userMapper.selectCount(wrapper));

四、对比总结

对比维度MyBatis + PageHelperMyBatis Plus
依赖复杂度仅需 PageHelper 依赖需引入 MyBatis Plus 全家桶
配置难度需配置方言、合理化参数仅需定义分页拦截器
侵入性低(无需修改 Mapper)高(需继承 BaseMapper
SQL 灵活性支持任意复杂 SQL,手动优化空间大简单查询高效,复杂 SQL 需自定义
线程安全依赖 ThreadLocal,需注意异步场景无线程安全问题(参数传递)
适用场景已有 MyBatis 项目,需灵活分页新项目或深度集成 MyBatis Plus

五、最佳实践与常见问题

1. 最佳实践

2. 常见问题

Q1:分页不生效

Q2:总条数(total)为 0

Q3:性能低下

优化

-- 原始 SQL(性能差)
SELECT * FROM orders ORDER BY id LIMIT 1000000, 10;
-- 优化 SQL(延迟关联)
SELECT * FROM orders 
WHERE id >= (SELECT id FROM orders ORDER BY id LIMIT 1000000, 1)
ORDER BY id LIMIT 10;

六、附录:完整代码示例

PageHelper 完整示例

// Service
public PageInfo<User> getUsers(int pageNum, int pageSize) {
    try {
        PageHelper.startPage(pageNum, pageSize);
        List<User> users = userMapper.selectByCondition("active");
        return new PageInfo<>(users);
    } finally {
        PageHelper.clearPage();
    }
}
// Mapper
@Select("SELECT * FROM user WHERE status = #{status}")
List<User> selectByCondition(String status);

MyBatis Plus 完整示例

// Service
public IPage<User> getUsers(int pageNum, int pageSize) {
    Page<User> page = new Page<>(pageNum, pageSize);
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.eq("status", "active");
    return userMapper.selectPage(page, wrapper);
}

到此这篇关于springboot项目中分页查询的使用解析的文章就介绍到这了,更多相关springboot分页查询使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

您可能感兴趣的文章:
阅读全文