How is MyBatis PageHelper used?

1 year ago
Emily Johnson
2 minutes

MyBatis PageHelper is a plugin used for pagination that assists us in implementing pagination when querying with MyBatis.

使用 PageHelper，需要先在项目中添加 PageHelper 的依赖。然后，在 MyBatis 的配置文件中配置 PageHelper 插件。

The example code is shown below:

1. Add dependencies:

<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper</artifactId>
    <version>latest-version</version>
</dependency>

2. Set up PageHelper:
Add the PageHelper plugin configuration to the MyBatis configuration file, as shown in the example code below:

<plugins>
    <plugin interceptor="com.github.pagehelper.PageInterceptor">
        <property name="dialect" value="mysql"/>
        <!-- 其他配置项如：helperDialect, reasonable, supportMethodsArguments, autoRuntimeDialect, params, rowBoundsWithCount, pageSizeZero, closeConn, defaultCount -->
    </plugin>
</plugins>

3. Performing paginated queries with PageHelper:
In the method where paginated queries are needed, use the PageHelper.startPage method to specify the page number and number of items per page, and then perform the query operation. Sample code is as follows:

import com.github.pagehelper.PageHelper;
import java.util.List;

public class UserDao {
    public List<User> getUsers(int pageNum, int pageSize) {
        // 使用 PageHelper.startPage 方法指定页数和每页显示的数量
        PageHelper.startPage(pageNum, pageSize);
        // 进行查询操作
        List<User> userList = userMapper.selectUsers();
        return userList;
    }
}

This is the basic usage of using MyBatis PageHelper for pagination. We can further customize the settings by configuring PageHelper to meet specific requirements.

bannerAds