Spring boot Mybatis-XML方式分页查询PageHelper(五)

PageHelper介绍

  • PageHelper是Github上有位开发者写了一个分页插件,可以很方便的添加到MyBatis的拦截器接口中。 Github项目地址

pom.xml添加依赖

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

配置文件编写

@Configuration
public class MyBatisConfiguration {
    @Bean
    public PageHelper pageHelper(){
        PageHelper pageHelper=new PageHelper();
        Properties p=new Properties();
        // 当该参数设置为 true 时,会将 RowBounds 中的 offset 参数当成 pageNum 使用,可以用页码和页面大小两个参数进行分页。
        p.setProperty("offsetAsPageNum","true");
        // 当该参数设置为true时,使用 RowBounds 分页会进行 count 查询。
        p.setProperty("rowBoundsWithCount","true");
        //当该参数设置为 true 时,pageNum<=0 时会查询第一页, pageNum>pages(超过总数时),会查询最后一页。
        p.setProperty("reasonable","true");
        pageHelper.setProperties(p);
        return pageHelper;
    }
}

测试类

@RestController
public class StudentController {
    @Autowired
    private StudentService studentService;
    @RequestMapping("/queryStudentList")
    public List<Student> queryStudentList(int pageNum,int pageSize){
        //pageNum页码,pageSize条数
        PageHelper.startPage(pageNum,pageSize);
        return studentService.queryList();
    }
}

测试

  • 所有数据

所有数据.png

  • 分页数据

分页数据.png

使用pagehelper-spring-boot-starter代替PageHelper

PageHelper-Spring-Boot-Starter 帮助你集成分页插件到 Spring Boot比pagehelper更简单

替换依赖

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

#替换为
<dependency>
      <groupId>com.github.pagehelper</groupId>
      <artifactId>pagehelper-spring-boot-starter</artifactId>
     <version>1.2.1</version>
</dependency>

yml文件配置

spring:
  ########################################################
  ###Druid -- mysql的数据库配置.
  ########################################################
  datasource:
    druid:
      url: jdbc:mysql://localhost:3306/test?characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true
      username: root
      password: root
      driver-class-name: com.mysql.jdbc.Driver
      #下面为连接池补充设置应用到上面所有数据源中
      #初始化大小,最小,最大
      initialSize: 5
      minIdle: 5
      maxActive: 20
      #配置获取连接等待超时的时间
      maxWait: 60000
      #配置间隔多久才进行一次检测,检测需要关闭的空闲连接,单位是毫秒
      timeBetweenEvictionRunsMillis: 60000
      # 配置一个连接在池中最小生存的时间,单位是毫秒
      minEvictableIdleTimeMillis: 300000
      validationQuery: SELECT 1
      testWhileIdle: true
      testOnBorrow: false
      testOnReturn: false
      # 打开PSCache,并且指定每个连接上PSCache的大小
      poolPreparedStatements: true
      maxPoolPreparedStatementPerConnectionSize: 20
      # 配置监控统计拦截的filters,去掉后监控界面sql无法统计,'wall'用于防火墙
      filters: stat,wall,log4j
      # 通过connectProperties属性来打开mergeSql功能;慢SQL记录
      connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000
      # 合并多个DruidDataSource的监控数据
      useGlobalDataSourceStat: true
      web-stat-filter:
        url-pattern: /*
        exclusions: /druid/*,*.js,*.gif,*.jpg,*.png,*.css,*.ico
      stat-view-servlet:
        url-pattern: /druid/*
        #登陆账号密码
        login-username: guoadmin
        login-password: guoadmin
        #是否可以重置
        reset-enable: false
        #白名单
        #allow: 127.0.0.1
        #黑名单
        #deny: 127.0.0.1




########################################################
###mybatis配置.
########################################################

mybatis:
    mapperLocations: classpath:mybatis/*/*.xml
    # 给实体类起别名
    type-aliases-package: com.springboot.backstage.entity

########################################################
###分页插件
########################################################
pagehelper:
  helper-dialect: mysql
  #当该参数设置为 true 时,pageNum<=0 时会查询第一页, pageNum>pages(超过总数时),会查询最后一页。
  reasonable: true
  #支持通过 Mapper 接口参数来传递分页参数,默认值false,分页插件会从查询方法的参数值中,自动根据上面 params 配置的字段中取值,查找到合适的值时就会自动分页
  support-methods-arguments: true
  #为了支持startPage(Object params)方法,增加了该参数来配置参数映射,用于从对象中根据属性名取值, 可以配置 pageNum,pageSize,count,pageSizeZero,reasonable
  params: count=countSql

测试

可以重复上面的测试方法看是否有效

PageHelper的参数详解和PageInfo的使用

参数说明

  • helperDialect:分页插件会自动检测当前的数据库链接,自动选择合适的分页方式。 你可以配置helperDialect属性来指定分页插件使用哪种方言。配置时,可以使用下面的缩写值:oracle,mysql,mariadb,sqlite,hsqldb,postgresql,db2,sqlserver,informix,h2,sqlserver2012,derby 特别注意:使用 SqlServer2012 数据库时,需要手动指定为 sqlserver2012,否则会使用 SqlServer2005 的方式进行分页。 你也可以实现 AbstractHelperDialect,然后配置该属性为实现类的全限定名称即可使用自定义的实现方法。
  • offsetAsPageNum:默认值为 false,该参数对使用 RowBounds 作为分页参数时有效。 当该参数设置为 true 时,会将 RowBounds 中的 offset 参数当成 pageNum 使用,可以用页码和页面大小两个参数进行分页。
  • rowBoundsWithCount:默认值为false,该参数对使用 RowBounds 作为分页参数时有效。 当该参数设置为true时,使用 RowBounds 分页会进行 count 查询。
  • pageSizeZero:默认值为 false,当该参数设置为 true 时,如果 pageSize=0 或者 RowBounds.limit = 0 就会查询出全部的结果(相当于没有执行分页查询,但是返回结果仍然是 Page 类型)。
  • reasonable:分页合理化参数,默认值为false。当该参数设置为 true 时,pageNum<=0 时会查询第一页, pageNum>pages(超过总数时),会查询最后一页。默认false 时,直接根据参数进行查询。
  • params:为了支持startPage(Object params)方法,增加了该参数来配置参数映射,用于从对象中根据属性名取值, 可以配置 pageNum,pageSize,count,pageSizeZero,reasonable,不配置映射的用默认值, 默认值为pageNum=pageNum;pageSize=pageSize;count=countSql;reasonable=reasonable;pageSizeZero=pageSizeZero。
  • supportMethodsArguments:支持通过 Mapper 接口参数来传递分页参数,默认值false,分页插件会从查询方法的参数值中,自动根据上面 params 配置的字段中取值,查找到合适的值时就会自动分页。 使用方法可以参考测试代码中的 com.github.pagehelper.test.basic 包下的 ArgumentsMapTest 和 ArgumentsObjTest。
  • autoRuntimeDialect:默认值为 false。设置为 true 时,允许在运行时根据多数据源自动识别对应方言的分页 (不支持自动选择sqlserver2012,只能使用sqlserver),用法和注意事项参考下面的场景五。 closeConn:默认值为 true。当使用运行时动态数据源或没有设置 helperDialect 属性自动获取数据库类型时,会自动获取一个数据库连接, 通过该属性来设置是否关闭获取的这个连接,默认true关闭,设置为 false 后,不会关闭获取的连接,这个参数的设置要根据自己选择的数据源来决定。

pageInfo的使用

在返回分页的list后面创建一个pageInfo我们来看一下PageInfo返回了哪些参数

@RestController
public class StudentController {
    @Autowired
    private StudentService studentService;

    @RequestMapping("/queryStudentList")
    public PageInfo<Student> queryStudentList(int pageNum, int pageSize){
        //pageNum页码,pageSize条数
        PageHelper.startPage(pageNum,pageSize);
        List<Student>list=studentService.queryList();
        PageInfo<Student> pageInfo=new PageInfo<Student>(list);
        return pageInfo;
    }
}

查看返回参数

image.png

  • endRow:当前页面最后一个元素在数据库中的行号
  • firstPage:第一页
  • hasNextPage:是否有下一页
  • hasPreviousPage:是否有前一页
  • isFirstPage:是否为第一页
  • isLastPage:是否为最后一页
  • lastPage:最后一页
  • list:结果集
  • navigatepageNums:所有导航号
  • nextPage:下一页
  • pageNum:当前页
  • pageSize:每页数量
  • pages:总页数
  • prePage:前一页
  • size:当前页数量
  • startRow:当前页面第一个元素在数据库中的行号
  • total:数据总数量

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏芋道源码1024

注册中心 Eureka源码解析 —— 应用实例注册发现 (九)之岁月是把萌萌的读写锁

本文主要分享 Eureka 注册中心的那把读写锁,让我瘙痒难耐,却不得其解。在某次意外的抠脚的一刻( 笔者不抽烟,如果抽烟的话,此处应该就不是抠脚了 ),突然顿...

10400
来自专栏码农阿宇

国内开源社区巨作AspectCore-Framework入门

在软件业,AOP为Aspect Oriented Programming的缩写,意为:面向切面编程,通过预编译方式和运行期动态代理实现程序功能的统一维护的一种技...

28810
来自专栏有趣的django

26.Django模板语言和分页

继承 extends  子版只能继承一个父模板 1.父模板 master.html <!DOCTYPE html> <html lang="en"> <head...

30440
来自专栏python爬虫实战之路

selenium+requests进行cookies保存读取操作

selenium操作很简单,这里不做详解讲解,以后我们开爬虫基础系列文章的时候会讲到。

36750
来自专栏祝威廉

Kafka Zero-Copy 使用分析

Kafka 我个人感觉是性能优化的典范。而且使用Scala开发,代码写的也很漂亮的。重点我觉得有四个

22220
来自专栏我和PYTHON有个约会

Django来敲门~第一部分【5.1.项目配置settings.py详解】

我们创建好了一个Python项目(mysite/)之后,需要在项目中添加模块应用(polls/),在模块应用中添加处理功能逻辑,如添加模块中的视图处理函数(po...

11330
来自专栏互联网杂技

SpringBoot ( 十一 ) :SpringBoot 中 mongodb 的使用

mongodb是最早热门非关系数据库的之一,使用也比较普遍,一般会用做离线数据分析来使用,放到内网的居多。由于很多公司使用了云服务,服务器默认都开放了外网地址,...

12320
来自专栏猿天地

nginx转发后后端怎么获取用户真实IP

经常有需求要获取访问用户的IP,在经过nginx转发后真实IP就被隐藏起来了,我们需要在头部信息里拿真实IP,下面是拿IP的代码,考虑了各种情况。 public...

47470
来自专栏chenssy

【死磕Java并发】—–J.U.C之读写锁:ReentrantReadWriteLock

重入锁ReentrantLock是排他锁,排他锁在同一时刻仅有一个线程可以进行访问,但是在大多数场景下,大部分时间都是提供读服务,而写服务占有的时间较少。然而读...

33270
来自专栏Felix的技术分享

《一个操作系统的实现》笔记(5)--内核雏形

20840

扫码关注云+社区

领取腾讯云代金券