【实战场景】如何优雅实现分页

news2024/12/23 14:25:43

【实战场景】如何优雅实现分页

开篇词：
干货篇：
- - 1.添加PageHelper依赖
  - 2.添加PageHelper配置
  - 3.使用 PageHelper
  - 4.自定义@Pageable注解
总结：
- - 1.执行查询
  - 2.处理分页结果
  - 3.注意事项
我是杰叔叔，一名沪漂的码农，下期再会！

开篇词：

分页实现方式千千万，哪款才是你的最爱，分享一个我觉得还挺优雅的实现方式。
在这里插入图片描述

干货篇：

1.添加PageHelper依赖

首先，你需要在你的项目中添加 PageHelper 的依赖

<dependency>  
    <groupId>com.github.pagehelper</groupId>  
    <artifactId>pagehelper</artifactId>  
    <version>版本号</version>  
</dependency>

2.添加PageHelper配置

PageHelper 可以通过多种方式配置，但最常用的是在 MyBatis 的配置文件中配置插件。如果你使用的是 Spring Boot，并且集成了 MyBatis，通常可以在 MyBatis 的配置类中添加 PageHelper 的配置。

@Configuration  
public class MybatisConfig {  
 
    @Bean  
    public PageHelper pageHelper() {  
        PageHelper pageHelper = new PageHelper();  
        Properties properties = new Properties();  
        properties.setProperty("helperDialect", "mysql"); // 设置数据库方言  
        properties.setProperty("reasonable", "true"); // 分页合理化参数，默认为false。当设置为true时，如果pageNum<1会查询第一页，如果pageNum>pages（超过总数时），会查询最后一页  
        properties.setProperty("supportMethodsArguments", "true"); // 支持通过 Mapper 接口方法参数来传递分页参数  
        pageHelper.setProperties(properties);  
        return pageHelper;  
    }  
}

注意： 如果你使用的是 Spring Boot 2.x 和 MyBatis-Spring-Boot-Starter，通常不需要手动配置 PageHelper，因为 Spring Boot 可以通过自动配置来集成 PageHelper。你只需要在启动类或者配置类上添加 @MapperScan 注解来指定 Mapper 接口的位置即可。

3.使用 PageHelper

在你的 Mapper 接口的查询方法之前调用 PageHelper.startPage 方法来设置分页参数。startPage 方法接受两个参数：页码（pageNum）和每页显示的记录数（pageSize）。

public List<YourEntity> selectYourEntityList(YourEntity example) {  
    PageHelper.startPage(1, 10); // 第一页，每页10条记录  
    return yourMapper.selectByExample(example); // 调用 MyBatis 的查询方法  
}

调用 startPage 方法后，紧接着的 MyBatis 查询就会被分页。PageHelper 会自动在生成的 SQL 语句后添加 LIMIT 语句。
获取分页信息

分页查询后，PageHelper 会将分页信息存储在 PageInfo 对象中。你可以通过 PageInfo 对象来获取分页信息，如总记录数、总页数等。

PageInfo<YourEntity> pageInfo = new PageInfo<>(selectYourEntityList(example));  
System.out.println("总记录数：" + pageInfo.getTotal());  
System.out.println("总页数：" + pageInfo.getPages());