MyBatis中使用第三方分页插件PageHelper完成分页功能

MyBatis中使用第三方分页插件PageHelper完成分页功能

文章目录 一、前言二、基于插件拦截方式1、自定义插件2、使用第三方插件完成分页1、分页插件的配置2、分页插件的使用

一、前言

分页是web应用程序非常重要的一个技术。数据库中的数据可能是成千上万的,不可能把这么多的数据一次显示在浏览器上面。一般根据每行数据在页面上所占的空间每页显示若干行,比如一般20行是一个比较理想的显示状态。

对于MyBatis中分页的操作其实是有两种,一种是基于参数的改造, 还有一种是基于插件的拦截。

对于参数的改造,可以直接使用通过添加参数limit和offset就可以实现查询从某个位置开始的若干记录,代码实现如下所示:

SELECT * FROM sometable ORDER BY somecolumn LIMIT #{limit} OFFSET #{offset}

这段 SQL 语句会返回从偏移量为 offset 的位置开始的limit条结果。例如:LIMIT 30,10 表示从第 31 行开始返回10行结果。

在实际应用中,我们可以将limit和 offset 抽取成两个参数,并传入到 MyBatis 中 这种方法在这里就不怎么介绍了,这里主要介绍的是通过基于插件拦截的方式解决分页问题

二、基于插件拦截方式 1、自定义插件

我们可以通过插件的方式来实现, 这种方式更加灵活,支持实现更为复杂的分页功能。我们需要自定义一个拦截器,实现Interceptor接口,并重写其中唯一的intercept方法,在其中对 SQL 语句进行修改,添加分页信息。具体操作如下,首先自己定义一个拦截器

下面写的全是伪代码,不能直接运行的,这里只是为了引出pagehelper

public class PageInterceptor implements Interceptor { /** * 拦截方法 * * @param invocation * @return * @throws Throwable */ @Override public Object intercept(Invocation invocation) throws Throwable { // 获取原始的SQL语句 String sql = (String) invocation.getArgs()[0]; // 查询总数并计算出总页数和当前页 int total = count(sql); // 如果总数小于等于0,则直接返回空结果集 if (total return sql + " LIMIT " + offset + "," + limit; } /** * @author Jeff Fong * @description 获取总的条数 * @date 2023/5/22 14:03 * @param: sql * @return int **/ private int count(String sql){ // code omitted return 1; } /** * @author Jeff Fong * @description 计算出当页的offset * @date 2023/5/22 14:02 * @param: pageNo * @param: pageSize * @return int **/ private int getOffset(int pageNo, int pageSize) { return (pageNo - 1) * pageSize; }}

然后,我们需要在 mybatis-config.xml 配置文件中注册该拦截器:

最后,在业务代码中就可以直接使用

public List selectUserListByPage(int startRow, int pageSize){ RowBounds rowBounds = new RowBounds(startRow,pageSize); String statement = "com.example.UserMapper.selectUserList"; return sqlSession.selectList(statement,null,rowBounds); } 2、使用第三方插件完成分页

这里使用的插件是PageHelper, 在https://pagehelper.github.io/docs/howtouse/有关于这个插件的介绍。

1、分页插件的配置

(1)、添加依赖

com.github.pagehelper pagehelper 5.2.0

(2)、配置分页插件 在MyBatis的核心配置文件中配置插件

一定要注意plugins分页插件在mybatis-config.xml的位置,位置如果不对的话,是会直接报错的。

2、分页插件的使用

在需要分页的数据之前使用PageHelper.startPage(int pageNum, int pageSize)开启分页功能

pageNum:当前页的页码pageSize:每页显示的条数

在查询获取list集合之后,使用PageInfo pageInfo = new PageInfo(List list, int navigatePages)获取分页相关数据。

list:分页之后的数据navigatePages:导航分页的页码数

看看具体的代码实现,对于mapper中的接口比较简单,这里就不一一的说明;

/** * limit index,pagesize * index 当前页的起始索引 * pageSize 每页显示的条数 * pageNum 当前页的页码 * 当前页的起始索引 = 每页条数 * 页码 - 1 * index = pageNum * pageSize - 1 * * 通过索引获得数据 * * 使用MyBatis的分页插件,实现分页功能: * 1。需要在查询功能之前开启分页 * PageHelper.startPage(2, 4); * * 2。在查询功能之后获取分页相关信息 * PageInfo pages = new PageInfo(emps, 5); 5表示导航分页的数量 */ @Test public void test02() throws IOException { SqlSession sqlSession = getSqlSession(); UserMapper mapper = sqlSession.getMapper(UserMapper.class); System.out.println(" 查询功能前启用插件....."); PageHelper.startPage(2, 4); List all = mapper.findAll(); all.forEach(System.out::println); System.out.println(" "); PageInfo pages = new PageInfo(all,); System.out.println("-------->" + pages); }

实际上的所有数据 查询第二页的数据,应该是 最后来看看最终的返回的详细数据: 看到所需要的数据,都在pageinfo对象中 首先来提一嘴 这里的navigatepages是什么东西? 就是相当于前端要显示的下面导航栏的东西 这里的navigatepages = [1,2,3,4,5....., 11]


比丘资源网 » MyBatis中使用第三方分页插件PageHelper完成分页功能

发表回复

提供最优质的资源集合

立即查看 了解详情