SpringBoot 项目如何使用 pageHelper 做分页处理 （含两种依赖方式）

在Spring Boot项目中进行分页处理，PageHelper是一个非常常用的工具。它提供了简单易用的分页功能，能够帮助开发者快速实现数据的分页查询。在使用PageHelper之前，我们需要引入相关的依赖。PageHelper支持多种方式来添加依赖，可以选择Maven或Gradle方式。

一、依赖添加

1. Maven依赖方式

在pom.xml中添加以下依赖：

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

2. Gradle依赖方式

在build.gradle中添加以下依赖：

implementation 'com.github.pagehelper:pagehelper-spring-boot-starter:1.4.0' // 请根据最新版本进行调整

二、配置PageHelper

在Spring Boot项目中，我们需要在application.yml或application.properties中添加一些基本的配置。这里以application.yml为例：

pagehelper:
  helperDialect: mysql # 数据库类型，支持多种如 mysql, oracle, sqlserver 等
  reasonable: true
  supportMethodsArguments: true
  params:
    count: countSql # 是否支持 count 查询

三、使用示例

下面我们通过一个简单的示例来演示如何使用PageHelper进行分页查询。假设我们有一个User实体和对应的UserMapper，并且我们要查询用户信息。

1. 创建User实体

public class User {
    private Integer id;
    private String name;
    private String email;

    // Getter and Setter
}

2. 创建UserMapper接口

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. 创建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();
        // 获取分页信息
        return new PageInfo<>(users);
    }
}

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> getUsers(@RequestParam(defaultValue = "1") int pageNum,
                                    @RequestParam(defaultValue = "10") int pageSize) {
        return userService.getUsers(pageNum, pageSize);
    }
}

四、总结

通过上述示例，我们可以看到使用PageHelper来实现分页功能是非常简单的。只需在Dao层的查询方法前调用PageHelper.startPage()方法，然后在Service层返回的List中构造PageInfo对象即可。

此外，PageHelper还支持多种高级功能，例如合理化分页、支持方法参数以及自定义的sql count查询等。开发者可以根据项目需求灵活使用。

在实际项目中，通过改进数据库查询和使用合适的索引，可以使得分页查询更加高效。希望本篇文章能够帮助你更好地理解和使用PageHelper进行数据分页处理。