您的位置:

PageHelper分页插件使用示例

一、 PageHelper 简介

PageHelper 是一个基于 MyBatis 的分页插件,通过拦截 SQL 实现物理分页。

使用 PageHelper 可以减少代码量,增加可读性,使代码更加易于维护。

二、PageHelper 的使用

1、引入 PageHelper Maven 依赖

```xml com.github.pagehelper pagehelper-spring-boot-starter 1.3.0 ```

2、配置 PageHelper 插件

在 application.yml 或 application.properties 文件中添加如下 PageHelper 配置:

```yaml pagehelper: helperDialect: mysql reasonable: true supportMethodsArguments: true params: count=countSql autoRuntimeDialect: true ```

3、使用 PageHelper 分页查询数据

在查询数据时,只需要使用 PageHelper.startPage() 方法设置起始页码和每页显示的记录数,然后执行查询方法即可完成分页查询。

```java public PageInfo getUserList(Integer page, Integer pageSize) { // 根据 PageHelper.startPage() 方法设置分页请求参数 PageHelper.startPage(page, pageSize); List userList = userDao.findUserList(); // 使用 PageInfo 对象封装查询结果 PageInfo pageInfo = new PageInfo<>(userList); return pageInfo; } ```

三、示例代码

以下是一个完整的使用 PageHelper 进行分页查询的示例代码:

```java @RestController public class UserController { @Autowired private UserDao userDao; @GetMapping("/user/list") public PageInfo getUserList(Integer page, Integer pageSize) { // 根据 PageHelper.startPage() 方法设置分页请求参数 PageHelper.startPage(page, pageSize); List userList = userDao.findUserList(); // 使用 PageInfo 对象封装查询结果 PageInfo pageInfo = new PageInfo<>(userList); return pageInfo; } } ```

四、小结

本文简单介绍了 PageHelper 分页插件的使用方法,并给出了一个完整的示例代码。通过使用 PageHelper,可以大大减少代码量,增加可读性,使代码更加易于维护。