SpringBoot使用PageHelper实现数据分页

青旅半醒 2022-11-22 05:30 313阅读 0赞

# SpringBoot使用PageHelper实现数据分页 #

## 前言 ##

我们在做页面查询的时候由于页面无法一次性展示所有的数据，所以采用一种分段式的展示策略—分页查询，实现分页查询的方式有很多种方式，比如`sql`中的`limit`,`mybatisplus`带的分页插件等等，这里我们介绍一下如何在`SpringBoot`中使用`PageHelper`插件实现分页查询。

## 正文 ##

## PageHelper ##

**PageHelper**是针对`MyBatis`最方便的分页插件`PageHelper`支持任何复杂的单表，多表查询。  
它有以下特点：

*  `PageHelper`不支持嵌套结果映射.
 *  `PageHelper`本质上是两次查询，第一次是对记录总数量的查询，第二次是对记录的查询。
 *  对记录的查询是利用了`mybatis`提供的拦截器，取得`ThreadLocal`的`pageSize`和`pageNo`，重新拼装分页`sql`，完成分页。实际上是在`sql`后面拼接limit来实现的。

**limit**分页查询的弊端：

*  当`limit offset rows`中的`offset`很大时，会出现效率问题，所以数据规模大是不推荐使用`PageHelper`来实现分页。
 *  实际的开发过程中我们采用自己手写两次查询，在第二次对记录的查询是采用子查询的方式来对性能进行优化。

select * from test where val=4 limit 300000,5

优化成：

select * from test a inner join (select id from test where val=4 limit 300000,5) b on a.id=b.id

所以，如果在数据量不大的情况下可以使用`PageHelper`,否则就不推荐使用`PageHelper`了。

## SpringBoot使用PageHelper实现数据分页 ##

**Maven依赖**

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

**application.properties:配置类**

#Paging assistant configuration
    
    #配置数据库
    pagehelper.helper-dialect=mysql
    #页参数合理化
    pagehelper.reasonable=true
    #启用了分页,并且先执行了count后面的查询也拼接了limit
    pagehelper.support-methods-arguments=true
    #如果POJO或者Map中发现了countSql属性，就会作为count参数使用
    pagehelper.params=count=countSql
    
    #mybatis log
    mybatis.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

**PageRequestPam:请求的抽象类**

/** * 分页模糊查询请求的封装类 */
    @Setter
    @Getter
    @ToString
    public abstract class PageRequestPam implements Serializable { 
        private static final long serialVersionUID = 1L;
        private int pageNum; //页面序号
        private int pageSize;  //页面大小
    }

**UserInfoForSearchRes：请求类**

/** * 这是用户查询的封装类 */
    @Setter
    @Getter
    @ToString
    @ApiModel("用户查询请求类")
    public class UserInfoForSearchRes extends PageRequestPam { 
        private static final long serialVersionUID = -5625703056478578435L;
    
    
        @ApiModelProperty( notes = "用户名", example = "xiyuan666")
        private String userName;
    
    
        @ApiModelProperty( notes = "查询开始时间")
        private Date searchStartTime;
    
    
        @ApiModelProperty( notes = "查询结束时间")
        private Date searchEndTime;
    
    
    }

**PageUtils：分页的结果工具类**

public class PageUtils { 
        /** * 将分页信息封装到统一的接口 * @param pam * @param pageInfo * @return */
        public static Page getPageResult(PageRequestPam pam, PageInfo<?> pageInfo) { 
            Page page = new Page();
            page.setPageNo(pageInfo.getPageNum());
            page.setPageSize(pageInfo.getPageSize());
            page.setTotalSize(pageInfo.getTotal());
            page.setTotalPages(pageInfo.getPages());
            page.setValue(pageInfo.getList());
            return page;
        }
    }

**Page：分页结果的封装类**

/** * 分页查询的结果封装类 */
    @Data
    public class Page implements Serializable { 
        private static final long serialVersionUID = 1L;
        private int pageNo;//当前页
        private int pageSize;//当前页大小
        private long totalSize;//记录总数
        private int totalPages;//页码总数
        private Object value;
    }

## 验证 ##

**分页查询接口**

@PostMapping("/queryUserListPage")
    @ApiOperation(value = "用户分页模糊查询")
    @ControllerMethodLog
    public ResponseResult queryUserListPage(@RequestBody UserInfoForSearchRes userInfoForSearchRes) { 
        long startTime = System.currentTimeMillis();   //获取开始时间
        int pageNum = userInfoForSearchRes.getPageNum();
        int pageSize = userInfoForSearchRes.getPageSize();
        PageHelper.startPage(pageNum, pageSize);
        List<UserInfoPojo> list = userService.getUserInfoByPage(userInfoForSearchRes);
        Page page= PageUtils.getPageResult(userInfoForSearchRes, new PageInfo<UserInfoPojo>(list));
        long endTime = System.currentTimeMillis(); //获取结束时间
        log.info("用户模块分页查询-总条数：" + list.size() + "用时：" + (endTime - startTime) + "ms");
        return ResponseResult.success(page, ConstantsUtil.QUERY_SUCCESS);
    }

**通过[knife4j][]访问分页查询接口**

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDk5MDgxOA_size_16_color_FFFFFF_t_70_pic_center]  
**控制台打印信息**

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDk5MDgxOA_size_16_color_FFFFFF_t_70_pic_center 1]

## 源码 ##

项目源码可从的我的github中获取：[github源码地址][github]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDk5MDgxOA_size_16_color_FFFFFF_t_70_pic_center 2]

[knife4j]: http://127.0.0.1:8080/doc.html#/default/user-controller/queryUserListPageUsingPOST
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDk5MDgxOA_size_16_color_FFFFFF_t_70_pic_center]: /images/20221120/b36081586ddc4e5c8817c9a86bb7cfaf.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDk5MDgxOA_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221120/2b2cc1883ee640c7b81f39cfe67442a0.png
[github]: https://github.com/luo948521848/xiyuan-for-springboot-pageHelper
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDk5MDgxOA_size_16_color_FFFFFF_t_70_pic_center 2]: https://img-blog.csdnimg.cn/2020110320375087.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MDk5MDgxOA==,size_16,color_FFFFFF,t_70#pic_center