【SpringBoot】SpringBoot中分页插件（PageHelper）的使用

在Spring Boot项目中，分页是一个常见的需求，尤其是在处理大量数据时。为了便于实现分页功能，我们可以使用PageHelper这个开源插件。PageHelper是一个MyBatis的分页插件，它可以简化分页操作，提供灵活的配置和使用方式。

1. 引入依赖

首先，我们需要在Spring Boot项目中引入PageHelper的依赖。如果你的项目是使用Maven构建的，需要在pom.xml中添加以下依赖：

<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper-spring-boot-starter</artifactId>
    <version>1.4.0</version> <!-- 请根据最新版本进行调整 -->
</dependency>

2. 配置PageHelper

在application.yml或application.properties中进行简单的配置，通常情况下只需要简单配置即可，不需要特别复杂的设置。

application.yml示例：

spring:
  pagehelper:
    helperDialect: mysql          # 数据库方言
    reasonable: true               # 合理化
    supportMethodsArguments: true   # 支持通过Mapper方法参数来传递分页参数

3. 使用PageHelper进行分页查询

接下来，我们可以在Service层或者Controller层使用PageHelper来进行分页查询。以下是一个简单的示例，假设我们有一个User实体类和对应的数据库表。

3.1 创建实体类

public class User {
    private Long id;
    private String name;
    private Integer age;

    // getters and setters
}

3.2 创建Mapper接口

import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;

import java.util.List;

@Mapper
public interface UserMapper {
    @Select("SELECT * FROM users")
    List<User> getAllUsers();
}

3.3 创建Service层

import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class UserService {

    @Autowired
    private UserMapper userMapper;

    public PageInfo<User> getUsers(int pageNum, int pageSize) {
        // 设置分页参数
        PageHelper.startPage(pageNum, pageSize);
        // 执行查询
        List<User> users = userMapper.getAllUsers();
        // 使用PageInfo包装查询结果
        return new PageInfo<>(users);
    }
}

3.4 创建Controller层

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping("/users")
    public PageInfo<User> listUsers(@RequestParam(defaultValue = "1") int pageNum,
                                      @RequestParam(defaultValue = "10") int pageSize) {
        return userService.getUsers(pageNum, pageSize);
    }
}

4. 结果返回

当我们调用/users?pageNum=1&pageSize=10接口时，返回的结果将被封装在PageInfo对象中，它包含了当前页码、总记录数、总页数、每页的数据列表等信息：

{
    "pageNum": 1,
    "pageSize": 10,
    "size": 10,
    "total": 100,
    "list": [
        {"id": 1, "name": "Alice", "age": 30},
        {"id": 2, "name": "Bob", "age": 25},
        ...
    ]
}

5. 结束语

使用PageHelper进行分页非常简单且方便。我们只需几个步骤，就可以在Spring Boot项目中实现强大的分页功能。PageHelper丰富的功能和灵活性使其成为开发者进行分页查询时的一个优秀选择。在实际应用中，根据业务需要，合理利用分页功能，可以有效提升应用的性能和用户体验。