MyBatis 如何实现分页功能

在开发中，分页是一个非常常见的需求，尤其是在查询大量数据时。MyBatis 作为一种持久化框架，提供了多种方式来实现分页。本文将介绍两种常见的 MyBatis 分页实现方式：RowBounds 和 PageHelper 插件。

1. 什么是分页？

分页是将查询结果分成多个部分（页面），每个页面包含有限数量的记录。在查询大量数据时，分页能够避免一次性加载过多的数据，减少内存占用和提高系统性能。

2. 使用 RowBounds 实现分页

RowBounds 是 MyBatis 提供的一个基础分页方式，支持通过设置查询结果的偏移量和限制条数来实现分页。

2.1 RowBounds 概述

RowBounds 是 MyBatis 内置的分页对象，它通过在查询时传入分页信息（offset 和 limit）来控制返回的结果数量。RowBounds 是物理分页，它在数据库中执行查询时就已经限制了返回数据的数量。

2.2 使用 RowBounds 实现分页

假设我们有一个 User 实体类，数据表如下所示：

CREATE TABLE user (
    id INT PRIMARY KEY AUTO_INCREMENT,
    username VARCHAR(50),
    age INT
);

1. 实体类：

public class User {
    private Integer id;
    private String username;
    private Integer age;

    // getters and setters
}

2. Mapper 接口：

import org.apache.ibatis.annotations.Select;
import org.apache.ibatis.session.RowBounds;

import java.util.List;

public interface UserMapper {

    @Select("SELECT id, username, age FROM user")
    List<User> getAllUsers(RowBounds rowBounds);  // 使用 RowBounds 进行分页
}

3. Service 层：

import org.apache.ibatis.session.RowBounds;
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 List<User> getUsersByPage(int pageNum, int pageSize) {
        // 计算偏移量
        int offset = (pageNum - 1) * pageSize;
        
        // 使用 RowBounds 来设置分页参数
        RowBounds rowBounds = new RowBounds(offset, pageSize);
        
        return userMapper.getAllUsers(rowBounds);
    }
}

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;
import java.util.List;

@RestController
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping("/users")
    public List<User> getUsers(@RequestParam int pageNum, @RequestParam int pageSize) {
        return userService.getUsersByPage(pageNum, pageSize);
    }
}

2.3 使用 RowBounds 的局限性

• 性能问题：RowBounds 是物理分页，在查询时返回的是所有的数据，并且是由 MyBatis 在内存中进行分页的。如果数据库中数据量较大，使用 RowBounds 会消耗较多的内存。
• 适合场景：RowBounds 适合数据量较小、临时分页或者较为简单的分页需求。

---

3. 使用 PageHelper 插件实现分页

虽然 RowBounds 可以满足基本的分页需求，但它的性能和易用性较差，特别是在面对大数据量时。因此，很多开发者选择使用 PageHelper 插件来简化分页的实现。

3.1 什么是 PageHelper？

PageHelper 是 MyBatis 的一个第三方插件，它提供了更加简洁和高效的分页功能。PageHelper 插件能够自动处理分页逻辑，通过在查询之前设置分页参数来实现分页查询，并且支持自动生成分页信息，如总页数、总记录数等。

3.2 配置 PageHelper 插件

在使用 PageHelper 插件之前，需要将插件添加到项目中，并在 MyBatis 配置中进行相应的设置。

1. 引入依赖（Maven）

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

2. 配置 MyBatis

在 mybatis-config.xml 中配置 PageHelper 插件：

<configuration>
    <plugins>
        <plugin interceptor="com.github.pagehelper.PageHelper">
            <property name="helperDialect" value="mysql"/>  <!-- 配置数据库方言 -->
            <property name="reasonable" value="true"/>
            <property name="supportMethodsArguments" value="true"/>
        </plugin>
    </plugins>
</configuration>

3.3 使用 PageHelper 实现分页

1. Mapper 接口：

import com.github.pagehelper.Page;
import org.apache.ibatis.annotations.Select;

import java.util.List;

public interface UserMapper {

    @Select("SELECT id, username, age FROM user")
    Page<User> getAllUsers();  // 返回 Page 类型，PageHelper 会自动处理分页
}

2. 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> getUsersByPage(int pageNum, int pageSize) {
        // 使用 PageHelper.startPage 开始分页
        PageHelper.startPage(pageNum, pageSize);
        
        // 查询数据
        List<User> userList = userMapper.getAllUsers();
        
        // 使用 PageInfo 包装查询结果，返回分页信息
        return new PageInfo<>(userList);
    }
}

3. Controller 层：

import com.github.pagehelper.PageInfo;
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.getUsersByPage(pageNum, pageSize);
    }
}

3.4 PageHelper 的优点

• 自动处理分页：PageHelper 会自动拦截 MyBatis 的查询，自动添加分页参数，简化了分页逻辑。
• 性能优化：PageHelper 在执行 SQL 查询时会直接在数据库层面进行分页查询，不需要将所有数据加载到内存中。
• 丰富的分页信息：PageHelper 会返回一个 PageInfo 对象，其中包含了当前页的数据、总记录数、总页数等信息，方便开发者进行分页展示。

---

4. 总结

分页是 Web 开发中常见的需求，MyBatis 提供了 RowBounds 和 PageHelper 两种常见的分页实现方式：

1. RowBounds：适用于小数据量和简单分页场景，但它会在内存中进行分页，不适合处理大数据量。
2. PageHelper：更适合大多数应用，提供了更加简洁和高效的分页功能，支持自动分页并且性能较好。

对于大多数 MyBatis 项目，建议使用 PageHelper 插件来实现分页，它不仅简化了分页操作，还能提高查询性能。