十二、MyBatis分页插件

2025-02-08 12

版权

本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

简介： 十二、MyBatis分页插件

@[toc]

十二、分页插件

12.1 分页插件使用步骤

1. 添加依赖

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

2. 配置分页插件

在MyBatis的核心配置文件中配置插件

<plugins>
    <!--设置分页插件-->
    <plugin interceptor="com.github.pagehelper.PageInterceptor"></plugin>
</plugins>

3. 在查询接口之前写上

PageHelper.startPage(int pageNum, int pageSize)

12.2 分页插件的使用

在查询功能之前使用PageHelper.startPage(int pageNum, int pageSize)开启分页功能
- pageNum：当前页的页码
- pageSize：每页显示的条数
在查询获取list集合之后，使用PageInfo\ pageInfo = new PageInfo<>(List\ list, int navigatePages)获取分页相关数据
- list：分页之后的数据
- navigatePages：导航分页的页码数

分页相关数据
```
PageInfo{
    pageNum=8, pageSize=4, size=2, startRow=29, endRow=30, total=30, pages=8,
    list=Page{count=true, pageNum=8, pageSize=4, startRow=28, endRow=32, total=30,
    pages=8, reasonable=false, pageSizeZero=false},
    prePage=7, nextPage=0, isFirstPage=false, isLastPage=true, hasPreviousPage=true,
    hasNextPage=false, navigatePages=5, navigateFirstPage4, navigateLastPage8,
    navigatepageNums=[4, 5, 6, 7, 8]
}
```
常用数据：
- pageNum：当前页的页码
- pageSize：每页显示的条数
- size：当前页显示的真实条数
- total：总记录数
- pages：总页数
- prePage：上一页的页码
- nextPage：下一页的页码
- isFirstPage/isLastPage：是否为第一页/最后一页
- hasPreviousPage/hasNextPage：是否存在上一页/下一页
- navigatePages：导航分页的页码数
- navigatepageNums：导航分页的页码，[1,2,3,4,5]

12.3 测试案例

/**
     * 使用MyBatis的分页插件实现分页功能：
     * 1.需要在查询功能之前开启分页才能声小
     * PageHelper.startPage(int pageNum, int pageSize)
     * 2.在查询功能之后获取分页相关信息
     * PageInfo<Brand> pageInfo = new PageInfo<>(brandList, 5);
     * list: 表示分页业数据
     * navigatePages：表示当前导航分页的数量
     **/
    @Test
    public void testMyBatis3(){
        try {
            InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
            SqlSession sqlSession1 = sqlSessionFactory.openSession(true);
            BrandMapper brandMapper = sqlSession1.getMapper(BrandMapper.class);
            PageHelper.startPage(2, 5);
            List<Brand> brandList = brandMapper.selectByExample(null);
            PageInfo<Brand> pageInfo = new PageInfo<>(brandList, 5);
            brandList.forEach(System.out::println);
            System.out.println(pageInfo);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }