Java中Mybatis分页查询的四种传参方式

1. 前言

在使用 Mybatis 进行分页查询时，我们需要传递分页参数给 Mybatis，以告知查询的起始位置和数量。这篇文章将会详细介绍 Java 中 Mybatis 分页查询的四种传参方式。

1. 前置条件

在介绍 Mybatis 分页查询的传参方式之前，需要先完成如下准备工作：

• 导入 Mybatis 和 Mybatis-spring 的 jar 包
• 编写 Mybatis 配置文件（mybatis-config.xml）
• 编写 Mybatis 映射文件（mapper.xml）
• 配置 Spring 配置文件（applicationContext.xml）

本文假设你已经完成了上述准备工作。

1. 传参方式

3.1 基于注解的方式

我们可以在 Mapper 接口方法上使用 Mybatis 提供的注解 @Param 和 @SelectProvider，如下所示：

@SelectProvider(type = MybatisSqlProvider.class, method = "selectUsersByPage")
List<User> selectUsersByPage(@Param("start") int start, @Param("pageSize") int pageSize);

在这个例子中，我们使用了 @Param 注解来指定查询的起始位置和每页数量，并使用了 @SelectProvider 注解来指定动态生成 SQL 的方法。

下面是 MybatisSqlProvider 类的实现，它根据传入的参数动态生成 SQL 语句：

public class MybatisSqlProvider {
    public String selectUsersByPage(int start, int pageSize) {
        StringBuilder sb = new StringBuilder();
        sb.append("SELECT * FROM user ");
        sb.append("LIMIT #{start}, #{pageSize}");
        return sb.toString();
    }
}

使用该种方式，我们只需要在 Mapper 接口方法上添加注解即可，使用起来非常方便。

3.2 基于 RowBounds 的方式

我们可以使用 RowBounds 对象来进行分页查询，如下所示：

List<User> selectUsersByPage(RowBounds rowBounds);

在这个例子中，我们直接传入 RowBounds 对象，RowBounds 对象包含起始位置和数量两个属性。

下面是使用 RowBounds 进行分页查询的代码示例：

SqlSession sqlSession = sqlSessionFactory.openSession();

RowBounds rowBounds = new RowBounds(0, 3);
List<User> userList = sqlSession.selectList("com.example.mapper.UserMapper.selectUsersByPage", null, rowBounds);

for (User user : userList) {
    System.out.println(user);
}

在这个例子中，我们使用 RowBounds 对象进行分页查询，查询起始位置为 0，查询数量为 3。

3.3 基于 PageHelper 的方式

我们可以使用 Mybatis 的插件 PageHelper 来完成分页查询，如下所示：

PageHelper.startPage(int pageNum, int pageSize);
List<User> selectUsersByPage();

在这个例子中，我们使用 PageHelper 提供的静态方法 startPage 来指定查询的起始位置和每页数量。

下面是使用 PageHelper 进行分页查询的代码示例：

SqlSession sqlSession = sqlSessionFactory.openSession();

PageHelper.startPage(1, 3);
List<User> userList = sqlSession.selectList("com.example.mapper.UserMapper.selectUsersByPage");

for (User user : userList) {
    System.out.println(user);
}

在这个例子中，我们使用 PageHelper 进行分页查询，查询第一页，每页数量为 3。

3.4 基于分页拦截器的方式

我们可以编写自己的拦截器来实现分页查询，如下所示：

List<User> selectUsersByPage(int start, int pageSize);

在这个例子中，我们直接传入查询的起始位置和每页数量两个参数。

下面是使用自定义拦截器进行分页查询的代码示例：

SqlSession sqlSession = sqlSessionFactory.openSession();

int start = 0;
int pageSize = 3;

Map<String, Object> paramMap = new HashMap<String, Object>();
paramMap.put("start", start);
paramMap.put("pageSize", pageSize);

List<User> userList = sqlSession.selectList("com.example.mapper.UserMapper.selectUsersByPage", paramMap);

for (User user : userList) {
    System.out.println(user);
}

在这个例子中，我们编写了自己的分页拦截器，使用 Map 对象传递查询的起始位置和每页数量两个参数。

1. 总结

通过本文的介绍，我们了解了 Java 中 Mybatis 分页查询的四种传参方式：

• 基于注解的方式
• 基于 RowBounds 的方式
• 基于 PageHelper 的方式
• 基于分页拦截器的方式

其中，基于 PageHelper 的方式最为常用，使用起来简单方便。在实际开发中，应根据具体情况选择合适的方式进行分页查询。