【Mybatis相关】好用的分页插件PageHelper

PageHelper 是一个非常流行的 MyBatis 分页插件，它可以帮助开发者在 MyBatis 中轻松实现分页查询。通过 PageHelper，你可以非常方便地在 SQL 查询中添加分页逻辑，而无需手动编写复杂的分页 SQL 语句。

PageHelper 的工作原理

1. 拦截 SQL 执行：PageHelper 通过拦截 MyBatis 的执行链来实现分页功能。它会在 SQL 执行前插入分页参数，并在执行后处理分页结果。
2. 动态生成 SQL：PageHelper 会根据传入的分页参数动态生成相应的 SQL 语句，例如添加 LIMIT 子句（对于 MySQL）或 ROWNUM 子句（对于 Oracle）。
3. 返回分页结果：最终返回一个包含分页数据和分页信息的对象。

使用 PageHelper 的步骤

1. 添加依赖

首先，在你的项目中添加 PageHelper 的依赖。如果你使用的是 Maven，可以在 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper</artifactId>
    <version>5.3.0</version>
</dependency>

2. 配置 MyBatis

在 MyBatis 的配置文件中（通常是 mybatis-config.xml），添加 PageHelper 插件的配置：

<configuration>
    <plugins>
        <plugin interceptor="com.github.pagehelper.PageInterceptor">
            <!-- 配置参数 -->
            <property name="helperDialect" value="mysql"/>
            <property name="reasonable" value="true"/>
            <property name="supportMethodsArguments" value="true"/>
            <property name="params" value="count=countSql"/>
        </plugin>
    </plugins>
</configuration>

3. 使用 PageHelper

在你的 DAO 或 Mapper 接口中，使用 PageHelper 提供的静态方法来开启分页。

示例：Mapper 接口

public interface UserMapper {
    List<User> findAllUsers();
}

示例：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.findAllUsers();
        // 封装分页结果
        return new PageInfo<>(users);
    }
}

示例：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 int pageNum, @RequestParam int pageSize) {
        return userService.getUsers(pageNum, pageSize);
    }
}

关键点解释

1. PageHelper.startPage：

   • PageHelper.startPage(pageNum, pageSize) 方法用于开启分页，传入当前页码和每页显示的记录数。

2. PageInfo：

   • PageInfo 是 PageHelper 提供的一个封装类，用于封装分页结果。它包含了总记录数、总页数、当前页码、每页记录数等信息。

3. 配置参数：

   • helperDialect：指定数据库方言，例如 mysql、oracle 等。
   • reasonable：是否合理化分页参数，默认为 false。
   • supportMethodsArguments：是否支持方法参数，如果设置为 true，则可以使用方法参数来传递分页参数。
   • params：自定义参数，例如 count=countSql 表示使用自定义的统计 SQL。

总结

通过 PageHelper，你可以非常方便地在 MyBatis 中实现分页查询。它不仅简化了分页逻辑的编写，还提供了丰富的配置选项，使得分页功能更加灵活和强大。希望这个示例和解释能帮助你更好地理解和使用 PageHelper。如果有任何问题或需要进一步的帮助，请随时提问！