pagehelper 用法(一)

2024年2月3日发(作者：)

pagehelper 用法(一)

PageHelper用法详解

PageHelper是什么？

PageHelper是一款基于MyBatis的分页插件，可以帮助我们快速实现分页功能，提升系统性能。

PageHelper的安装

首先，需要在Maven的文件中添加以下依赖：

pagehelper

最新版本号

然后，在MyBatis的配置文件中加入PageHelper插件：

基本用法

下面是PageHelper的一些基本用法：

• 开启分页

(pageNum, pageSize);

这行代码会将pageNum和pageSize传递给PageHelper，告诉它要显示的是第几页和每页显示多少条数据。

• 查询数据 在分页前，需要先执行查询数据的操作，例如：

List userList = ();

这里的findAllUsers()方法是自定义的查询数据的方法。

• 获取分页结果

PageInfo pageInfo = new PageInfo<>(userList);

• 获取分页信息

int pageNum = (); //

当前页码

int pageSize = (); //

每页显示条数

long total = (); //

总条数

int pages = (); //

总页数

boolean isFirstPage = (); //

是否为第一页

boolean isLastPage = (); //

是否为最后一页

• 遍历分页数据

List list = ();

for (User user : list) {

//

处理每一条数据

}

高级用法

除了基本的用法外，PageHelper还提供了一些高级用法，例如：

• 设置排序

("id desc"); //

根据id降序排序

• 设置统计总数

(false); //

不统计总数，可以提高性能

• 设置分页边界

(pageNum); //

当页码超出总页数时，自动调整为最后一页或第一页

• 设置合理化参数

(true); //

当pageNum超出总页数时，自动调整为最后一页

总结

通过PageHelper插件，我们可以轻松实现MyBatis的分页功能。基本用法包括开启分页、查询数据、获取分页结果和遍历分页数据，高级用法包括设置排序、统计总数和分页边界等。使用PageHelper可以简化代码实现，并提升系统性能。

分页插件的基本原理

PageHelper的分页功能是基于拦截器设计的，当执行查询数据库的方法时，PageHelper会拦截该方法，通过改写SQL语句实现分页功能。

PageHelper会根据传入的pageNum和pageSize参数自动拼接SQL语句，将查询数据的SQL改写为分页查询的SQL。同时，PageHelper还会根据页码和每页显示条数来计算需要查询的数据范围，并在SQL语句中加入相应的限制条件。

常用方法的详细讲解

开启分页

开启分页的方法为：

(pageNum, pageSize);

这行代码会将pageNum和pageSize传递给PageHelper，告诉它要显示的是第几页和每页显示多少条数据。

查询数据

在开启分页之前，需要先执行查询数据的操作，例如：

List userList = ();

这里的findAllUsers()方法是自定义的查询数据的方法。

获取分页结果

获取分页结果的方法为：

PageInfo pageInfo = new PageInfo<>(userList);

这个方法可以将查询结果装入PageInfo对象中，以便后续使用。

获取分页信息

可以通过PageInfo对象来获取分页的相关信息，例如：

int pageNum = (); //

当前页码

int pageSize = (); //

每页显示条数

long total = (); //

总条数

int pages = (); //

总页数

boolean isFirstPage = (); //

是否为第一页

boolean isLastPage = (); //

是否为最后一页

遍历分页数据

遍历分页数据可以使用PageInfo对象的getList()方法来获取到数据列表，然后进行处理：

List userList = ();

for (User user : userList) {

//

处理每一条数据

}

高级用法的详细讲解

设置排序

设置排序的方法为：

("id desc"); //

根据id降序排序

可以在分页之前使用orderBy()方法来指定排序的字段和排序方式。

设置统计总数

设置统计总数的方法为：

(false); //

不统计总数，可以提高性能

如果不需要统计总数，可以通过调用count(false)方法来关闭统计总数的功能。这样可以提高查询性能。

设置分页边界

设置分页边界的方法为：

(pageNum); //

当页码超出总页数时，自动调整为最后一页或第一页

通过调用boundaryPage()方法，可以设置当页码超出总页数时，是否自动调整为最后一页或第一页。默认情况下，PageHelper会自动调整为最后一页。

设置合理化参数

设置合理化参数的方法为：

(true); //

当pageNum超出总页数时，自动调整为最后一页

通过调用reasonable()方法，可以设置当页码超出总页数时，是否自动调整为最后一页。如果设置为true，则会自动调整为最后一页，否则不做调整。

总结

PageHelper是一个非常实用的分页插件，在使用MyBatis进行数据查询时，通过简单的配置和几行代码，就能快速实现分页功能。不仅可以进行基本的分页操作，还提供了一些高级用法，能够满足各种复杂的分页需求。通过使用PageHelper插件，可以大大提升系统的开发效率和性能。