深入浅出mybatis分页

已于 2022-11-28 16:46:46 修改
阅读量784 收藏
点赞数 1
分类专栏： Spring和分布式全家桶 文章标签： mybatis java spring boot
于 2022-11-18 16:17:11 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_37151886/article/details/127921669
版权

MyBatis 分页插件 PageHelper

PageHelper

如何使用？

如何使用分页插件

1：添加依赖

        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper-spring-boot-starter</artifactId>
            <version>1.4.5</version>
        </dependency>

版本根据需要自行选择
https://mvnrepository.com/artifact/com.github.pagehelper/pagehelper-spring-boot-starter

第一步写一个没有分页的接口。

    @GetMapping("noPage")
    public java.util.List<Doc> list() {
        return mapper.selectList(null);
    }

这个我相信都可以写的出来。

第二步使用PageInfo包裹的接口

    @GetMapping("pageInfo")
    public PageInfo<Doc> pageInfo(Integer pageNum, Integer pageSize) {
        PageHelper.startPage(pageNum, pageSize);
        return new PageInfo<>(mapper.selectList(null));
    }

返回值省略list

{
  "total": 20,
  "list": [
  ],
  "pageNum": 2,
  "pageSize": 3,
  "size": 3,
  "startRow": 4,
  "endRow": 6,
  "pages": 7,
  "prePage": 1,
  "nextPage": 3,
  "isFirstPage": false,
  "isLastPage": false,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "navigatePages": 8,
  "navigatepageNums": [
    1,
    2,
    3,
    4,
    5,
    6,
    7
  ],
  "navigateFirstPage": 1,
  "navigateLastPage": 7
}

第三步使用Page包裹返回接口

    @GetMapping("page")
    public Page<Doc> page(Integer pageNum, Integer pageSize) {
        PageHelper.startPage(pageNum, pageSize);
        Page<Doc> page = (Page<Doc>) mapper.selectList(null);
        logger.info(page.toString());
        return page;
    }

测试发现page就是一个分页后的list，不带其他参数。

Page{count=true, pageNum=3, pageSize=4, startRow=8, endRow=12, total=20, pages=5, reasonable=false, 
pageSizeZero=false}

第四步将第三步的page对象放入构造函数。

    @GetMapping("pageToPageInfo")
    public PageInfo<Doc> pageToPageInfo(Integer pageNum, Integer pageSize) {
        PageHelper.startPage(pageNum, pageSize);
        Page<Doc> page = (Page<Doc>) mapper.selectList(null);
        return new PageInfo<>(page);
    }

第五步自定义PageResult作为返回值

@Data
public class PageResult<T> {

    private static final Logger logger = LoggerFactory.getLogger(PageResult.class);

    /**
     * 第几页
     */
    private int pageNum;
    /**
     * 页面大小
     */
    private int pageSize;
    /**
     * 总页数
     */
    private int pages;
    /**
     * 总数
     */
    private long total;
    /**
     * 数据
     */
    private List<T> list;

    /**
     * 构造函数
     *
     * @param list
     */
    public PageResult(List<T> list) {
        if (list instanceof Page) {
            Page<T> page = (Page<T>) list;
            this.pageNum = page.getPageNum();
            this.pageSize = page.getPageSize();
            this.pages = page.getPages();
            this.total = page.getTotal();
        }
        this.list = list;
    }
}

    @GetMapping("pageToPageResult")
    public PageResult<Doc> pageToPageResult(Integer pageNum, Integer pageSize) {
        PageHelper.startPage(pageNum, pageSize);
        return new PageResult<>(mapper.selectList(null));
    }

{
  "pageNum": 2,
  "pageSize": 3,
  "pages": 7,
  "total": 20,
  "list": [
  ]
}

借鉴了这段实现逻辑直接从Page中拿到所需参数。

在这里插入图片描述
之所以我们自定义的PageResult可以成功是因为 list instanceof Page 这一行代码，mapper.selectList 经过处理后返回的不是普通的List而是Page对象。

复杂分页

对象转换

一般来说我们拿到的DO和返回前端的VO不是同一个对象会进行相关处理，比如增删字段，这个时候如何正确分页呢？

先演示一个错误案例

    @GetMapping("changeV1")
    public PageInfo<DocQueryRespVO> changeV1(Integer pageNum, Integer pageSize) {
        PageHelper.startPage(pageNum, pageSize);
        List<Doc> sourceList = mapper.selectList(null);
        List<DocQueryRespVO> targetList = sourceList.stream().map((source) -> {
            DocQueryRespVO target = new DocQueryRespVO();
            BeanUtils.copyProperties(source, target);
            Integer docType = target.getDocType();
            String msg = DocTypeEnum.getMsgByCode(docType);
            target.setDocTypeName(msg);
            return target;
        }).collect(Collectors.toList());
        return new PageInfo<>(targetList);
    }

对原list每个对象修改字段值

{
  "total": 5,
  "list": [
  ],
  "pageNum": 1,
  "pageSize": 5,
  "size": 5,
  "startRow": 0,
  "endRow": 4,
  "pages": 1,
  "prePage": 0,
  "nextPage": 0,
  "isFirstPage": true,
  "isLastPage": true,
  "hasPreviousPage": false,
  "hasNextPage": false,
  "navigatePages": 8,
  "navigatepageNums": [
    1
  ],
  "navigateFirstPage": 1,
  "navigateLastPage": 1
}

可以看到这个total是错误的，应该是二十才对。分析一下为什么返回5。

    public PageInfo(List<? extends T> list) {
        this(list, DEFAULT_NAVIGATE_PAGES);
    }

    public PageInfo(List<? extends T> list, int navigatePages) {
        super(list);
   	}

    public PageSerializable(List<? extends T> list) {
        this.list = (List<T>) list;
        if(list instanceof Page){
            this.total = ((Page<?>)list).getTotal();
        } else {
            this.total = list.size();
        }
    }

依次点进去发现，由于instanceof 失败所以取了list的total导致失效。可以加入代码验证 instanceof 输出。

System.out.println(targetList instanceof Page);
方法一
    @GetMapping("changeV2")
    public PageInfo changeV2(Integer pageNum, Integer pageSize) {
		//省略部分代码
        PageInfo pageInfo = new PageInfo(sourceList);
        pageInfo.setList(targetList);
        return pageInfo;
    }

核心思想，利用泛型直接替换list保留原list中的分页信息。

方法二
    @GetMapping("changeV3")
    public PageInfo<DocQueryRespVO> changeV3(Integer pageNum, Integer pageSize) {     
     	//省略部分代码  
        return PageHelperUtil.pageInfoCopy(sourceList, targetList);
    }

封装一个工具类

    public static <source, target> PageInfo<target> pageInfoCopy(List<source> sList, List<target> tList) {
        if (org.springframework.util.CollectionUtils.isEmpty(sList) ||
                org.springframework.util.CollectionUtils.isEmpty(tList)) {
            return null;
        }
        PageInfo<source> sourcePage = new PageInfo<>(sList);
        PageInfo<target> targetPage = new PageInfo<>(tList);
        org.springframework.beans.BeanUtils.copyProperties(sourcePage, targetPage);
        targetPage.setList(tList);
        return targetPage;
    }

核心思想利用BeanUtils.copyProperties将分页信息拷贝过来，仅仅替换list数据。

手动分页

    public static <T> PageInfo<T> pageManual(List<T> list, int pageNum, int pageSize) {
        PageInfo<T> pageInfo = new PageInfo<>();
        //计算总页数
        int total = list.size();
        //如果总数为0直接返回
        if (total == 0) {
            return pageInfo;
        }
        // 计算最大页数
        int pageNumTotal;
        if (total <= pageSize) {
            pageNumTotal = 1;
        } else {
            pageNumTotal = total % pageSize == 0 ? (total / pageSize) : (total / pageSize) + 1;
        }
        //超出最大页码返回最后一页
        if (pageNum > pageNumTotal) {
            pageNum = pageNumTotal;
        }
        //如果页码 <= 0 返回第一页
        if (pageNum <= 0) {
            pageNum = 1;
        }
        //开始分页
        int st;
        int et;
        // 1 <= pageNum <= pageNumTotal
        if (pageNum < pageNumTotal) {
            st = (pageNum - 1) * pageSize;
            et = st + pageSize;
        } else {
            st = (pageNum - 1) * pageSize;
            et = total;
        }
        //subList包含st-et-1
        List<T> result = list.subList(st, et);
        pageInfo.setPageNum(pageNum);
        pageInfo.setPageSize(pageSize);
        pageInfo.setList(result);
        pageInfo.setTotal(total);
        pageInfo.setPages(pageNumTotal);
        pageInfo.setIsLastPage(pageNumTotal == pageSize);
        return pageInfo;
    }

mybatisplus

分页插件

BaseMapper

主要分页方法

    <P extends IPage<T>> P selectPage(P page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
    
    <P extends IPage<Map<String, Object>>> P selectMapsPage(P page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

如何使用

第一步注册插件

    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }

第二步写一个简单的接口

    @GetMapping("selectPage")
    public Page<Doc> selectPage(Integer pageNum, Integer pageSize) {
        return mapper.selectPage(new Page<>(pageNum, pageSize), null);
    }

分页结果

{
  "records": [
    {
    },
    {
    },
    {
    },
    {
    },
    {
    }
  ],
  "total": 35,
  "size": 5,
  "current": 1,
  "orders": [],
  "optimizeCountSql": true,
  "searchCount": true,
  "countId": null,
  "maxLimit": null,
  "pages": 7
}

原理

MybatisAutoConfiguration 中关键代码如下

  public MybatisAutoConfiguration(MybatisProperties properties, ObjectProvider<Interceptor[]> interceptorsProvider,
      ObjectProvider<TypeHandler[]> typeHandlersProvider, ObjectProvider<LanguageDriver[]> languageDriversProvider,
      ResourceLoader resourceLoader, ObjectProvider<DatabaseIdProvider> databaseIdProvider,
      ObjectProvider<List<ConfigurationCustomizer>> configurationCustomizersProvider,
      ObjectProvider<List<SqlSessionFactoryBeanCustomizer>> sqlSessionFactoryBeanCustomizers) {
	
    this.interceptors = interceptorsProvider.getIfAvailable();

  }

当我们注册 MybatisPlusInterceptor 这个 bean后，interceptorsProvider.getIfAvailable()可以拿到Interceptor。

复杂分页

对象转换

        Page page = mapper.selectPage(new Page<>(pageNum, pageSize), null);
        List<Doc> records = page.getRecords();
        return page.setRecords(targetList);

和上面的差不多，都是取消泛型的编译检查来完成分页。

newProxyInstance
关注
专栏目录
带你深入浅出MyBatis技术原理与实战（PDF实战实践）
m0_67698950的博客
07-28 454
这些场景在大量的编码中使用，具备较强的实用价值，这些内容都是通过实战得来的，供读者们参考。以及针对映射器这个MyBatis最强大的工具，也是我们使用MyBatis时用得最多的工具，一个详细的讲解，让你能熟练掌握。本文主要讲解了Mybatis的应用，解析了其原理，从而形成一个完整的知识体系，以讲解MyBatis基础运用和原理为主，所以适合初级到中高级开发人员阅读。对SQL有了详细的阐述和mybatis底层的设计和实现原理（原理本就意味着难懂，对初学者来说建议多阅读几遍反复推敲还是能够掌握的）......
深入浅出Mybatis技术原理与实战
qq_36789243的博客
08-27 1362
文章目录Mybatis简介传统的JDBC编程Hibernate与MybatisMybatis入门SqlSessionFactorySqlSession映射器MapperMybatis组件的生命周期配置propertiestypeAliasestypeHandler自定义typeHandler枚举类型typeHandler自定义枚举类typeHandlerobjectFactoryenvironments数据库事务映射器select元素自动映射传递多个参数使用resultMap映射结果集insert元素主键.
2020.11.02 mybatis-分页
sunxing1002的博客
11-04 656
分页详解
第五章：mybatis-plus 分页
lin000_0的博客
10-08 712
mybatis-plus 分页
mybatis-plus分页查询的实现实例
最新发布
chinaherolts2008的博客
08-01 190
页查询是一项常用的数据库查询方法,本文主要介绍了mybatis-plus分页查询的实现实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧。mybatis-plus中的分页查询功能，需要PaginationInnerInterceptor分页插件的支持，否则分页查询功能不能生效。4、和经典的PageHelper分页插件进行了对比。先执行count查询查询满足条件的记录总数，然后执行limit分页查询，查询分页记录，说明分页查询生效。
关于 SELECTPAGE 方法的使用
weixin_41629964的博客
12-15 7010
源码 /** * 根据 entity 条件，查询全部记录（并翻页） * * @param page 分页查询条件（可以为 RowBounds.DEFAULT） * @param queryWrapper 实体对象封装操作类（可以为 null） */ <P extends IPage<T>> P selectPage(P page, @Param(Constants.WRAPPER) W...
万能的分页类
qq_48169881的博客
03-11 182
万能的分页类 关于对万能的分页类的想法，对于前端传送过来的分页查询我们总是要规定相应的类，而且这个类包含了分页的属性和参数。从软件工程和开发的角度来看，分页的参数是一个整体的分页类，而其他的关于这个查询条件一般也可以分装成一个类，通常我们会通过继承的方式 查询条件的类继承分页类来组成我们现在的这个包含分页信息和查询条件的类，在实现上这个是没有问题的，但是在逻辑上这似乎又有点不合理，分页参数类和条件参数类并不存在继承的关系而且分页参数类是可以独立与条件查询参数类之外的。他们两个如果真的要组成一个分页条件条件查
mybatis-plus快速使用和分页及构造器的使用
祁_z
07-22 1410
官网 1. pom <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.1.2</version> ...
深入浅出MyBatis技术原理与实战.杨开振(详细书签)
11-30
这本书《深入浅出MyBatis技术原理与实战》由杨开振编著，旨在帮助初学者系统地理解和掌握MyBatis，提升到精通的层次。 首先，MyBatis的核心概念包括XML配置文件和注解方式。XML配置文件是MyBatis的传统方式，用于...
电子书-深入浅出Mybatis技术原理与实战
05-06
《深入浅出Mybatis技术原理与实战》这本书是针对Mybatis这一流行持久层框架的一份详尽指南。Mybatis是一个优秀的Java ORM（对象关系映射）框架，它允许开发者将数据库操作与应用程序逻辑分离，提高了代码的可读性...
深入浅出MyBatis技术原理与实战.pdf
08-21
MyBatis提供插件扩展能力，可以通过拦截器实现SQL执行前后的增强，如PageHelper分页插件、LogInterceptor日志插件等。 八、事务管理 MyBatis支持手动和自动两种事务管理方式。在手动模式下，开发者需要自行调用...
通用分页之详解】
m0_74018330的博客
06-27 141
*** 分页工具类// 页码 private int rows = 10;// 页大小 private int total = 0;// 总记录数 private boolean pagination = true;// 是否分页 public PageBean() {super();} /*** 获得起始记录的下标* @return} }book . setBname("圣墟");} } }
mybatis-pagehelper实现分页
weixin_57128596的博客
01-22 1362
1.首先定义一个实体类，属性为页码、每页数据量 package com.yanzhen.utils; import java.io.Serializable; public class Entity implements Serializable { private Integer page; private Integer limit; public Integer getPage() { return page; } public v
Parameter ‘pageNum‘ not found. Available parameters are [arg1, arg0, param1, param2]
qq_52889347的博客
11-15 3670
Parameter 'pageNum' not found. Available parameters are [arg1, arg0, param1, param2]报错原因以及解决方法
MyBatis-plus实现查询分页方法
Jtyazs的博客
11-12 7679
config.MybatisPlusConfig.java：配置类，配置mybatisplus的插件功能。@MapperScan("com.guigu.mapper") //可以将启动类中的注解移到此处/*** 1 怎么来配置mybatis-plus中的插件？* 这里所需要的类型是MybatisPlusInterceptor，这是mybatis-plus的一个拦截器，用于配置mybatis-plus中的插件。* 2 为什么要使用拦截器MybatisPlusInterceptor呢。
MyBatis-Plus3 分页 注解方式
我是疯子的博客
07-22 4115
MyBatis-Plus3 分页 注解方式官网例子第一种方法,根据官方给的例子配置：第二种方法，自己注释写SQL 官网例子 selectPage ：https://mp.baomidou.com/guide/crud-interface.html#selectpage /** * <p> * 根据 entity 条件，查询全部记录（并翻页） * </p> * * ...
关于若依分页插件失效的问题 解决方案
weixin_45701370的博客
04-24 706
解决若依框架 返回列表是增加新属性时列表显示不正常问题
JAVA PageInfo实现分页数据获取与展示
鸟人的博客
02-28 7047
servlet中怎么实现大数据分页获取呢？ servlet层（controller层，控制层） 前端分页显示 pageinfo类源码 package com.github.pagehelper; import java.util.Collection; import java.util.List; public class PageInfo extends PageSerializable {.........
Mybatis-Plus：Mybatis增强工具
weixin_64022848的博客
12-07 1134
官网：https://baomidou.com/MyBatis-Plus（简称 MP，是由baomidou(苞米豆)组织开源的）是一个基于 MyBatis 的增强工具，它对 Mybatis 的基础功能进行了增强，但未做任何改变。使得我们可以在 Mybatis 开发的项目上直接进行升级为 Mybatis-plus，正如它对自己的定位，它能够帮助我们进一步简化开发过程，提高开发效率。
深入浅出mybatis技术原理与实战
08-02
MyBatis是一个流行的Java持久化框架，它提供了一种简单且灵活的方式来访问数据库。...总结起来，深入浅出地学习MyBatis的技术原理和实战经验，可以帮助我们更好地理解和应用这个持久化框架，提高开发效率和代码质量。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值